List cards
GET
/cardsReturns a paginated list of cards for the company in the companyId header. Supports filtering by status, card type (virtual/physical), account type (reloadable/pool), last four digits, cardholder user id, pool account id, and creation/issuance time ranges.
Query parameters
pagenumberExample
1pageSizenumberExample
20statusstringinactiveactivesuspendedterminateddraftcancelledcardTypestringvirtualphysicalaccountTypestringreloadablepoollast4stringcreatedTimeTostringcreatedTimeFromstringissuedTimeTostringissuedTimeFromstringuserIdstringpoolAccountIdstring
Header parameters
companyIdstringrequiredID of the company to filter records
x-api-keystringrequiredPlease provide a valid API Key
Response
| Field | Type | Description |
|---|---|---|
page | number | |
totalPages | number | |
total | number | |
data | object[] | |
id | string | |
cardNickname | string | |
status | string | |
cardholder | object | |
cardType | string | |
maskedCardNumber | string | |
accountExternalId | string | |
accountType | string | ReloadablePool |
cardCurrency | string | |
createdAt | string | |
companyName | string | |
segments | object[] | |
customSegments | object[] | |
allowedMaxBalance | number | |
floatManagementEnabled | boolean | |
topupType | string | |
cardReplaced | boolean | |
transactionLimitsActive | boolean | |
purchaseLimitsActive | boolean | |
countryLimitsActive | boolean | |
categoryLimitsActive | boolean | |
atmWithdrawalAllowed | boolean | |
lowBalanceNotificationActive | boolean | |
lowBalanceNotificationAmount | number | |
terminatedAt | string | |
activatedAt | string | |
issuedAt | string | Time the card was actually issued in the third party; may differ from createdAt for card requests or unverified cardholders |
11 nested fields
data[].cardholder.name | string | |
data[].cardholder.email | string | |
data[].cardholder.employeeId | string | |
data[].segments[].name | string | |
data[].segments[].label | string | |
data[].segments[].erp_internal_id | string | |
data[].segments[].code | string | |
data[].customSegments[].label | string | |
data[].customSegments[].name | string | |
data[].customSegments[].erpCode | string | |
data[].customSegments[].erp_internal_id | string |
Errors
400Bad Request
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.