PATCH
/
api
/
orders
/
{id}

​
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
headerrequired

Path Parameters

id
string
required

Order id to be updated.

Body

application/json
notes
any

Response

200 - application/json
quoteId
string

Unique identifier of the quote.

userId
string

Unique identifier of the user.

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
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
side
enum<string>

Indicates if the order is a buy or sell order.

Available options:
buy,
sell
fiat
enum<string>

Type of fiat currency involved in the order.

Available options:
USD,
MXN,
PEN
createdAt
string

Timestamp indicating when the order was created.

cryptoAddress
string

Address associated with the cryptocurrency in the order.

country
enum<string>

Country of residence of the user.

Available options:
MX,
PE,
US
amountFiat
number

Amount involved in the order in terms of fiat currency.

amountCrypto
number

Amount involved in the order in terms of cryptocurrency.

amountFiatReceived
number

Amount of fiat currency received from the order.

processor
enum<string>

The processor used

Available options:
interbank,
swift,
spei,
spid,
ksr,
bridge,
bitso
liquidityProvider
enum<string>

The liquidity provider used

Available options:
fireblocks,
bridge
withdrawalTxId
string

The unique identifier for the withdrawal transaction on the blockchain

withdrawalTxIds
string[]

List of unique identifiers of withdrawal transactions on the blockchain.

depositAddress
string

The deposit address

fees
object

Details about the fees

originOfFunds
object

Details on the origin of funds, only available when the order status is complete

destinationOfFunds
object

Details about the destination of funds

price
number

The price of the cryptocurrency

netPrice
number

The net price of the cryptocurrency

conversionRateUSD
number

The conversion rate to USD

conversionRateUSDWithMarkups
number

The conversion rate to USD with markups

notes
string

Any additional notes

payoutBankAccountId
string

The unique identifier of the bank account to which the payout will be sent

discount
number

The discount applied

markup
number

The markup applied

expiredQuotes
string[]

List of expired quotes

USBankTransferMethod
enum<string>

Indicates bank transfer method, applies only to the United States.

Available options:
ach_push,
wire
exchangeRateOrders
object[]

List of exchange rate orders.

id
string

The ID of the order

Get orderGet orders