Entity Reference
Responses
Pagination
| Attribute | Type | Description |
|---|---|---|
| per_page | int | current represented page |
| last_page | int | last represented page (number of pages) |
| total | int | total number of entities |
Status Codes
| Code | Name | Description |
|---|---|---|
| 200 | OK | Indicates that the request has succeeded. |
| 401 | Unauthorized | Indicates that the request requires user authentication information. The client MAY repeat the request with a suitable Authorization header field. |
| 404 | Not Found | The server can not find the requested resource. |
| 422 | Unprocessable Entity | The server understands the content type and syntax of the request entity, but still server is unable to process the request for some reason. |
| 500 | Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. |
Account Balance
| Attribute | Type | Description |
|---|---|---|
| id | string | unique key |
| currency | object | balance currency |
Entities
Order
| Attribute | Type | Description |
|---|---|---|
| id | string | internal order identifier |
| currency | string | invoice currency (ticker) |
| value | string (numeric) | invoice currency amount |
| deposit_currency | string | currency of deposit (ticker) |
| received_currency | string | balance currency (ticker) |
| received_total | string (numeric) | received amount in balance currency |
| expected_amount | string (numeric) | expected amount to be deposited |
| order status | string | order status label |
| external_order_id | string | external order identifier |
| created_at | datetime | date of order creation |
| completed_at | datetime | date of order completion |
| acquiring_url | string | unique payment form url. Should be used to redirect website customer to the payment form. |
| is_internal | boolean | identifies whether payment was made via WhiteBIT platform or not where true = WhiteBIT platform payment and false = any other platform. |
| exchange_rate | string (numeric) | fixated exchange rate of invoice |
| successful_link | string | link used to redirect user from payment form after order completion. For crypto acquiring orders only. Has to be URL. |
| failure_link | string | link used to redirect user from payment form in case of order failure. For crypto acquiring orders only. Has to be URL. |
| order_number | string | unique 9-digit numeric order identifier in Whitepay CRM system. |
Transaction
| Attribute | Type | Description |
|---|---|---|
| id | string | internal transaction identifier |
| currency | string | transaction currency |
| value | string (numeric) | transaction amount |
| status | string | transaction status |
| hash | string | transaction hash |
| is_internal | boolean | identifies whether payment was made via WhiteBIT platform or not where true = WhiteBIT platform payment and false = any other platform |
| created_at | datetime | date of transaction creation |
| completed_at | datetime | date of transaction completion |
Order Status
| Attribute | Type | Description |
|---|---|---|
| id | string | Internal Whitepay status identifier |
| label | string | Status label |
Invoice Currencies
| Attribute | Type | Description |
|---|---|---|
| id | string | internal currency identifier |
| ticker | string | currency ticker |
| is_fiat | boolean | a parameter that determines whether the currency is fiat |
| title | string | currency title |
| min_amount | string (numeric) | min currency amount for order creation |
| max_amount | string (numeric) | max currency amount for order creation |
| precision | string (numeric) | currency precision - number of characters after the decimal point |
| icon | string | currency icon for acquiring form |
Currency
| Attribute | Type | Description |
|---|---|---|
| id | string | currency id |
| ticker | string | currency ticker |
| title | string | currency title |
| value | string (numeric) | value in this currency |