Orders
List previously placed orders
Get a list of previously placed orders. Depending on the authentication method used different orders will be returned.
When the bity_account_oauth or bity_account_client_oauth security schemes are used, which orders are visible depends on the scope of the access token.
get/orders
Query parameters
pagenumber
Number of the page to retrieve, defaults to the first page (1). See also the Link header in the 200 response.
page_sizenumber
Number of orders to include in a page. When not specified, 10.
status'finalized' | 'ongoing'
When specified, restrict the orders listing to orders with a specific status.
The currently understood values are:
- finalized: Only include orders that have reached a final state.
- ongoing: Only include orders that are not finalized.
Response
Successful operation.
Example response
{
"orders": [
{
"id": "209a6210-4ea3-43e4-ba92-73aac60fb10c",
"input": {
"amount": "0.5",
"crypto_address": "0x24305d091f79ee490a34de080b0db5773be5bef4",
"currency": "ETH",
"type": "crypto_address"
},
"output": {
"amount": "104.95",
"bic_swift": "BCNNCH22",
"currency": "CHF",
"iban": "CH3600000000000000000",
"owner": {
"address": "Rue des Fahrys 2",
"city": "Neuchatel",
"country": "CH",
"name": "John Doe"
},
"type": "bank_account"
},
"payment_details": {
"crypto_address": "0xf35074bbd0a9aee46f4ea137971feec024ab7048",
"type": "crypto_address"
},
"timestamp_cancelled": "2019-01-25T01:06:11.632Z",
"timestamp_created": "2019-01-24T13:14:07.368Z"
}
]
}