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:

Field

Description

Format

data.orders.id

Unique ID of the order

number

data.orders.account_id

Account ID for the order

string

data.orders.account_reference

Account reference for the customer

string

data.orders.order_type

Order type

string

data.orders.payment_type

Payment Type

string

data.orders.ref

Order Reference

string

data.orders.fiat_code

Fiat currency code

string

data.orders.fiat_amount

Fiat currency value for the order

decimal

data.orders.coin_code

Cryptocurrency code

string

data.orders.coin_amount

Cryptocurrency value for the order

decimal

data.orders.wallet_address

Cryptocurrency wallet address

string

data.orders.wallet_address_tag

Cryptocurrency wallet address tag (if required)

string

data.order.blockchain

Blockchain network being used for the cryptocurrency

array

data.order.blockchain.code

Blockchain code

string

data.order.blockchain.description

Blockchain code full name

string

data.orders.fee

Order fee in fiat currency

decimal

data.orders.fee_tax

Tax charged on the payment fee in the fiat currency

decimal

data.orders.payment_fee

Payment fee in fiat currency

decimal

data.orders.payment_fee_tax

Tax charged on the payment fee in the fiat currency

decimal

data.orders.commission

Commission amount in the fiat currency

decimal

data.orders.tx_hash

Blockchain transaction hash

string

data.orders.tx_confirms

Number of blockchain confirmations

number

data.orders.created_at

Timestamp when order was created in UTC time

string

data.orders.created_date

Date of order creation in UTC time

string

data.orders.status

Current order status. Available order statuses can be found here: Order Status

string

data.orders.merchant_fee

Your defined fee. Shown as null if not configured.

decimal

data.orders.meta_data

Returning meta data that was passed by your with the original order

string

meta.current_page

Page requested

number

meta.last_page

Last page that can be requested

number

meta.from

Index of the first item in this response

number

meta.to

Index of the last item in this response

number

meta.per_page

Max number of items per page

string

meta.total

Total number of items found

number

Language
Authentication
Header
Click Try It! to start a request and see the response here!