Skip to main content
POST
/
external_cards
Create External Card
curl --request POST \
  --url https://api.synctera.com/v1/external_cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "billing_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "city": "New York",
    "country_code": "US",
    "postal_code": "49633",
    "state": "NY"
  },
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "cvv": "<string>",
  "expiration_month": "<string>",
  "expiration_year": "<string>",
  "name": "Jean Valjean",
  "pan": "<string>"
}'
{
  "bin": "<string>",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "expiration_month": "06",
  "expiration_year": "25",
  "id": "<string>",
  "issuer": "<string>",
  "last_four": "1234",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "name": "Jean Valjean",
  "payment_account_reference": "<string>",
  "status": "ACTIVE",
  "tenant": "abcdef_ghijkl",
  "verifications": {
    "state": "FAILED",
    "address_verification_result": "ADDRESS_AND_ZIP_MISMATCH",
    "cvv2_result": "CVV_MISMATCH",
    "name_verification_result": "NAME_MISMATCH",
    "pull_details": {
      "country": "US",
      "currency": "USD",
      "network": "<string>",
      "product_type": "CREDIT",
      "regulated": true
    },
    "pull_enabled": true,
    "push_details": {
      "country": "US",
      "currency": "USD",
      "funds_availability": "FEW",
      "network": "<string>",
      "product_type": "CREDIT",
      "regulated": true
    },
    "push_enabled": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Details of the External Card to create

​
customer_id
string<uuid>
required

The unique identifier of a customer

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
expiration_month
string
required
​
expiration_year
string
required
​
name
string
required

The cardholder name

Example:

"Jean Valjean"

​
pan
string
required
​
billing_address
object
​
business_id
string<uuid>

The unique identifier of a business

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
cvv
string

Response

External Card created

​
currency
string
required

ISO 4217 Alpha-3 currency code

Required string length: 3
Example:

"USD"

​
customer_id
string<uuid>
required

The unique identifier of a customer

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
expiration_month
string
required

Card expiration month

Example:

"06"

​
expiration_year
string
required

Card expiration year

Example:

"25"

​
id
string
required

Unique identifier

​
last_four
string
required

The last four digits of the card PAN

Example:

"1234"

​
name
string
required

The cardholder name

Example:

"Jean Valjean"

​
status
enum<string>
required

Status of an External Card

Available options:
ACTIVE,
SUSPENDED
​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
bin
string

Bank Identification Number

​
creation_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
issuer
string

Name of the issuing financial institution

​
last_updated_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
payment_account_reference
string

A unique identifier associated with a specific cardholder PAN and its affiliated tokens

Required string length: 29
​
verifications
object

Verify card passed AVS and CVV checks and if it able to perform PUSH/PULL transfers.