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
header
required

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_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
amountCrypto
number

The total amount of cryptocurrency involved in the transaction

amountFiat
number

The total amount in fiat currency involved in the transaction

amountFiatReceived
number

The total amount of fiat currency received from the transaction

attributes
string[]

List of attributes associated with the order

country
enum<string>

The country of the user

Available options:
MX,
PE,
US
createdAt
string

The date and time the order was created

crypto
enum<string>

The type of cryptocurrency used

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

The blockchain address for the cryptocurrency transaction

depositAddress
string

The blockchain address where the cryptocurrency was deposited

destinationOfFunds
object

Details about the destination of funds

expiredQuotes
string[]

Array of identifiers for quotes that have expired

fees
object

Object containing detailed information about various fees

fiat
enum<string>

The type of fiat currency used

Available options:
USD,
MXN,
PEN
id
string

The unique identifier for the order

invoice
object

order invoice details, only applies to Mexican orders.

netPrice
number

The net price of the cryptocurrency

notes
string

Additional information or comments related to the order

paymentInstructions
object

Payment instructions for the order

paymentReceivedAt
string

The date and time the payment was received

paymentsReceived
object[]

List of payments received

payoutAddressId
string

The unique identifier of the payout address

payoutBankAccountId
string

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

payoutsSent
object[]

List of payouts sent

payoutTransferLimit
number

The limit for payout transfer

price
number

The price of the cryptocurrency

quoteId
string

The ID of the quote

side
enum<string>

The side of the order

Available options:
buy,
sell
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
USBankTransferMethod
enum<string>

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

Available options:
ach_push,
wire
userId
string

The ID of the user

version
number

The version of the order

withdrawalTxId
string

The unique identifier for the withdrawal transaction on the blockchain

withdrawalTxIds
string[]

List of unique identifiers of withdrawal transactions on the blockchain.