Skip to main content
PATCH
Update debit card
This feature is in Beta and not ready for production integration.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Path Parameters

id
string<uuid>
required

Body

Request model for updating a debit card's caller-editable display fields. Fields absent from the payload are left unchanged (partial update).

description
null | string

The new description for the debit card. Omit to leave unchanged; set to null to clear.

nickname
string

The new nickname for the debit card. Omit to leave unchanged; clearing to null is not supported.

Response

OK

id
string<uuid>
required
bankAccountId
string<uuid>
required
capabilities
object
required

Which operations the card's provider supports. A true value does not mean the card's current status allows the operation: a closed card still reports lock when its provider supports locking.

cardBrand
enum<string>
required

The card network (brand) an issued card runs on, such as Visa or Mastercard.

Available options:
UNKNOWN,
VISA,
MASTERCARD,
DISCOVER,
AMERICAN_EXPRESS
cardStatus
enum<string>
required
Available options:
PENDING_ACTIVATION,
ACTIVE,
LOCKED,
CLOSED
cardType
enum<string>
required
Available options:
DIGITAL,
PHYSICAL
cardholderName
string
required
createdAt
string<date-time>
required
expirationDate
string
required
lastFourDigits
string
required
reference
string
required
updatedAt
string<date-time>
required
userId
string<uuid>
required
description
null | string
nickname
null | string
statusReason
null | enum<string>

Why the card is LOCKED or CLOSED, when a reason was given. Null otherwise.

Available options:
LOST,
STOLEN,
FRAUD,
CARDHOLDER_EXIT,
REPLACED,
EXPIRED