API ReferencePayment Cards

Get External Payment Card

Retrieve a single external debit card by its external_id. Returns 404 for cards owned by a consumer outside the authenticated partner. Read pushEnabled and pullEnabled to see which payment directions the card supports.

Requires any one of api:read, api:card-management:read, or api:consumer-profile:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

The external_id of the external payment card.

Response

external_idstringformat: "uuid"

Pass this as external_payment_card_id when creating an OCT or AFT.

card_tokenstring
Network token representing the card.
statusenum

Card status. Only active cards can be used for OCT or AFT.

pushEnabledboolean

Whether the card accepts OCT (push) transactions.

pullEnabledboolean

Whether the card accepts AFT (pull) transactions.

last_fourstringOptional
Last four digits of the card number. Empty when unavailable.
expiry_monthstringOptional
expiry_yearstringOptional
deactivated_atstring or nullOptionalformat: "date-time"
When the card was deactivated, if applicable.
railstringOptional
Payment rail the card is reachable on.
card_companystringOptional
Card network or issuing brand.

Errors

404
Not Found Error