PATCH
/
card
/
{cardId}

Authorizations

X-API-Key
string
headerrequired

Authentication from public API requests

Path Parameters

cardId
string
required

Body

application/json
name
string
status
enum<string>
Available options:
active,
paused,
inactive,
closed
cardGroupId
string | null

Explicitly set this value to null to remove the card from a group. Omitting this field entirely will not affect the group the card belongs to.

spendingConstraint
object

Explicitly set this value to null to remove all card level spending constraints.

avsAddress
object

Explicitly set this value to null to remove the attached avs address.

userData
object | null

Arbitrary information that can be attached to the card. This should be a JSON object and cannot exceed 4kb.

Response

200 - application/json
id
string
required
accountId
string
required

The account that this card is associated with

last4
string
required

The last 4 digits of the card number

name
string
required

The name assigned to the card that appears on the user dashboard

expiryMonth
string
required

The month the card expires formatted as MM (01, 02, ..., 12)

expiryYear
string
required

The year the card expires formatted as YYYY (2024, 2025, ...)

status
enum<string>
required

The status of the card

Available options:
active,
paused,
inactive,
closed
isPhysical
boolean
required

When true, a physical card has been issued. Otherwise, this is a virtual card.

isSingleUse
boolean

When true, the card will be automatically closed after a single authorization attempt. Note that the card will be closed even if the authorization declines or drops

pan
string

This field contains the full PAN which will only be sent on a request for a single card when you set the query param "include_pan" to "true"

cvv
string

This field will contain full CVV which will only be sent on a request for a single card when you set the query param "include_pan" to "true"

cardGroupId
string

The card group the card belongs to.

createdAt
string
spendingConstraint
object

The spending constraint applied to the card

avsAddress
object

The avs address locked applied to this card

userData
object

Arbitrary information that can be attached to the card. See the PATCH /card/{cardId} endpoint for more details on how to add user data.

Create cardList card groups