Get a card by ID
GET
/cards/{cardId}Returns full details for a single card by its external cardId, scoped to the company in the companyId header. Includes cardholder, segments, and the spend, purchase, country, merchant-category, top-up, and ATM configuration.
Path parameters
cardIdstringrequiredExample
CAj6am8270po7z56
Header parameters
companyIdstringrequiredID of the company to filter records
x-api-keystringrequiredPlease provide a valid API Key
Response
| Field | Type | Description |
|---|---|---|
id | string | |
cardNickname | string | |
status | string | |
cardholder | object | |
name | string | |
email | string | |
employeeId | string | |
cardType | string | |
maskedCardNumber | string | |
accountExternalId | string | |
accountType | string | ReloadablePool |
cardCurrency | string | |
createdAt | string | |
companyName | string | |
segments | object[] | |
name | string | |
label | string | |
erp_internal_id | string | |
code | string | |
customSegments | object[] | |
label | string | |
name | string | |
erpCode | string | |
erp_internal_id | string | |
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 |
purchaseLimits | object | |
perTransactionLimit | number | |
dailyLimit | number | |
weeklyLimit | number | |
monthlyLimit | number | |
limitCurrency | string | |
countryLimits | object | |
restrictionMode | string | |
allowedCountries | string[] | |
blockedCountries | string[] | |
merchantCategoryLimits | object | |
restrictionMode | string | |
allowedMccCodes | string[] | |
blockedMccCodes | string[] | |
allowedCategories | string[] | |
blockedCategories | string[] | |
topupConfiguration | object | |
topupType | string | |
topupSourceDetails | object | |
autoTopupEnabled | boolean | |
autoTopupThreshold | number | |
autoTopupAmount | number | |
frequency | string | |
autoTopUpConfiguration | object | |
autoTopupEnabled | boolean | |
autoTopupThreshold | number | |
autoTopupAmount | number | |
frequency | string | |
atmConfiguration | object | |
atmWithdrawalAllowed | boolean | |
dailyAtmLimit | number | |
monthlyAtmLimit | number |
2 nested fields
topupConfiguration.topupSourceDetails.sourceId | string | |
topupConfiguration.topupSourceDetails.sourceType | string |
Errors
400Bad Request
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.