Create card
Required API-key scope: cards:write. A newly created card normally has a spentAmount of 0.00.
Authorizations
Enter your API key
Headers
Replaying the same key returns the original result.
Body
Type of card to create.
"virtual"Nickname for the card.
255\SUser ID of the team member who will hold the card. Use a userId returned by the team-members endpoint.
Funding plan. Defaults to subscription; topUp uses fixed reserved credit supplied in spendCap.
subscription, topUp ID of the card category to assign.
Whether the card draws funds from the revolving budget. Must be false or omitted when planType is topUp.
Requested card expiration date in YYYY-MM-DD format. Time is unsupported.
^(?:(?:\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])))$Fixed credit reserved for a top-up card. Required when planType is topUp.
Spending limits to apply to the card.
Time and transaction-category restrictions to apply.
Optional message stored with the card request.
255Response
Card created. When the card is not yet readable, the body degrades to { id, status: "pending" } — poll the Location header.
- Option 1
- Option 2
Unique card ID.
Card form factor.
virtual, physical Derived card lifecycle status. Pending physical cards await activation; expiring physical cards are within 90 days of expiry.
pending, active, frozen, inactive, expiring, expired, terminated Card nickname.
Last four digits of the card number.
Card expiration date in YYYY-MM-DD format. Time is unsupported.
^(?:(?:\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])))$Whether the card draws funds from the revolving budget.
Funding plan: physical identifies physical-card plans, subscription cards can share the revolving budget, and top-up cards use fixed reserved credit.
physical, subscription, topUp ID of the card category assigned to the card.
Team member assigned to the card.
Fixed credit reserved for the card; used as the funding amount for top-up cards.
Total amount spent on the card.
Card-spending and ATM controls with current period usage.
Time and transaction-category restrictions applied to the card.
Date and time the card was created, in ISO 8601 format.
^(?:(?:\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))$Date and time the card was last updated, in ISO 8601 format.
^(?:(?:\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))$