Endpoint: POST -> {host}/scplite/cards/accounts
Request Headers
Name | Key | Value (Sample) | Type | Length | Purpose (Use cases) |
---|---|---|---|---|---|
Card’s encrypted Auth Data | authData | …SASA22312= | string | – | AuthData Specification |
User Id | userId | user.name | string | – | This is submitted as part of the calls to Postman to identify the user making the call. |
Issuer Number | issuerNr | 2 | number | – | Submitted with the CMS API requests. CMS uses this value to query for the Card Programs value. Card Program are returned in the responses from CMS API for verification within the SCPLite Processor ESB bundle. |
Banck code | BankCode | 999 | number | Card issuer unique id. |
Sample Request
{
"issuerNr":"00233",
"pin":"1234",
"userId":"olasoji.joseph"
}
Request Body Description
Name | Key | Type | Length |
---|---|---|---|
Card Issuer Number | issuerNr | Numeric | 3 |
Car PIN | pin | Numeric | 4 |
User ID | userId | String | – |
Response code
Response Code | Response Message |
---|---|
200 | No content |
400 | bad request. |
500 | Internal error (exception) occurred. |
Sample Response (Success)
{
"issuerNr":"0092212",
"pan":"800822998332323",
"seqNr":"001",
"cardProgram":"VERVE_PREPAID",
"defaultAccountType":"20",
"cardStatus":"1",
"expiryDate":"1706",
"pinOffset":"BA121FBAABFF==",
"cvv":"",
"cvv2":"",
"pinInfo":"",
"track2":"",
"customerId":"",
"userId":"",
"holdRspCode":"",
"pvkiOrPinLength":"",
"pvvOrPinOffset":""
}
Sample Response (Failure)
{
"errors": [
{
"code": 57, //A postilion response code
"message": "PAN not found"
//Interpretation of the postilion code
}
]
}
Request Body Description
Field# | Field name | Type | Description |
---|---|---|---|
Field# | Field name | Type | Description |
1 | code | Numeric | Postilion’s response code |
2 | message | String | Textual representation of the response code |
3 | pvvOrPinOffset | String | PIN Block data |
4 | issuerNr | Numeric | Card issuer identifier number. |
5 | pan | String | The Primary Account Number that identifies this card. |
6 | seqNr | Numeric | The sequence (issue) number of the card. |
7 | cardProgram | String | The program to which this card belongs. |
8 | defaultAccountType | Numeric | Indicates the default account type associated with this card. |
9 | cardStatus | Numeric | A custom field for user-defined card state management. |
10 | expiryDate | String | The card expiry date. |
11 | pinOffset | String | |
12 | cvv | String | |
13 | cvv2 | String | |
14 | pinInfo | String | |
15 | track2 | String | |
16 | customerId | String | An ID that uniquely represents the cardholder across the issuer’s banking systems. |
17 | userId | String | current user Id |
18 | holdRspCode | String | This response code is used when transactions are declined on this card. |
19 | pvkiOrPinLength | Numeric | For the IBM PIN verification method this is the number of digits in the PIN. |