PATCH
/
card
/
{id}
curl --request PATCH \
  --url https://api.treasuryprime.com/card/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "active"
}'
{
  "account_id": "acct_291u96075mva",
  "card_controls": null,
  "card_product_id": "cdpt_w10r2sebv0nl",
  "created_at": "2021-02-19T20:42:40Z",
  "cvv": null,
  "expiration": "0225",
  "fulfillment": {
    "shipping_method": "USPS Mail (5-7 business days)",
    "status": "issued",
    "tracking_number": null
  },
  "id": "card_zuhqnmz7e085",
  "last4": "3385",
  "pan": null,
  "person_id": "psn_5vyzn6sveupa",
  "pin_is_set": false,
  "status": "active",
  "updated_at": "2021-02-19T20:42:41Z",
  "userdata": null
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

Unique identifier for object

Body

application/json
The card to update
card_controls
object

An object that defines rules for how this card can be used

pin
any
status
string

One of: unactivated, active, suspended, terminated

userdata
object

Arbitrary data the user can attach to the object

Response

200 - application/json
The card updated
account_id
string

The ID of the account that the card should be issued against. Filterable.

card_controls
object

An object that defines rules for how this card can be used

card_product_id
string

The ID of the card product that this card should be issued from

creation_options
object

An object that defines additional fields for card customization on creation

cvv
string

The 3-digit card verification code. Note this field will return null unless the show_cvv query parameter is set

expiration
string

The card expiration year and month, in MMYY format

fulfillment
object

Information about the card's fulfillment process

id
string

Unique identifier for object

last4
string

Last 4 digits of the card number. Filterable.

new_pan_from_card_id
string

The ID of a card to reissue. If this field is entered a new card will be created without pin, a new PAN, CVV and expiration

pan
string

The primary 16-digit card number. Note this field will return null unless the show_pan parameter is set

person_id
string

The ID of the person representing the cardholder that this card will be issued to. Filterable.

pin_is_set
boolean

Reflects whether the user has set a PIN on the card; initially false

reissue_pan_from_card_id
string

The ID of a card to reissue. If this field is entered a new card will be created with the same PAN and pin, but new CVV and expiration.

show_cvv
enum<string>

When true, the cvv field will be returned with non-null data. False by default. Requires PCI compliance.

Available options:
true,
false
show_pan
enum<string>

When true, the pan field will be returned with non-null data. False by default. Requires PCI compliance.

Available options:
true,
false
status
string

One of: unactivated, active, suspended, terminated. Filterable.

userdata
object

Optional arbitrary user data