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.

Query Params

start_date

date

required

Defaults to 2021-01-18

Start date used for filtering orders. Must be a date in the format YYYY-MM-DD.

end_date

date

required

Defaults to 2021-01-19

End date used for filtering orders. Must be a date in the format YYYY-MM-DD.

status

string

Defaults to inProgress,coinTransferred,declined

Current status of an order. Can be one or many order statuses which are comma separated. Available order statuses can be found here: Order Status

per_page

int32

Defaults to 100

Number of orders returned in a single response. The maximum is 200.

page

int32

Page to retrieve. The number of pages available is given in the meta object in the response.

account_reference

string

Customer reference that was passed as a parameter when creating an order. Used to retrieve all orders for a customer.

Headers

string

Defaults to application/json

X-Request-Id

string

This is the correlation ID related to the request.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200