Skip to main content
PUT
Edit card details

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

cardId
string<uuid>
required

The card's ID, as returned by List cards or Create card.

Body

application/json
title
string
required

The card's new nickname, up to 255 characters. It replaces the current nickname.

Maximum string length: 255
Pattern: \S

Response

id
string
required

The card's unique ID. Use it with Retrieve a card, Freeze card and the other card endpoints.

type
enum<string>
required

Whether this is a virtual or a physical card.

Available options:
virtual,
physical
status
enum<string>
required

Where the card is in its lifecycle: pending (a physical card not yet activated), active (ready to use), frozen (paused, can be unfrozen), inactive (not usable for another reason, such as a restricted or blocked card), expiring (a physical card within 90 days of its expiry date), expired or terminated (permanently closed).

Available options:
pending,
active,
frozen,
inactive,
expiring,
expired,
terminated
title
string | null
required

The card's nickname, set when the card was created or renamed with Edit card details.

last4
string | null
required

The last four digits of the card number. To see the full card details, use Reveal card details.

expiresAt
string<date> | null
required

The date the card expires (YYYY-MM-DD).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
isRevolving
boolean
required

Whether the card draws from your business's shared revolving budget. It's always false for top-up cards.

planType
enum<string> | null
required

How the card is funded: subscription (draws on shared credit within its limits), topUp (has its own fixed budget in spendCap) or physical (a physical card plan).

Available options:
physical,
subscription,
topUp
category
string | null
required

The display name of the card category chosen when the card was created, for example travel. It describes what the card is for and is different from each card transaction's category. To create a card with this category, pass its id from List card categories.

cardholder
object
required

The team member the card belongs to.

spendCap
object | null
required

The fixed budget set aside for the card; for top-up cards, this is how much the card can spend in total. Change it with Update spend control. Null if the card has no fixed budget.

spentAmount
object
required

How much has been spent on the card since it was created. For top-up cards, compare it with spendCap to see how much budget is left.

spendControl
object
required

The card's spending limits, plus how much has been spent in each period so far.

restriction
object
required

Rules on when the card can be used. Change them with Update card usage restriction.

createdAt
string<date-time>
required

When the card was created, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required

When the card's details, limits or status last changed, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$