latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

consumers

List Consumer External Payment Cards

List the external debit cards a consumer has registered through the card-registration component. Call this after the component reports success to confirm the card was saved and to read the external_id that the OCT and AFT endpoints require. Check pushEnabled before creating an OCT and pullEnabled before creating an AFT — a card may support one direction and not the other.

A card is saved once the card processor confirms the registration, so an empty result immediately after the component closes means the confirmation has not landed yet rather than that registration failed. Poll briefly before treating it as a failure.

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

get/v2/consumers/{consumer_id}/payment-cards/external/

Path parameters

consumer_idstring uuid required

The consumer's external ID.

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page. Maximum 50.

Headers

Authorizationstring required

Bearer authentication

Response

countinteger required
nextstring uri nullable
previousstring uri nullable