Get Orders (Bulk Orders)

get https://api.banxa.com/api/orders

Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer.

Response

When orders are successfully returned, you will receive the following:

FieldDescriptionFormat
data.orders.idUnique ID of the ordernumber
data.orders.account_idAccount ID for the orderstring
data.orders.account_referenceAccount reference for the customerstring
data.orders.order_typeOrder typestring
data.orders.payment_typePayment Typestring
data.orders.refCustomer friendly order referencestring
data.orders.countryThe KYC country of the userstring
data.orders.fiat_codeFiat currency codestring
data.orders.fiat_amountFiat currency value for the orderdecimal
data.orders.coin_codeCryptocurrency codestring
data.orders.coin_amountCryptocurrency value for the orderdecimal
data.orders.wallet_addressCryptocurrency wallet addressstring
data.orders.wallet_address_tagCryptocurrency wallet address tag (if required)string
data.order.blockchainData object that contains the blockchain details.object
data.order.blockchain.codeBlockchain codestring
data.order.blockchain.descriptionBlockchain code full namestring
data.order.blockchain.contract_idBlockchain-cryptocurrency smart contract IDstring
data.orders.feeOrder fee in fiat currencydecimal
data.orders.fee_taxTax charged on the payment fee in the fiat currencydecimal
data.orders.payment_feePayment fee in fiat currencydecimal
data.orders.payment_fee_taxTax charged on the payment fee in the fiat currencydecimal
data.orders.commissionCommission amount in the fiat currencydecimal
data.orders.tx_hashBlockchain transaction hashstring
data.orders.tx_confirmsNumber of blockchain confirmationsnumber
data.orders.created_atTimestamp when order was created in UTC timestring
data.orders.created_dateDate of order creation in UTC timestring
data.orders.statusCurrent order status. Available order statuses can be found here: Order Statusstring
data.orders.merchant_feeYour defined fee. Shown as null if not configured.decimal
data.order.discountData object that contains discount applied to the order. This object is only returned if a discount was applied to the order.object
discount.before_crypto_amountThe crypto amount the customer would have received prior to the discount.string
discount.after_crypto_amountThe crypto amount the customer received after the discount was applied.string
discount.before_network_feeThe network fee the customer would have paid prior to the discount being applied. .string
discount.after_network_feeThe network fee the customer paid after the discount was applied.string
discount.before_gateway_feeThe payment gateway fee the customer would have paid prior to the discount being applied.string
discount.after_gateway_feeThe payment gateway fee the customer paid after the discount was applied.string
discount.before_fiat_amountThe fiat amount the customer would have received prior to the discount.string
discount.after_fiat_amountThe fiat amount the customer received after the discount was applied.string
data.orders.meta_dataReturning meta data if this was passed as part of the original Create Order request.object
meta.current_pagePage requestednumber
meta.last_pageLast page that can be requestednumber
meta.fromIndex of the first item in this responsenumber
meta.toIndex of the last item in this responsenumber
meta.per_pageMax number of items per pagestring
meta.totalTotal number of items foundnumber
Language
Authorization
Header
Click Try It! to start a request and see the response here!