Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Cards

Update Card

Integrators can update the card resource to change status, update shipping (if the card hasn't been shipped) or edit metadata.

patch/cards/{card_id}

Path parameters

card_idstring uuid required

The unique identifier of a card

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

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

card_status'ACTIVE' | 'SUSPENDED' | 'TERMINATED'

The status indicating the card lifecycle state

customer_idstring uuid

The ID of the customer to whom the card will be issued

memostring

Additional details about the reason for the status change

metadataCardMetadata

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

reason'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'

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

Example request

{
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "emboss_name": {
    "line_1": "Jane Smith",
    "line_2": "Acme Inc."
  }
}

Response

Card issued

OR

Example response

{
  "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",
  "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",
  "tenant": "abcdef_ghijkl"
}