get https://api.banxa.com/api/orders/
Retrieves details for single order that has been submitted
Response
When an order is successfully returned, you will receive the following:
| Field | Description | Format |
|---|---|---|
data.order.id | Unique ID of the order | string |
data.order.account_id | Account ID for the order | string |
data.order.account_reference | Account reference for the customer | string |
data.order.order_type | Order type indicated a Buy or a Sell cryptocurrency order | string |
data.order.payment_type | Payment Type that was used by the customer | string |
data.order.ref | Customer friendly order reference | number |
data.order.country | The KYC country of the user | string |
data.order.fiat_code | Fiat currency code | string |
data.order.fiat_amount | Fiat currency value for the order | decimal |
data.order.coin_code | Cryptocurrency code | string |
data.order.coin_amount | Cryptocurrency value for the order | decimal |
data.order.wallet_address | Cryptocurrency wallet address | string |
data.order.wallet_address_tag | Cryptocurrency wallet address tag (if required) | string |
data.order.blockchain | Data object that contains the blockchain details. | object |
data.order.blockchain.code | Blockchain code | string |
data.order.blockchain.description | Blockchain code full name | string |
data.order.blockchain.contract_id | Blockchain / cryptocurrency smart contract ID | string |
data.order.fee | Order fee in fiat currency | decimal |
data.order.fee_tax | Tax charged on the payment fee in the fiat currency | decimal |
data.order.payment_fee | Payment fee in fiat currency | decimal |
data.order.payment_fee_tax | Tax charged on the payment fee in the fiat currency | decimal |
data.order.commission | Commission amount in the fiat currency | decimal |
data.order.tx_hash | Blockchain transaction hash | string |
data.order.tx_confirms | Number of blockchain confirmations | number |
data.order.created_at | Timestamp when order was created in UTC time | string |
data.order.created_date | Date when order was created in UTC time | string |
data.order.status | Current Status of the Order. See: Order Status | string |
data.order.merchant_fee | Merchant defined fee. Shown as null if not configured. | decimal |
data.order.meta_data | Returning meta data if this was passed as part of the original Create Order request. | string |
data.order.requested_fx | Data object that contains the converted fiat_amount. This is only added if fx_currency param is passed. | object |
data.order.requested_fx.currency | The same value that was passed in fx_currency | string |
data.order.requested_fx.rate | Fx rate between the fiat_code and the fx_currency | decimal |
data.order.requested_fx.amount | Converted fiat_amount in the passed fx_currency | decimal |
data.order.discount | Data 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_amount | The crypto amount the customer would have received prior to the discount. | string |
discount.after_crypto_amount | The crypto amount the customer received after the discount was applied. | string |
discount.before_network_fee | The network fee the customer would have paid prior to the discount being applied. . | string |
discount.after_network_fee | The network fee the customer paid after the discount was applied. | string |
discount.before_gateway_fee | The payment gateway fee the customer would have paid prior to the discount being applied. | string |
discount.after_gateway_fee | The payment gateway fee the customer paid after the discount was applied. | string |
discount.before_fiat_amount | The fiat amount the customer would have received prior to the discount. | string |
discount.after_fiat_amount | The fiat amount the customer received after the discount was applied. | string |