Reference
Cards
Retrieve a list of cards stored in the PCI DSS Level 1 vault
List
List cards that have been stored on the platform through a Checkout Page or Payment Form.
Path
GET /cards?{query parameters}
Query Parameters
| Field | Required | Description | Example |
|---|---|---|---|
| card_expire_month | N | Filter for card that will expire in x months | 2 |
| card_status_lookups_id | N | Filter for specific card statuses | loo_abc123... |
| customer_id | N | ID of a specific customer to filter for, see customers | cus_abc123... |
Response Body
{
"status": true,
"records": [{
"id": "crd_abc123...",
"created_at": "2024-12-28 22:14:47",
"updated_at": null,
"card_status_lookups_id": "loo_abc123...",
"customers_id": "cus_abc123...",
"card_ending": "9834",
"card_expire": "04/29",
"card_brand": "VISA",
"card_token": "60d678e2465b5b6c4fd5e847ef39c70c4b0c22d1b826f39eb80a107b3b8433ad",
}, ...]
}
Response Parameters
Field | Type | Description | Example |
|---|---|---|---|
| status | Boolean | true - response success, false - response error | true |
| records | Array | Array of card objects | ... |
| records.id | String(32) | Unique ID of this card | crd_abc123... |
| records.created_at | Timestamp(YYYY-MM-DD HH:mm:ss) | When this card was stored | 2024-12-28 22:14:47 |
| records.updated_at | Timestamp(YYYY-MM-DD HH:mm:ss) | When this card entry was last changed | null |
| records.card_status_lookups_id | String(32) | Lookups ID relating to the status of this card | loo_abc123... |
| records.customers_id | String(32) | ID of the customer who owns this card see customers | cus_abc123... |
| records.card_ending | String(4) | Last 4 digits of the card number | 9834 |
| records.card_expire | String(5) | Card expiry date in MM/YY format | 04/29 |
| records.card_brand | String | Card brand/type | VISA |
| records.card_token | String | Card token used for payments | 60d678e2465b5b6c4fd5e847ef39c70c4b0c22d1b826f39eb80a107b3b8433ad |
Bank Accounts
Manage customer bank account details including account numbers, branch codes, account types, and bank verification. Required for EFT Debit Orders, DebiCheck, and Registered Mandate payment processing.
Mandates
Create and manage payment mandates for recurring transactions including DebiCheck and Registered Mandates. Handle mandate creation, authentication, status updates, and cancellation with full SARB compliance.