Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

Body

application/json
capCents
integer
required

Lifetime spend limit in cents: the most the card can ever be charged, in total. Rounded up to the next whole dollar; must be at least 100 and, after rounding, at most your app's per-card maximum. Size it to the order total plus tax and shipping — a charge that would take total spend above the cap is declined.

Required range: x <= 9007199254740991
Example:

5000

fundingCardToken
string

Required. The buyer's tokenized card, collected with the Card Element, that pays for this one. It's charged the card's cap (rounded up to whole dollars) before the card is created; whatever the card doesn't spend is refunded to it when the card settles. Charged off-session, so your buyer must have agreed to future charges when they entered the card.

Example:

"card_live_SimDpKU9cmU7tvdUXHzOeLudtgfadQVnbof"

merchantHost
string

Merchant the card is for, e.g. zara.com. Puts the merchant on the buyer's statement (HENRY* ZARA). The card itself locks to whichever merchant charges it first.

Example:

"zara.com"

ttlDays
integer

Days until the card expires and stops working. Defaults to your app's configured TTL. The card settles (refunding the buyer whatever it didn't spend) when it expires, or sooner if you close it.

Required range: x <= 90
Example:

7

Response

Card issued

success
boolean
required
status
string
required
message
string
required
data
object
required