External Cards
List External Cards
Get a paginated list of External Cards
get/external_cards
Query parameters
business_idstring[]
payment_account_referencestring[]
namestring[]
name_likestring
Case sensitive wildcard search for name, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.
from_creation_timestring date-time
status_neq'ACTIVE' | 'DELETED' | 'SUSPENDED'
Status of an External Card
statusExternalCardStatus[]
from_last_updated_timestring date-time
from_deletion_timestring date-time
last_fourstring[]
to_last_updated_timestring date-time
tenantTenantId[]
[ "abcdef_ghijkl" ]
page_tokenstring
Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
Example:a8937a0d
limitinteger
Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
Example:100
to_deletion_timestring date-time
to_creation_timestring date-time
customer_idstring[]
idstring[]
Response
External Card list
Example response
{
"external_cards": [
{
"created_time": "2010-05-06T12:23:34.321Z",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"deletion_time": "2010-05-06T12:23:34.321Z",
"expiration_month": "06",
"expiration_year": "25",
"last_four": "1234",
"last_modified_time": "2010-05-06T12:23:34.321Z",
"name": "Jean Valjean",
"verifications": {
"pull_details": {
"country": "US",
"currency": "USD"
},
"push_details": {
"country": "US",
"currency": "USD"
}
}
}
],
"next_page_token": "a8937a0d"
}