Skip to main content
PATCH
/
cards
/
{card_id}
Update Card
curl --request PATCH \
  --url https://api.synctera.com/v1/cards/{card_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "card_status": "ACTIVE",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "emboss_name": {
    "line_1": "Jane Smith",
    "line_2": "Acme Inc."
  },
  "memo": "<string>",
  "metadata": {},
  "reason": "ACT"
}'
{
  "card_details": {
    "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_updated_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",
    "form": "PHYSICAL",
    "bulk_order_config_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "card_image_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "shipping": {
      "address": {
        "address_line_1": "<any>",
        "address_line_2": "<any>",
        "city": "<any>",
        "country_code": "<any>",
        "postal_code": "<any>",
        "state": "<any>"
      },
      "care_of_line": "<string>",
      "is_expedited_fulfillment": true,
      "method": "LOCAL_MAIL",
      "phone_number": "+14374570680",
      "recipient_name": {
        "first_name": "<any>",
        "last_name": "<any>",
        "middle_name": "<any>"
      }
    },
    "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",
    "card_fulfillment_status": "DIGITALLY_PRESENTED",
    "fulfillment_details": {
      "bulk_order_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "ship_date": "2022-07-19",
      "shipping_method": "UPS Next Day Air Saver",
      "tracking_number": "1ZW3268W1319325382"
    },
    "bin": "<string>",
    "card_brand": "MASTERCARD",
    "physical_card_format": "CHIP"
  },
  "tenant": "abcdef_ghijkl",
  "type": "CREDIT",
  "vendor_data": {
    "loan_pro": {
      "card_id": 123,
      "secure_payments_card_uuid": "<string>"
    }
  }
}

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"

Path Parameters

​
card_id
string<uuid>
required

The unique identifier of a card

Example:

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

Body

application/json

Card edits

​
card_status
enum<string>

The status indicating the card lifecycle state

Available options:
ACTIVE,
SUSPENDED,
TERMINATED
​
customer_id
string<uuid>

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

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

​
memo
string

Additional details about the reason for the status change

Maximum length: 255
​
metadata
object

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

​
reason
enum<string>

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

Response

Card issued

  • Credit Card
  • Debit Card

A card that can spend against a credit account

​
card_details
object
required

A card that can spend against a credit account Details pertaining to issuing a new physical card The status of the card

  • Physical Card
  • Virtual Card
​
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