Skip to main content
GET
/
external_cards
List External Cards
curl --request GET \
  --url https://api.synctera.com/v2/external_cards
{
  "external_cards": [
    {
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "expiration_month": "06",
      "expiration_year": "25",
      "id": "<string>",
      "last_four": "1234",
      "name": "Jean Valjean",
      "status": "ACTIVE",
      "tenant": "abcdef_ghijkl",
      "bin": "<string>",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "deletion_time": "2010-05-06T12:23:34.321Z",
      "issuer": "<string>",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "payment_account_reference": "<string>",
      "verifications": {
        "address_verification_result": "VERIFIED",
        "cvv2_result": "VERIFIED",
        "name_verification_result": "VERIFIED",
        "pull_enabled": true,
        "push_enabled": true,
        "state": "SUCCEEDED",
        "pull_details": {
          "country": "US",
          "currency": "USD",
          "network": "<string>",
          "product_type": "CREDIT",
          "regulated": true
        },
        "push_details": {
          "country": "US",
          "currency": "USD",
          "funds_availability": "NOW",
          "network": "<string>",
          "product_type": "CREDIT",
          "regulated": true
        }
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
business_id
string<uuid>[]
​
customer_id
string<uuid>[]
​
from_creation_time
string<date-time>
​
from_deletion_time
string<date-time>
​
from_last_updated_time
string<date-time>
​
id
string<uuid>[]
​
last_four
string[]
​
name
string[]
​
name_like
string

Case sensitive wildcard search for name, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

​
payment_account_reference
string[]
​
status
enum<string>[]

Status of an External Card

Available options:
ACTIVE,
SUSPENDED,
DELETED
​
status_neq
enum<string>

Status of an External Card

Available options:
ACTIVE,
SUSPENDED,
DELETED
​
tenant
string[]

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

​
to_creation_time
string<date-time>
​
to_deletion_time
string<date-time>
​
to_last_updated_time
string<date-time>

Response

External Card list

​
external_cards
object[]
required

Array of External Cards

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"