POST
/
api
/
orders

Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

User approved

The user must be approved in at least one country.

Authorizations

x-api-key
string
header
required

Body

application/json
quoteId
string
required

Id of the quote to be associated with this order.

notes
string

Notes to be added to the order.

payoutBankAccountId
string

Required for sell orders. This is the ID of the bank account where the funds will be deposited.

userAddressId
string

Required for buy orders and US sell orders. For buy orders, it is the ID of the address to which we will send the funds. For US sell orders, it is the address from which you will send the funds.

wireMessage
string

Only for sell orders in the US. This is an optional wire message that can be sent with the payout wire transfer.

Response

201 - application/json
amountCrypto
number

Amount of cryptocurrency involved in the order

amountFiat
number

Amount of fiat currency involved in the order

attributes
string[]

List of attributes associated with the order

country
enum<string>

Country of residence of the user who created the order

Available options:
MX,
PE,
US
createdAt
string

Timestamp indicating when the order was created

crypto
enum<string>

Type of cryptocurrency involved in the order

Available options:
USDC,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ
cryptoAddress
string

Cryptocurrency address associated with the order

destinationOfFunds
object

Details about the destination of funds

expiredQuotes
string[]

List of expired quotes

fees
object

Details about the fees

fiat
enum<string>

Type of fiat currency used in the order

Available options:
USD,
MXN,
PEN
id
string

The ID of the order

notes
string

Any additional notes

paymentsReceived
object[]

List of payments received

payoutAddressId
string

The unique identifier of the payout address

payoutsSent
object[]

List of payouts sent

payoutTransferLimit
number

The limit for payout transfer

price
number

The price of the cryptocurrency

quoteId
string

Unique identifier of the associated quote

side
enum<string>

Indicates whether the order is a buy or sell order

Available options:
buy,
sell
status
enum<string>

Current status of the order

Available options:
created,
cancelled,
processing,
sourcingLiquidity,
cryptoAddressAdded,
liquiditySourced,
awaitingBankPayoutDetails,
awaitingBinanceSettlement,
binanceSettlementFailed,
incorrectBinanceSettlement,
depositRegistered,
depositConfirmed,
paymentOriginMismatch,
paid,
filled,
refundInitiated,
addressCheckPassed,
depositAddressCreated,
complete,
failedPayment,
bankPayoutDetailsAdded,
awaitingPayment,
awaitingOriginOrderCompletion,
awaitingTransferReissue,
awaitingPayout,
awaitingAsyncPayout,
awaitingAsyncPayment,
awaitingBridgeRouting,
failedFill,
failedTransfer,
failedQuote,
failedProcessorRouting,
failedLiquidityRouting,
failedFees,
incorrectAmountPaid,
insufficientLiquidityFailed,
depositAddressFailed,
addressCheckFailed,
refundFailed,
refundComplete,
bridgeOrderCreationFailed,
bridgeOrderRoutingFailed,
bridgeTransferFailed,
depositAmountMismatchFailed,
failedUnknown,
expired
userId
string

Unique identifier of the user who created the order

version
number

The version of the order