Receiving Linked Cards
To obtain a list of linked cards, send a POST request to the API. The response will be paginated, returning up to 100 cards per page.
Endpoint
POST /api/v1/payment/GetLinkedCardsRequest Body
| Field Name | Type | Description |
|---|---|---|
AccountId | Integer | Agent ID |
State | Integer | Mode |
Status | Integer | Status |
Deleted | Integer | Deleted |
Page | Integer | Page number for pagination |
CurrentAccountID | Integer | User ID used for authorization |
Location | JsonObject | Location object |
Country | String | Country |
CountryCode | String | Country code |
DeviceInfo | JsonObject | Device object |
GMT | Integer | Time zone |
AppFramework | String | Framework applications |
Lang | String | Language |
IP | String | IP address |
Example Request
{
"AccountId": 19083,
"Page": 1,
"CurrentAccountID": 19083,
"Location": {
"Latitude": -26.2041,
"Longitude": 28.0473
},
"Country": "South Africa",
"CountryCode": "ZA",
"DeviceInfo": {
"PhoneManufacturer": "Generic",
"PhoneModel": "Windows_RestAPI",
"DeviceID": "",
"DeviceType": "1",
"AppFramework": "java",
"OS": "Windows",
"OSVersion": "10",
"AppID": "RestAPI",
"BuildNumber": "2.4.390248"
},
"GMT": 2,
"AppFramework": "java",
"Lang": "en"
}Response Body
| Field Name | Type | Description |
|---|---|---|
ID | Integer | ID card |
LinkType | Integer | Always 1 |
State | Integer | Card status (1 - active, 2 - blocked/deleted) |
Status | Integer | Binding status (1 - Created, 2 - In verification, 3 - Verified, 10 - Error) |
AccountID | Integer | ID of the agent who linked the card |
Alias | String | Description of the card |
CardholderName | String | Cardholder name |
LinkID | String | Binding ID |
PANEnding | String | Last 4 digits of card number |
PANMasked | String | Last 5 symbols of card mask |
PaymentType | String | Payment system name |
CardExp | String | Card expiration date |
Created | String | Created timestamp |
Updated | String | Updated timestamp |
Deleted | Boolean | Deleted status |
CanDelete | Boolean | Can be deleted |
TransactionCount | Integer | Number of transactions |
ErrorCode | Integer | Execution result code |
ErrorMessage | String | Execution result message |
Validations | Array | Validation results |
Example Response
{
"LinkedCards": [
{
"ID": 7856,
"LinkType": 1,
"State": 1,
"Status": 3,
"AccountID": 19083,
"Alias": "visa *4207",
"CardholderName": null,
"LinkID": "95deef98-ea73-421d-890d-77511b12186e",
"PANEnding": "4207",
"PANMasked": "*4207",
"PaymentType": "visa",
"CardExp": "2028-06-30T23:59:59",
"Created": "2024-09-22T18:46:48.687",
"Updated": "2024-09-22T15:46:48.687",
"Deleted": false,
"CanDelete": false,
"TransactionCount": 0,
"StorageID": 1
},
{
"ID": 7855,
"LinkType": 1,
"State": 1,
"Status": 3,
"AccountID": 19083,
"Alias": "mastercard *5100",
"CardholderName": null,
"LinkID": "b5b78219-d94f-4b08-ba29-33cd51c6b857",
"PANEnding": "5100",
"PANMasked": "*5100",
"PaymentType": "mastercard",
"CardExp": "2026-03-31T23:59:59",
"Created": "2024-09-22T18:45:29.95",
"Updated": "2024-09-22T15:46:09.243",
"Deleted": false,
"CanDelete": false,
"TransactionCount": 0,
"StorageID": 1
}
],
"ErrorCode": 0,
"ErrorMessage": null,
"Validations": null
}