List External Payment Cards

List external debit cards. With a Partner API Token this returns every external card registered by consumers on your network; with a Customer Access Token it is scoped to that consumer’s own cards. Use GET /v2/consumers/{consumer_id}/payment-cards/external/ when you already know which consumer you want.

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

List external debit cards. With a Partner API Token this returns every external card registered by consumers on your network; with a Customer Access Token it is scoped to that consumer's own cards. Use `GET /v2/consumers/{consumer_id}/payment-cards/external/` when you already know which consumer you want. 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.

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page. Maximum 50.

Response

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

1	{
2	"count": 123,
3	"results": [
4	{
5	"external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6	"card_token": "9f8b7c6d5e4f3a2b1c0d",
7	"status": "active",
8	"pushEnabled": true,
9	"pullEnabled": true,
10	"last_four": "4242",
11	"expiry_month": "11",
12	"expiry_year": "2029",
13	"deactivated_at": "2024-01-15T09:30:00Z",
14	"rail": "visa_direct",
15	"card_company": "Visa"
16	}
17	],
18	"next": "http://api.example.org/accounts/?page=4",
19	"previous": "http://api.example.org/accounts/?page=2"
20	}

$	curl /v2/payment-cards/external/ \
>	-H "Authorization: Bearer <token>"