Acquiring HTTP API
[POST] Create New Fiat Order
/private-api/orders/{slug}
| Attribute | Type | Required | Description |
|---|---|---|---|
| slug | string | Y | unique instance name defined for payment page. Can be found on each payment page settings page in CRM. |
Request Payload
{
"amount": "15",
"currency": "EUR",
"external_order_id": "INV-123"
}
| Attribute | Type | Required | Description |
|---|---|---|---|
| amount | decimal | Y | Invoice amount. min/max values differs for different invoice currencies |
| currency | string | Y | Fiat currency ticker |
| external_order_id | string | N | unique order identifier in client Database (usually Internal Payment or Order ID used). Number of characters: min 1, max 255. Allowed symbols: aA-zZ, 0-9. Special characters: “-“, “_“. |
Response Payload
{
"order": {
"id": "12700f28-8f3c-4e25-9ae2-ae1b023bda05",
"currency": "EUR",
"order_number": "999545517",
"value": "15",
"expected_amount": "15",
"received_total": "0",
"exchange_rate": null,
"clean_exchange_rate": null,
"is_internal": null,
"deposited_currency": "EUR",
"received_currency": "EUR",
"status": "OPEN",
"external_order_id": "Inv-7",
"created_at": "2024-01-22 11:29:41",
"completed_at": null,
"acquiring_url": "https://whitebit.com/payment/deposit?transactionId=cf118697-b968-4fd0-a933-3de84c127d49&amount=15¤cy=EUR",
"successful_link": "https://whitepay.com/clients",
"failure_link": "https://whitepay.com/support",
"transactions": []
}
}
Check out order entity reference for detailed description.
[GET] Show Invoice Currencies For Fiat Order Creation
/currencies/fiat-order-target-currencies
Response Payload
{
"currencies": [
{
"id": "2b49449f-7757-4ad0-8e42-1ac75a002ecf",
"ticker": "USD",
"is_fiat": true,
"title": "US Dollar",
"is_used_for_order_exchange": true,
"min_amount": "10",
"max_amount": "4000",
"is_billable": false,
"precision": 2
},
{
"id": "a4d2e5b4-aa82-43dc-af9c-663e8d5c33d5",
"ticker": "EUR",
"is_fiat": true,
"title": "Euro",
"is_used_for_order_exchange": true,
"min_amount": "15",
"max_amount": "10000",
"is_billable": false,
"precision": 2
}
]
}
Check out invoice currencies entity reference for detailed description.
Order Status Change
