Fiat Invoices
Every request listed on this page requires authorization to be successfully completed.
Create fiat invoice (Server-Side)
POST
https://public.api.0xpay.app/merchants/invoices/fiat
Creates a webpage with your invoice details on 0xpay.app domain, usable for a one-time payment. Currently, the only supported fiat tickers
are UAH and KZT.
Payment limits:
KZT Min — 12000 KZT, Max — 300000 KZT.
Status Updates: After creation, every invoice update will produce an invoice notification.
Request Body
Name | Type | Description |
---|---|---|
amount | object |
|
meta | string | your metadata that will be passed along to you later with a notification |
name* | string | descriptional field, name of your invoice. For example: "Order payment" |
toPendingImmediate | boolean | jump immediately to pending status, it can be useful if you want to skip fist "user prompt" status. |
string | user email | |
target | object |
|
redirectUrl | string | URL to redirect user after payment |
Create fiat invoice via Web Form (Client-Side)
POST
https://public.api.0xpay.app/merchants/invoices/fiat/form
Creates a fiat invoice using parameters from your HTML form and redirects users to 0xpay URL for payment. on 0xpay.app domain for one-time payment. Currently, the only supported fiat tickers
are UAH and KZT.
Payment limits:
UAH Min — 25 UAH, Max — 29999 UAH.
KZT Min — 12000 KZT, Max — 300000 KZT.
Instead of authorizing a request, just pass your merchantID along with other parameters.
Status Updates: After creation, every invoice update will produce an invoice notification.
Request Body
Name | Type | Description |
---|---|---|
value | string | a fixed amount of invoice This field is optional, if not specified user will fill this fields on his demand |
meta | string | your metadata that will be passed along to you later with a notification |
name* | string | descriptional field, name of your invoice. For example: "Order payment" |
merchantID* | string | internal id of your 0xpay merchant account |
targetTicker | string | the currency to which we will try to exchange the received funds if |
ticker | string | only UAH available currently This field is optional, if not specified user will fill this fields on his demand |
targetAddress | string | the address, to which we will withdraw invoice funds in the currency specified in |
targetBlockchain | string | network in which withdrawal will be made, this field is required if |
redirectUrl | string | URL to redirect user after payment |
Redirects to payment webpage URL
Find fiat invoice details by ID
GET
https://public.api.0xpay.app/merchants/invoices/fiat/:id
This method is used to get invoice's data by it's id.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | internal identificator of 0xpay invoice |
List of invoice statuses: - CREATED - PENDING - PAID - DONE - FAILED
Last updated