Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
External Cards

Create External Card from token

Create an External Card from token. The token and cardholder name are obtained through the iFrame. The token must be used within 5 minutes or else it will expire. If a Business ID is provided, address verification will be performed against the legal address of the business. Otherwise, the legal address of the Customer will be used. In either case, the name of the Customer will be used to match against the cardholder name.

Each unique External Card is limited to a single Customer, so once an External Card is created for a Customer, it cannot be used for any other Customers, even if the card is deleted. Given there is a limited number of test cards, to allow easier testing, this restriction is relaxed in the sandbox environment.

post/external_cards/tokens

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

business_idstring uuid

The unique identifier of a business

customer_idstring uuid required

The unique identifier of a customer

namestring required

The cardholder name

tokenstring required

The token that was returned via tokenization iframe

Example request

{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "name": "Jean Valjean"
}

Response

External Card created

binstring

Bank Identification Number

created_timestring date-time
currencystring required

ISO 4217 Alpha-3 currency code

customer_idstring uuid required

The unique identifier of a customer

deletion_timestring date-time
expiration_monthstring required
expiration_yearstring required
idstring required

External card ID

issuerstring

Name of issuing financial institution

last_fourstring required

The last 4 digits of the card PAN

last_modified_timestring date-time
namestring required

The cardholder name

status'ACTIVE' | 'DELETED' | 'SUSPENDED' required

Status of an External Card

Example response

{
  "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"
    }
  }
}