Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Update a card

Update a card's details

Updates the details of a given card.

put/cards/{cardId}

Path parameters

cardIdstring uuid required

The ID of the card to work with.

Example:e9293471-5eb3-4dbc-916c-dbaf9e2deefd

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
personIdstring uuid

The ID of the person to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a04

Request body

OR
OR
OR
OR
OR

Example request

{
  "cardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
  "budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a04",
  "budgetCardPhoneNumber": "+447911001762",
  "name": "Team Party",
  "state": "ACTIVE"
}

Response

OK

idstring uuid

The ID of the card to work with.

personIdstring uuid nullable

The ID of the person to work with.

accountIdstring

The ID of the account to work with.

careOfLinestring nullable

Adds the specified value as a C/O (care of) line to the mailing carrier.

cardProductNamestring

The card product name.

lastFourstring

The last four digits of the card Primary Account Number (PAN).

expirationstring

The expiration month and year of the card.

expirationTimestring

The expiration time of the card.

pinIsSetboolean

Whether or not the card PIN is set.

state'ACTIVE' | 'REPLACED' | 'TERMINATED' | 'SUSPENDED' | 'UNACTIVATED'

The current state of the card.

stateReasonstring

The reason for current card state.

fulfillmentStatus'ISSUED' | 'ORDERED' | 'REORDERED' | 'REJECTED' | 'SHIPPED' | 'DIGITALLY_PRESENTED'

The fulfillment status of the card.

cardType'VIRTUAL_PAN' | 'PHYSICAL_MSR' | 'PHYSICAL_COMBO'

The type of card.

cardOwnerType'PEOPLE' | 'BUDGET'

The card owner type of the card.

namestring

The name of the card.

budgetCardPhoneNumberstring nullable

The telephone number of the shared card (including area code), prepended by the

Example response

{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
  "accountId": "F50091",
  "lastFour": "0056",
  "expiration": "0111",
  "expirationTime": "2025-01-31T23:59:59Z",
  "state": "ACTIVE",
  "stateReason": "New card",
  "fulfillmentStatus": "ISSUED",
  "fulfillment": {
    "shippingMethod": "COURIER"
  },
  "cardType": "PHYSICAL_MSR",
  "recipientAddress": {
    "firstName": "Jane",
    "middleName": "Roger",
    "lastName": "Doe",
    "address1": "123 Henry St",
    "address2": "Suite 101",
    "city": "Porterville",
    "state": "CA",
    "postalCode": "93257",
    "country": "US",
    "phone": "831555555"
  },
  "name": "Team Party Card"
}