curl -X POST "{{base_url}}/card/get-card" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
{
"code": 200,
"message": "Card information.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"title": "Ada Lovelace",
"color": "black",
"name": "ADA LOVELACE",
"brand": "visa",
"currency": "USD",
"balance": "25.00",
"status": "active",
"mask": "424242******4242",
"last4": "4242",
"expiration": "12/28",
"is_non_subscription": true,
"is_contactless_payment": false,
"is_physical": false,
"billing_address": {
"address": "1 Market Street",
"city": "Nairobi",
"state": "Nairobi",
"zip_code": "00100",
"country": "KE"
},
"last_used_on": null,
"created_at": "2026-11-07T08:00:00+00:00",
"updated_at": "2026-11-07T08:05:00+00:00",
"total_card_spend": 0,
"card_number": "4242424242424242",
"security_code": "123"
}
}
Cards
Get card
Fetch one cardholder’s live card, including balance, spend, card number, and security code.
POST
/
card
/
get-card
curl -X POST "{{base_url}}/card/get-card" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
{
"code": 200,
"message": "Card information.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"title": "Ada Lovelace",
"color": "black",
"name": "ADA LOVELACE",
"brand": "visa",
"currency": "USD",
"balance": "25.00",
"status": "active",
"mask": "424242******4242",
"last4": "4242",
"expiration": "12/28",
"is_non_subscription": true,
"is_contactless_payment": false,
"is_physical": false,
"billing_address": {
"address": "1 Market Street",
"city": "Nairobi",
"state": "Nairobi",
"zip_code": "00100",
"country": "KE"
},
"last_used_on": null,
"created_at": "2026-11-07T08:00:00+00:00",
"updated_at": "2026-11-07T08:05:00+00:00",
"total_card_spend": 0,
"card_number": "4242424242424242",
"security_code": "123"
}
}
Loads the cardholder’s current card from the issuer and returns it with
card_number, security_code, and total_card_spend.
Closed cards (terminated or terminating) are not returned. Use transactions for history on a closed card.
string
required
Cardholder id returned by create card user.
number
Total spend reported for the card.
Errors
| Message | When |
|---|---|
Card user not found. | user_id is missing for this partner |
Card not found. | The cardholder has no open card |
Partner not found. | The API key does not match a partner |
An unexpected error occurred. Please try again. | The issuer could not return the card |
curl -X POST "{{base_url}}/card/get-card" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
{
"code": 200,
"message": "Card information.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"title": "Ada Lovelace",
"color": "black",
"name": "ADA LOVELACE",
"brand": "visa",
"currency": "USD",
"balance": "25.00",
"status": "active",
"mask": "424242******4242",
"last4": "4242",
"expiration": "12/28",
"is_non_subscription": true,
"is_contactless_payment": false,
"is_physical": false,
"billing_address": {
"address": "1 Market Street",
"city": "Nairobi",
"state": "Nairobi",
"zip_code": "00100",
"country": "KE"
},
"last_used_on": null,
"created_at": "2026-11-07T08:00:00+00:00",
"updated_at": "2026-11-07T08:05:00+00:00",
"total_card_spend": 0,
"card_number": "4242424242424242",
"security_code": "123"
}
}