POST api/v100/tokens
Register a new card token for a specific user.
Request Information
URI Parameters
None.
Headers
| Name | Description | Type | Additional information |
|---|---|---|---|
| appkey |
Ej. abcdefghijk |
None. |
|
| session |
Ej. 1234567890 |
None. |
Body Parameters
RqToken| Name | Description | Type | Additional information |
|---|---|---|---|
| data |
Encrypted card information using encryption key and later encoded using base64. Decrypted data will be a JSON as described below. |
string |
Required |
| cardTypeCode |
Type of card selected, used to identify Vault. |
string |
Required |
| algorithm |
|
integer |
None. |
| key |
|
string |
None. |
| length |
|
integer |
None. |
Request Formats
application/json, text/json
{
"data": "sample string 1",
"cardTypeCode": "sample string 2",
"algorithm": 1,
"key": "sample string 3",
"length": 1
}
application/x-www-form-urlencoded
Response Information
Resource Description
RsTokens| Name | Description | Type | Additional information |
|---|---|---|---|
| cardAlias |
Card alias displayed in the mobile application. |
string |
Required String length: inclusive between 0 and 25 |
| token |
Card Token. |
string |
Required String length: inclusive between 0 and 50 |
| fkCurrency |
Foreign Key. Currency Identifier. |
integer |
Required |
| cardPANPrint |
Printable Card PAN data, with masked characters for privacy. |
string |
Required String length: inclusive between 0 and 50 |
| cardType |
cardType represented by the token. |
string |
Required String length: inclusive between 0 and 50 |
| cardTypeID |
cardTypeID represented by the token. |
integer |
Required |
| cardBalance |
Optional balance amount for the token. |
string |
None. |
| ListBalance |
Optional list of balance amount for the product on this token. |
Collection of Balance |
None. |
| currencyISOCode |
Currency ISOCode |
string |
Required |
| currencySymbol |
Currency Symbol |
string |
Required |
| status |
Card Status. |
integer |
Required |
| cardTypeIconURL |
URL to the card icon to be displayed by the application |
string |
Required String length: inclusive between 0 and 50 |
| result |
Includes Result Code Information. See Return Codes Section below.
RsResultUsed |
Result |
Required |
Response Formats
application/json, text/json
{
"cardAlias": "sample string 1",
"token": "sample string 2",
"fkCurrency": 3,
"cardPANPrint": "sample string 4",
"cardType": "sample string 5",
"cardTypeID": 6,
"cardBalance": "sample string 7",
"ListBalance": [
{
"Product": "sample string 1",
"currencySymbol": "sample string 2",
"Amount": 1.0
},
{
"Product": "sample string 1",
"currencySymbol": "sample string 2",
"Amount": 1.0
}
],
"currencyISOCode": "sample string 8",
"currencySymbol": "sample string 9",
"status": 10,
"cardTypeIconURL": "sample string 11",
"result": null
}