Issue a Card

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

Debit Card
Credit Card

A card that can spend against a deposit account

card_details

Physical Card · object

required

A request to issue a physical card

Physical Card
Virtual Card

Show child attributes

card_details.account_id

string<uuid>

required

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

Example:

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

card_details.card_product_id

string<uuid>

required

The card product to which the card is attached

Example:

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

card_details.form

enum<string>

required

PHYSICAL or VIRTUAL.

Available options:

PHYSICAL,

VIRTUAL

card_details.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"

card_details.customer_id

string<uuid>

The ID of the customer to whom the card will be issued. If this is not populated with a valid customer_id 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"

card_details.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 (').

Show child attributes

card_details.emboss_name.line_1

string

required

line 1

Example:

"Jane Smith"

card_details.emboss_name.line_2

string

line 2

Example:

"Acme Inc."

card_details.metadata

object

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

Show child attributes

card_details.metadata.{key}

string

card_details.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

Reason	Same PAN	Terminate Old Card
APPEARANCE	yes	on activation
BANK_MIGRATION	yes	on activation
DAMAGED	yes	on activation
EXPIRATION	yes	on activation
LOST	no	immediately
PRODUCT_CHANGE	yes	on activation
PROGRAM_CHANGE	yes	on activation
STOLEN	no	immediately

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,

BANK_MIGRATION,

DAMAGED,

EXPIRATION,

LOST,

PRODUCT_CHANGE,

PROGRAM_CHANGE,

STOLEN

card_details.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"

card_details.bulk_order_config_id

string<uuid>

The ID of the bulk order config which should be used for shipping this card as part of a bulk order. Refer to Bulk Issuance for details on ordering cards in bulk.

Example:

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

card_details.card_image_id

string<uuid>

The ID of the custom card image used for this card

Example:

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

card_details.shipping

object

Details about the shipping method. If supplied this will override the default shipping address of the customer or account.

Show child attributes

card_details.shipping.address

object

The address to which the card will be shipped - Defaults to account shipping address if none supplied

Show child attributes

card_details.shipping.address.address_line_1

string

required

Street address line 1

Maximum string length: 100

Example:

"100 Main St."

card_details.shipping.address.city

string

required

City

Example:

"New York"

card_details.shipping.address.country_code

string

required

ISO-3166-1 Alpha-2 country code

Example:

"US"

card_details.shipping.address.postal_code

string

required

Postal code

Example:

"49633"

card_details.shipping.address.state

string

required

State, region, province, or prefecture. This is the ISO-3166-2 subdivision code, excluding the country prefix. For example, TX for Texas USA or TAM for Tamaulipas Mexico. Its length varies by country, e.g. 2 characters for US, 3 for MX.

Example:

"NY"

card_details.shipping.address.address_line_2

string

Street address line 2

Maximum string length: 100

Example:

"Suite 99"

card_details.shipping.care_of_line

string

The name of the person to send in care of

card_details.shipping.is_expedited_fulfillment

boolean

deprecated

Is the shipment expedited

card_details.shipping.method

enum<string>

The shipping method.

INTERNATIONAL_GROUND is only available for addresses in Canada and Mexico.

Available options:

INTERNATIONAL,

INTERNATIONAL_GROUND,

INTERNATIONAL_PRIORITY,

LOCAL_MAIL,

LOCAL_PRIORITY,

OVERNIGHT,

TWO_DAY

Example:

"LOCAL_MAIL"

card_details.shipping.phone_number

string

The phone number of the recipient

Example:

"+14374570680"

card_details.shipping.recipient_name

object

The name of the recipient to whom the card will be shipped

Show child attributes

card_details.shipping.recipient_name.first_name

string

required

Maximum string length: 30

Example:

"Jane"

card_details.shipping.recipient_name.last_name

string

required

Maximum string length: 30

Example:

"Smith"

card_details.shipping.recipient_name.middle_name

string

Maximum string length: 30

Example:

"Anne"

Example:

{
  "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "form": "PHYSICAL"
}

type

enum<string>

required

The type of the card program and BIN

Available options:

CREDIT,

DEBIT,

PREPAID

Response

Card issued

Credit Card
Debit Card

A card that can spend against a credit account

card_details

Physical Card · object

required

A card that can spend against a credit account

Physical Card
Virtual Card

Show child attributes

card_details.account_id

string<uuid>

required

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

Example:

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

card_details.card_product_id

string<uuid>

required

The card product to which the card is attached

Example:

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

card_details.creation_time

string<date-time>

required

The timestamp representing when the card issuance request was made

Example:

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

card_details.emboss_name

object

required

Show child attributes

card_details.emboss_name.line_1

string

required

line 1

Example:

"Jane Smith"

card_details.emboss_name.line_2

string

line 2

Example:

"Acme Inc."

card_details.id

string<uuid>

required

Card ID

Example:

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

card_details.form

enum<string>

required

PHYSICAL or VIRTUAL.

Available options:

PHYSICAL,

VIRTUAL

card_details.shipping

object

required

Details about the shipping method. If supplied this will override the default shipping address of the customer or account.

Show child attributes

card_details.shipping.address

object

The address to which the card will be shipped - Defaults to account shipping address if none supplied

Show child attributes

card_details.shipping.address.address_line_1

string

required

Street address line 1

Maximum string length: 100

Example:

"100 Main St."

card_details.shipping.address.city

string

required

City

Example:

"New York"

card_details.shipping.address.country_code

string

required

ISO-3166-1 Alpha-2 country code

Example:

"US"

card_details.shipping.address.postal_code

string

required

Postal code

Example:

"49633"

card_details.shipping.address.state

string

required

Example:

"NY"

card_details.shipping.address.address_line_2

string

Street address line 2

Maximum string length: 100

Example:

"Suite 99"

card_details.shipping.care_of_line

string

The name of the person to send in care of

card_details.shipping.is_expedited_fulfillment

boolean

deprecated

Is the shipment expedited

card_details.shipping.method

enum<string>

The shipping method.

INTERNATIONAL_GROUND is only available for addresses in Canada and Mexico.

Available options:

INTERNATIONAL,

INTERNATIONAL_GROUND,

INTERNATIONAL_PRIORITY,

LOCAL_MAIL,

LOCAL_PRIORITY,

OVERNIGHT,

TWO_DAY

Example:

"LOCAL_MAIL"

card_details.shipping.phone_number

string

The phone number of the recipient

Example:

"+14374570680"

card_details.shipping.recipient_name

object

The name of the recipient to whom the card will be shipped

Show child attributes

card_details.shipping.recipient_name.first_name

string

required

Maximum string length: 30

Example:

"Jane"

card_details.shipping.recipient_name.last_name

string

required

Maximum string length: 30

Example:

"Smith"

card_details.shipping.recipient_name.middle_name

string

Maximum string length: 30

Example:

"Anne"

card_details.card_status

enum<string>

required

The status indicating the card lifecycle state

Available options:

ACTIVE,

PENDING,

REJECTED,

SUSPENDED,

TERMINATED,

UNACTIVATED

card_details.status_reason

enum<string>

required

The reason for the card status

Code	Description
NEW	Card activated
REQ	Requested by you
INA	Dormant
UNK	Invalid shipping address
NEG	Negative account balance
REV	Account under review
SUS	Suspicious activity
OUT	Activity outside program parameters
FRD	Confirmed fraud
MAT	Matched with an OFAC list
LOS	Card reported lost
CLO	Card was cloned
COM	Account or card was compromised
TMP	Awaiting customer confirmation
PRC	Initiated by Processor
ISS	Initiated by Issuer
EXP	Card expired
KYC	Failed KYC
INF	Information was validated
ACT	Account activity was validated
AUX	Initiated by a third party
PIN	PIN try limit reached
STO	Card reported stolen
ADD	Address issue
NAM	Name issue
SSN	SSN issue
DOB	DOB issue
EML	Email issue
PHO	Phone issue
FUL	Account/fulfillment mismatch
OTH	Other

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

card_details.card_fulfillment_status

enum<string>

required

The status indicating the state of the card issuance

Available options:

DIGITALLY_PRESENTED,

ISSUED,

ORDERED,

REISSUED,

REJECTED,

REORDERED,

SHIPPED

card_details.card_brand

enum<string>

required

The brand of a card product

Available options:

MASTERCARD,

VISA

card_details.physical_card_format

enum<string>

required

The format of a physical card product

Available options:

CHIP,

CONTACTLESS,

MAGNETIC_STRIPE,

PHYSICAL_COMBO

card_details.business_id

string<uuid>

Example:

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

card_details.customer_id

string<uuid>

Example:

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

card_details.expiration_month

string

Example:

"06"

card_details.expiration_time

string<date-time>

The timestamp representing when the card would expire at

Example:

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

card_details.expiration_year

string

Example:

"25"

card_details.is_pin_set

boolean

default:false

indicates whether a pin has been set on the card

Example:

true

card_details.last_four

string

The last 4 digits of the card PAN

Example:

"1234"

card_details.last_updated_time

string<date-time>

The timestamp representing when the card was last modified at

Example:

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

card_details.metadata

object

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

Show child attributes

card_details.metadata.{key}

string

card_details.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

Reason	Same PAN	Terminate Old Card
APPEARANCE	yes	on activation
BANK_MIGRATION	yes	on activation
DAMAGED	yes	on activation
EXPIRATION	yes	on activation
LOST	no	immediately
PRODUCT_CHANGE	yes	on activation
PROGRAM_CHANGE	yes	on activation
STOLEN	no	immediately

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,

BANK_MIGRATION,

DAMAGED,

EXPIRATION,

LOST,

PRODUCT_CHANGE,

PROGRAM_CHANGE,

STOLEN

card_details.reissued_from_id

string<uuid>

Example:

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

card_details.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"

card_details.timestamp_pin_set

string<date-time>

Time when the PIN was last set or changed.

Example:

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

card_details.bulk_order_config_id

string<uuid>

The ID of the bulk order config which should be used for shipping this card as part of a bulk order. Refer to Bulk Issuance for details on ordering cards in bulk.

Example:

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

card_details.card_image_id

string<uuid>

The ID of the custom card image used for this card

Example:

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

card_details.memo

string

Additional details about the reason for the status change

Maximum string length: 255

card_details.pending_reasons

object

reasons why the card status is PENDING

Show child attributes

card_details.pending_reasons.is_waiting_for_bulk_shipment

boolean

The card is to be shipping as part of a bulk shipment but that bulk shipment has not yet been released.

card_details.pending_reasons.is_waiting_for_image

boolean

The card has a custom image and either that image hasn't yet been uploaded and approved or the card has not yet been processed by the periodic daily custom card image processing task.

card_details.pending_reasons.is_waiting_for_pin

boolean

The card requires a PIN to be set before it can be issued (refer to the pin_issuance_policy of the related card product). The PIN has not yet been set and not enough time has passed to use a random PIN (if applicable).

card_details.fulfillment_details

object

Show child attributes

card_details.fulfillment_details.bulk_order_id

string<uuid>

The unique identifier of a bulk order in which the card was fulfilled

Example:

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

card_details.fulfillment_details.ship_date

string<date>

The date that the card was shipped as reported by the card fulfillment provider

Example:

"2022-07-19"

card_details.fulfillment_details.shipping_method

string

The specific shipping method as reported by the card fulfillment provider

Example:

"UPS Next Day Air Saver"

card_details.fulfillment_details.tracking_number

string

The shipment tracking number

Example:

"1ZW3268W1319325382"

card_details.bin

string

The bin number

tenant

string

required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

type

enum<string>

required

The type of the card program and BIN

Available options:

CREDIT,

DEBIT,

PREPAID

vendor_data

object

Show child attributes

vendor_data.loan_pro

object

Show child attributes

vendor_data.loan_pro.card_id

integer

vendor_data.loan_pro.secure_payments_card_uuid

string

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Authorizations

Headers

Body

Response