Acquiring HTTP API
[POST] Create New Crypto Topup
/private-api/crypto-topups/{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": "300",
"currency": "USDT",
"external_order_id": "INV-123",
"successful_link": "https://merchant.website.com",
"failure_link": "https://merchant.website.com"
}
| Attribute | Type | Required | Description |
|---|---|---|---|
| amount | decimal | N | Invoice amount. Min value depends on currency. Becomes required in case if “currency“ was specified. |
| currency | string | N | Invoice currency. Becomes required in case if “amount“ was specified. |
| 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: “-“, “_“. |
| successful_link | string | N | Link used to redirect user from payment form after order completion. Has to be URL |
| failure_link | string | N | Link used to redirect user from payment form after order failure. Has to be URL |
Response Payload
{
"order": {
"id": "a058745c-3ad7-443c-863f-402f30d40ca5",
"currency": "USDT",
"order_number": "146556393",
"value": "9876",
"expected_amount": null,
"received_total": "0",
"exchange_rate": null,
"clean_exchange_rate": null,
"is_internal": null,
"deposited_currency": null,
"received_currency": "USDT",
"status": "INIT",
"external_order_id": "23423512",
"created_at": "2024-02-12 14:50:27",
"completed_at": null,
"acquiring_url": "https://merchant.pay.whitepay.com/topup-orders/crypto/a058745c-3ad7-443c-863f-402f30d40ca5",
"successful_link": null,
"failure_link": null,
"transactions": []
}
}
Check out order entity reference for detailed description.
[GET] Show Invoice Currencies For Crypto Order Creation
/private-api/currencies/crypto-topup-target-currencies
Response Payload
{
"currencies": [
{
"id": "a4d2e5b4-aa82-43dc-af9c-663e8d5c33d5",
"ticker": "EUR",
"min_amount": "4.63",
"precision": 2,
"max_amount": "10000000"
},
{
"id": "b9285bd5-b2bb-4e9a-ab49-6d0a7ffb3973",
"ticker": "TUSD",
"min_amount": "5.17",
"precision": 2,
"max_amount": "10000000"
},
{
"id": "6e2372bb-76b4-48b0-9d74-39f6902cabf8",
"ticker": "UAH",
"min_amount": "215.5",
"precision": 2,
"max_amount": "10000000"
},
{
"id": "d9da4bdc-1c0b-4835-8ec6-a7118247340f",
"ticker": "USDT",
"min_amount": "5",
"precision": 2,
"max_amount": "10000000"
}
]
}
Check out order entity reference for detailed description.