Skip to main content
POST
Create Order

Authorizations

X-API-KEY
string
header
required

Body

application/json
recipient
Payout method · object
required

Recipient of the fiat payout. For offramp, this is the saved payout method (for example a bank account) that the funds are sent to. Save the payout method beforehand with the Create Payment Method endpoint and pass its identifier here.

payment
Crypto deposit · object
required

Configuration for the on-chain stablecoin deposit that funds the offramp. The buyer sends the stablecoin from payerAddress on the chain given by method, and Crossmint pays out the equivalent fiat to the recipient payout method.

lineItems
object
required

The fiat to receive, identifying the fiat currency and the amount.

Response

Order successfully created.

clientSecret
string

A token exclusively scoped to a particular order, allowing for the reading or updating of that order.

Example:

"_removed_"

order
object