Sign in
latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

paymentCards

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.

get/v2/payment-cards/external/{id}/

Path parameters

idstring uuid required

The external_id of the external payment card.

Headers

Authorizationstring required

Bearer authentication

Response

external_idstring uuid required

Pass this as external_payment_card_id when creating an OCT or AFT.

card_tokenstring required

Network token representing the card.

last_fourstring

Last four digits of the card number. Empty when unavailable.

expiry_monthstring
expiry_yearstring
status'active' | 'canceled' | 'closed' | 'deactivated' | 'expired' | 'frozen' | 'in_default' | 'in_progress' required

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

deactivated_atstring date-time nullable

When the card was deactivated, if applicable.

railstring

Payment rail the card is reachable on.

pushEnabledboolean required

Whether the card accepts OCT (push) transactions.

pullEnabledboolean required

Whether the card accepts AFT (pull) transactions.

card_companystring

Card network or issuing brand.