Skip to main content
POST
Simulate a payment

Authorizations

Authorization
string
header
required

Your API key (cb_live_…), sent as a bearer token, with the scope nft:orders. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a 403 with Access denied, whether or not it has a valid key. See Authentication and keys.

Scopes

nft:orders

Path Parameters

intentId
string
required

The payment.intent_id from the create response. Sandbox intent ids start sbx_pi_.

Body

application/json
amount
number

Dollars paid. Default: the full amount. Send less to test the 1% tolerance and an underpaid refund.

Response

Paid.

paid
boolean
required
kind
enum<string>
required
Available options:
order,
shipment
status
string
required

The order's status (the multi-pack order's, for one), or the shipment's, after the payment.

webhooks
object
required

The webhook deliveries this call made.

order_status
string

Same as status, on an order.

shipment_status
string

Same as status, on a shipment.