POST
/
cards
Issue a Card
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "form": "VIRTUAL",
  "type": "DEBIT"
}'
{
  "card_status": "ACTIVE",
  "memo": "<string>",
  "pending_reasons": {
    "is_waiting_for_bulk_shipment": true,
    "is_waiting_for_image": true,
    "is_waiting_for_pin": true
  },
  "status_reason": "ACT",
  "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "emboss_name": {
    "line_1": "Jane Smith",
    "line_2": "Acme Inc."
  },
  "expiration_month": "06",
  "expiration_time": "2010-05-06T12:23:34.321Z",
  "expiration_year": "25",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "is_pin_set": true,
  "last_four": "1234",
  "last_modified_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "reissue_reason": "APPEARANCE",
  "reissued_from_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "reissued_to_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "timestamp_pin_set": "2010-05-06T12:23:34.321Z",
  "type": "DEBIT",
  "form": "PHYSICAL",
  "bin": "<string>",
  "card_brand": "MASTERCARD",
  "tenant": "abcdef_ghijkl"
}

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

Card to issue

A virtual card

​
account_id
string<uuid>
required

The ID of the account to which the card will be linked

Example:

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

​
card_product_id
string<uuid>
required

The card product to which the card is attached

Example:

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

​
type
enum<string>
required

The type of the card program and BIN

Available options:
DEBIT,
PREPAID
​
form
enum<string>
required

PHYSICAL or VIRTUAL.

Available options:
PHYSICAL,
VIRTUAL
​
business_id
string<uuid>

The business ID associated with this card. If no customer_id is supplied, a card can still be issued to a business, but cannot be activated or used until a customer is assigned via the PATCH /cards/{card_id} endpoint.

Example:

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

​
customer_id
string<uuid>

The ID of the customer to whom the card will be issued. If a business_id is passed, but a customer_id not passed at the time of card creation the card cannot be activated or used for spend until it's assigned to a human customer via the PATCH /cards/{card_id} endpoint. If no business_id is passed, a customer_id is required.

Example:

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

​
emboss_name
object

The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (&), single quote (').

​
metadata
object

Additional data to include in the request structured as key-value pairs

​
reissue_reason
enum<string>

This is the reason the card needs to be reissued, if any. The reason determines several behaviours:

  • whether or not the new card will use the same PAN as the original card
  • the old card will be terminated and if so, when it will be terminated
ReasonSame PANTerminate Old Card
EXPIRATIONyeson activation
LOSTnoimmediately
STOLENnoimmediately
DAMAGEDyeson activation
VIRTUAL_TO_PHYSICAL(*)yeson activation
PRODUCT_CHANGEyeson activation
NAME_CHANGE(**)yeson activation
APPEARANCEyeson activation

(*) VIRTUAL_TO_PHYSICAL is deprecated. Please use PRODUCT_CHANGE whenever reissuing from one card product to another, including from a virtual product to a physical product.

(**) NAME_CHANGE is deprecated. Please use APPEARANCE whenever reissuing in order to change the appearance of a card, such as the printed name or custom image.

For all reasons, the new card will use the same PIN as the original card and digital wallet tokens will reassigned to the new card

Available options:
APPEARANCE,
DAMAGED,
EXPIRATION,
LOST,
NAME_CHANGE,
PRODUCT_CHANGE,
STOLEN,
VIRTUAL_TO_PHYSICAL
​
reissued_from_id
string<uuid>

When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.

Example:

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

Response

Card issued

A virtual card The status of the card

​
card_brand
enum<string>
required

The brand of a card product

Available options:
MASTERCARD,
VISA
​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
card_status
enum<string>
required

The status indicating the card lifecycle state

Available options:
ACTIVE,
IMAGE_PENDING,
IMAGE_REJECTED,
PENDING,
REJECTED,
SUSPENDED,
TERMINATED,
UNACTIVATED
​
status_reason
enum<string>
required

The reason for the card status

CodeDescription
NEWCard activated
REQRequested by you
INADormant
UNKInvalid shipping address
NEGNegative account balance
REVAccount under review
SUSSuspicious activity
OUTActivity outside program parameters
FRDConfirmed fraud
MATMatched with an OFAC list
LOSCard reported lost
CLOCard was cloned
COMAccount or card was compromised
TMPAwaiting customer confirmation
PRCInitiated by Processor
ISSInitiated by Issuer
EXPCard expired
KYCFailed KYC
INFInformation was validated
ACTAccount activity was validated
AUXInitiated by a third party
PINPIN try limit reached
STOCard reported stolen
ADDAddress issue
NAMName issue
SSNSSN issue
DOBDOB issue
EMLEmail issue
PHOPhone issue
FULAccount/fulfillment mismatch
OTHOther
Available options:
ACT,
ADD,
AUX,
CLO,
COM,
DOB,
EML,
EXP,
FRD,
FUL,
INA,
INF,
ISS,
KYC,
LOS,
MAT,
NAM,
NEG,
NEW,
OTH,
OUT,
PHO,
PIN,
PRC,
REQ,
REV,
SSN,
STO,
SUS,
TMP,
UNK
​
account_id
string<uuid>
required

The ID of the account to which the card will be linked

Example:

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

​
card_product_id
string<uuid>
required

The card product to which the card is attached

Example:

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

​
creation_time
string<date-time>
required

The timestamp representing when the card issuance request was made

Example:

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

​
emboss_name
object
required

The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (&), single quote (').

​
expiration_month
string
required
Example:

"06"

​
expiration_year
string
required
Example:

"25"

​
id
string<uuid>
required

Card ID

Example:

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

​
last_four
string
required

The last 4 digits of the card PAN

Example:

"1234"

​
type
enum<string>
required

The type of the card program and BIN

Available options:
DEBIT,
PREPAID
​
form
enum<string>
required

PHYSICAL or VIRTUAL.

Available options:
PHYSICAL,
VIRTUAL
​
bin
string

The bin number

​
memo
string

Additional details about the reason for the status change

Maximum length: 255
​
pending_reasons
object

reasons why the card status is PENDING

​
business_id
string<uuid>

The business ID associated with this card. If no customer_id is supplied, a card can still be issued to a business, but cannot be activated or used until a customer is assigned via the PATCH /cards/{card_id} endpoint.

Example:

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

​
customer_id
string<uuid>

The ID of the customer to whom the card will be issued. If a business_id is passed, but a customer_id not passed at the time of card creation the card cannot be activated or used for spend until it's assigned to a human customer via the PATCH /cards/{card_id} endpoint. If no business_id is passed, a customer_id is required.

Example:

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

​
expiration_time
string<date-time>

The timestamp representing when the card would expire at

Example:

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

​
is_pin_set
boolean
default:false

indicates whether a pin has been set on the card

Example:

true

​
last_modified_time
string<date-time>

The timestamp representing when the card was last modified at

Example:

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

​
metadata
object

Additional data to include in the request structured as key-value pairs

​
reissue_reason
enum<string>

This is the reason the card needs to be reissued, if any. The reason determines several behaviours:

  • whether or not the new card will use the same PAN as the original card
  • the old card will be terminated and if so, when it will be terminated
ReasonSame PANTerminate Old Card
EXPIRATIONyeson activation
LOSTnoimmediately
STOLENnoimmediately
DAMAGEDyeson activation
VIRTUAL_TO_PHYSICAL(*)yeson activation
PRODUCT_CHANGEyeson activation
NAME_CHANGE(**)yeson activation
APPEARANCEyeson activation

(*) VIRTUAL_TO_PHYSICAL is deprecated. Please use PRODUCT_CHANGE whenever reissuing from one card product to another, including from a virtual product to a physical product.

(**) NAME_CHANGE is deprecated. Please use APPEARANCE whenever reissuing in order to change the appearance of a card, such as the printed name or custom image.

For all reasons, the new card will use the same PIN as the original card and digital wallet tokens will reassigned to the new card

Available options:
APPEARANCE,
DAMAGED,
EXPIRATION,
LOST,
NAME_CHANGE,
PRODUCT_CHANGE,
STOLEN,
VIRTUAL_TO_PHYSICAL
​
reissued_from_id
string<uuid>

When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.

Example:

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

​
reissued_to_id
string<uuid>

If this card was reissued, this ID refers to the card that replaced it.

Example:

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

​
timestamp_pin_set
string<date-time>

Time when the PIN was last set or changed.

Example:

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