Please read page before starting. The invoice creation API uses several parameters that need explanation.
XGateway supports deposits with preliminary creation of with a fixed exchange rate. This is the recommended integration form, which providers merchants with ready-made UI for deposits with crypto assets.
Creating an invoice
In order to create a Fixed Rate Invoice in the payment processing system, you need to make a POST request to the Invoice API endpoint.
The XGateway provides one , which automatically defines a corresponding payment method based on the input parameters provided by the merchant. Below are examples of a payload to create an invoice for a SEPA Secure deposit in such currencies as EUR or GBP.
he system will skip all XGateway intermediate pages and redirect the customer directly to the payment method, but only if all required data is provided. Integration can be implemented and tested with the mandatory fields alone; however, it is highly recommended to proceed with pre-filled forms, as this can dramatically simplify the flow for the end user and improve conversion. Please don't forget to check the and the guide on conversion optimisation down below.
The request returns a link to a correspondingly configured Checkout page.
The Checkout page will lead the customer through a KYC if this is the first deposit.
If the KYC is soft failed (example due to address or DoB mismatch), the Checkout page will allow the customer to go through the KYC again and correct the error.
This Checkout page will eventually provide the customer with a virtual bank account number (IBAN) that must be used as an address for deposits.
The created IBAN remains active forever, considering the customer is active. If the IBAN was not used at all or was used long time ago (3 to 6 months ago) - XGateway team may deactivate the IBAN.
Remember to authorise the request with your key using x-api-key header.
The default lifetime of an invoice is 15 minutes.
Limits
The invoice creation API validates the amount value.
An invoice will not be created, if the amount exceeds the limits.
The standard bank transfer deposit flow includes four key steps:
KYC Form – The customer enters personal details like address, country, city, and postcode.
KYC Verification (SumSub Widget) – The customer uploads proof of address and identity.
Bank Account Creation Form – The customer provides their first name, last name, email, and other details to create a bank account.
Requisites Page – The IBAN is displayed to the customer.
Steps 1 and 2 are always required and must be completed via our checkout page before a bank account can be created. Step 3 is optional though.
Experience:
4 steps for first invoice setup
2 steps for recurring payments
Impact: Slower onboarding and more friction for returning users
Optimised Flow with Optional Fields
While the base Invoice creation flow only requires mandatory fields, including the following optional fields during invoice creation can significantly streamline the user experience:
paymentCurrency
customerCountry
customerFirstName
customerLastName
customerEmail
These values are usually already known when generating an invoice. Supplying them upfront allows the customer to skip the bank account creation form entirely (Step 3).
Experience:
3 steps for first invoice setup
Direct redirection (1 step) to Requisites page for recurring payments
Impact: Seamless user journey and faster payment completion
When a customer makes a deposit using a cryptocurrency, XGateway detects the transaction and sends a deposit callback to the merchant. Below is an example of such a callback. For detailed information, please visit.
Due to security risks, merchants must use our to request transaction details. XGateway is not liable for issues caused by relying only on callback data.
To confirm the callback is valid, please use the .