Update a card's details beta

Updates the details of a given card.

SecurityCommonAuth
Request
path Parameters
cardId
required
string <uuid> (cardId) <= 36 characters

The ID of the card to work with.

Example: e9293471-5eb3-4dbc-916c-dbaf9e2deefd
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=C5462
personId
string <uuid> (personId) <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
Request Body schema: application/json
Any of:
cardId
string <uuid> (cardId) <= 36 characters

The ID of the card to work with.

personId
string <uuid> (personId) <= 36 characters

The ID of the user to work with.

budgetCardPhoneNumberPersonId
string <uuid> (personId) <= 36 characters

The ID of the user to work with.

budgetCardPhoneNumber
string

The phone number associated with the card.

name
required
string

The name of the card. Any diacritics will be converted to the nearest English letter equivalent. Note that any name that is longer than 21 characters will be truncated.

state
string (state)

The current state of the card.

Enum: "ACTIVE" "REPLACED" "TERMINATED" "SUSPENDED" "UNACTIVATED"
fulfillmentStatus
string (fulfillmentStatus)

The fulfillment status of the card.

Enum: "ISSUED" "ORDERED" "REORDERED" "REJECTED" "SHIPPED" "DIGITALLY_PRESENTED"
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

put/cards/{cardId}
Request samples
application/json
{
  • "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",
  • "fulfillmentStatus": "ISSUED"
}
Response samples
application/json
{
  • "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  • "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  • "accountId": "C5462",
  • "careOfLine": "string",
  • "cardProductName": "string",
  • "lastFour": "0056",
  • "expiration": "0111",
  • "expirationTime": "2025-01-31T23:59:59Z",
  • "pinIsSet": true,
  • "state": "ACTIVE",
  • "stateReason": "New card",
  • "fulfillmentStatus": "ISSUED",
  • "cardType": "PHYSICAL_MSR",
  • "recipientAddress": {
    },
  • "cardOwnerType": "PEOPLE",
  • "name": "Team Party Card",
  • "budgetCardPhoneNumber": "+447911001762",
  • "meta": [
    ],
  • "budgets": [
    ],
  • "budget": {
    },
  • "spendingLimit": {
    },
  • "transactionLimit": {
    },
  • "budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a08",
  • "previousCards": [
    ],
  • "currencies": [
    ],
  • "physicalCardState": "ACTIVE",
  • "physicalCardId": "884496ae-2624-40af-a9dc-9756110a4a18",
  • "forceChangePin": false,
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "cardGroupId": "ef3dcbc9-9ad4-44c0-8d75-217d31da37b8",
  • "cardProductId": "06776ac8-abe1-475b-92ee-72405c7b0e60",
  • "cardProductToken": "2f224848-4191-4180-a090-3926042e4b39",
  • "userTokenId": "187f5207-de0b-4f4e-9b90-d50d6a251c6b",
  • "cardPersonalization": {
    }
}