List all credit cards registered on this platform
You may have one or multiple credit cards registered on your platform. Use the following endpoint to list all credit cards that are registered on your platform:
Endpoint | Description |
---|---|
GET {URI}/creditCards | List all credit cards registered on this Platform. |
The following parameters ( π§ coming soon) are used with this endpoint. Use paginate
below for better payload management:
Query Params | Data type | Description |
---|---|---|
paginate | boolean | Whether to paginate the results or not. -true: paginate the results. -false: not to paginate the results. False is the default. |
prevCursor | string | The cursor to use for the previous page of results. This will be ignored if paginate is false. |
nextCursor | string | The cursor to use for the next page of results. This will be ignored if paginate is false. |
maxResults | int32 | The maximum number of results to return. The default is 10, and the maximum is 200. This will be ignored if paginate is false. |
showInactive | string | Show inactive cards (true or false). |
accountNumber | string | Specify the account number to be queried. |
accountIdentifier | string | Get cards associated with a specific account |
customerIdentifier | string | Specify the customer identifier to be queried. |
token | string | Credit card token to be queried. |
expirationDate | string | Specify the expiration date of the credit card to be queried. |
status | string | Get cards with specific status. When set, this option will override the showInactive parameter. Show the status as active or inactive. |
emailAddress | string | Specify the contact email address to be queried. |
fullName | string | Contact person's full name to be queried. |
label | string | Label for the credit card to be queried. |
lastFourDigits | string | The last four digits of the credit card to be queried. |
The following example shows the response using this endpoint:
[
{
"prevCursor": null,
"nextCursor": null,
"prevPageAvailable": false,
"nextPageAvailable": false,
"maxResults": 10,
{
"customerIdentifier": "string",
"accountIdentifier": "string",
"token": "string",
"label": "string",
"lastFourDigits": "string",
"expirationDate": "string",
"status": "string",
"createdDate": "2024-02-09T04:41:08.735Z",
"activationDate": "2024-02-09T04:41:08.735Z",
"contactInformation": [
{
"fullName": "string",
"emailAddress": "string"
}
],
"accountNumber": "string"
}
]
The possible response codes for this endpoint are:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
Updated 6 days ago