GET
/
api
/
orders

Requirements to consume the endpoint.

User approved

The user must be approved in at least one country.

Authorizations

x-api-key
string
headerrequired

Query Parameters

userId
string

User id by which you want to filter.

brokerId
string

Broker id by which you want to filter.

quoteId
string

Quote id by which you want to filter.

startDate
string

Start date by which you want to filter.

endDate
string

End date by which you want to filter.

fiat
enum<string>

Fiat by which you want to filter.

Available options:
USD,
MXN,
PEN
crypto
enum<string>

Crypto by which you want to filter.

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

Side by which you want to filter.

Available options:
buy,
sell
status
enum<string>

Status by which you want to filter.

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

Country by which you want to filter.

Available options:
MX,
PE,
US
page
integer

Used to specify the current page you want to get in the paging results.

limit
integer

Used to specify the maximum number of records to be returned on a single page.

Response

200 - application/json
fees
object

Object containing detailed information about various 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

quoteId
string

The ID of the quote

userId
string

The ID of the user

status
enum<string>

The 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

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

Available options:
buy,
sell
fiat
enum<string>

The type of fiat currency used

Available options:
USD,
MXN,
PEN
createdAt
string

The date and time the order was created

country
enum<string>

The country of the user

Available options:
MX,
PE,
US
amountFiat
number

The total amount in fiat currency involved in the transaction

amountCrypto
number

The total amount of cryptocurrency involved in the transaction

price
number

The price of the cryptocurrency

netPrice
number

The net price of the cryptocurrency

notes
string

Additional information or comments related to the order

payoutBankAccountId
string

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

expiredQuotes
string[]

Array of identifiers for quotes that have expired

USBankTransferMethod
enum<string>

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

Available options:
ach_push,
wire
cryptoAddress
string

The blockchain address for the cryptocurrency transaction

depositAddress
string

The blockchain address where the cryptocurrency was deposited

amountFiatReceived
number

The total amount of fiat currency received from the transaction

withdrawalTxId
string

The unique identifier for the withdrawal transaction on the blockchain

withdrawalTxIds
string[]

List of unique identifiers of withdrawal transactions on the blockchain.

id
string

The unique identifier for the order