POST
/
api
/
orders
/
{id}
/
cancel

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

Id of the order to be cancelled.

Response

200 - application/json
quoteId
string

The unique identifier assigned to the quote.

userId
string

The unique identifier assigned to the user.

status
enum<string>

The 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>

The type of cryptocurrency used in the order.

Available options:
USDC,
USDC_POLYGON,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ
side
enum<string>

The side of the order, indicating whether it's a buy or sell order.

Available options:
buy,
sell
fiat
enum<string>

The type of fiat currency used in the order.

Available options:
USD,
MXN,
PEN
createdAt
string

The date and time when the order was created.

cryptoAddress
string

The address associated with the cryptocurrency used in the order.

country
enum<string>

The country where the user is located.

Available options:
MX,
PE,
US
amountFiat
number

The total amount of the order in fiat currency.

amountCrypto
number

The total amount of the order in cryptocurrency.

processor
enum<string>

The payment processor used to handle the transaction.

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

Liquidity provider used.

Available options:
fireblocks,
bridge
depositAddress
string

Cryptocurrency deposit address.

fees
object

Details of the applied fees.

price
number

Price of the cryptocurrency.

conversionRateUSD
number

Conversion rate to USD.

conversionRateUSDWithMarkups
number

Conversion rate to USD with markups.

notes
string

Additional notes about the order.

discount
number

Discount applied to the order.

markup
number

Markup applied to the order.

expiredQuotes
string[]

List of expired quotes.

autoFXDisabled
boolean

Indicates if the automatic currency conversion is disabled.

exchangeRateOrders
object[]

List of exchange rate orders.

id
string

Unique identifier of the order.