Floating Rate invoices (deprecated)

An invoice with 24-hour expiration time can be created. An exchange rate is "floating", which means that the exchange rate updates every 15 minutes. The customer can have only 1 floating invoice at a time, once the customer creates a new invoice all previous invoices will be cancelled.

To create a Floating Rate invoice in the payment processing system, you need to make a POST request to the Invoice API v1 endpoint.

Create an invoice for the customer for a specified currency and optional order id and application id.

Creates an invoice with floating exchange rate strategy. Returns a checkout link.

The invoice will be activated right away if the payment currency and provider ID parameters are passed.

The link to the final step will be returned if the payment system has been passed as a parameter. If the payment system is not found, the user will be redirected to the select payment method step.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

POSThttp://localhost:8000/api/v1/invoice

Authorization

api_key

Body

application/json

• The request body contains different fields for different providers (see below).

Crypto:

• amount - The amount to issue an invoice for.
• applicationId - The application identifier.
• baseCurrency - The base currency.
• customerId - The customer identifier.
• orderId - The order identifier.
• paymentCurrency - The payment currency.
• providerId - The provider identifier [DEPRECATED].

Peer-to-peer:

• amount - The amount to issue an invoice for.
• applicationId - The application identifier.
• baseCurrency - The base currency.
• customerId - The customer identifier.
• orderId - The order identifier.
• paymentCurrency - The payment currency.
• paymentSystem - The payment system.
• providerId - The provider identifier [DEPRECATED].

Peer-to-peer2:

• amount - The amount to issue an invoice for.
• applicationId - The application identifier.
• baseCurrency - The base currency.
• customerId - The customer identifier.
• customerName - The customer name (min 1, max 150).
• customerStreetAddress1 - The customer address (min 2, max 250, optional).
• customerCity - The customer city (min 2, max 20, optional).
• customerState - The customer state (min 2, max 100, optional).
• customerCountry - The customer country (min 2, max 100, optional).
• customerZip - The customer zip (min 6, max 9, optional).
• customerPhone - The customer phone (length - 10, to be passed without country code).
• customerEmail - The customer email (min 6, max 120).
• orderDescription - Description of product (min 1, max 1024, optional).
• orderId - The order identifier.
• paymentCurrency - The payment currency.
• paymentSystem - The payment system.
• providerId - The provider identifier [DEPRECATED].

any of

• The request body contains different fields for different providers (see below).

Crypto:

• amount - The amount to issue an invoice for.
• applicationId - The application identifier.
• baseCurrency - The base currency.
• customerId - The customer identifier.
• orderId - The order identifier.
• paymentCurrency - The payment currency.
• providerId - The provider identifier [DEPRECATED].

Peer-to-peer:

• amount - The amount to issue an invoice for.
• applicationId - The application identifier.
• baseCurrency - The base currency.
• customerId - The customer identifier.
• orderId - The order identifier.
• paymentCurrency - The payment currency.
• paymentSystem - The payment system.
• providerId - The provider identifier [DEPRECATED].

Peer-to-peer2:

• amount - The amount to issue an invoice for.
• applicationId - The application identifier.
• baseCurrency - The base currency.
• customerId - The customer identifier.
• customerName - The customer name (min 1, max 150).
• customerStreetAddress1 - The customer address (min 2, max 250, optional).
• customerCity - The customer city (min 2, max 20, optional).
• customerState - The customer state (min 2, max 100, optional).
• customerCountry - The customer country (min 2, max 100, optional).
• customerZip - The customer zip (min 6, max 9, optional).
• customerPhone - The customer phone (length - 10, to be passed without country code).
• customerEmail - The customer email (min 6, max 120).
• orderDescription - Description of product (min 1, max 1024, optional).
• orderId - The order identifier.
• paymentCurrency - The payment currency.
• paymentSystem - The payment system.
• providerId - The provider identifier [DEPRECATED].

objectobjectobjectobject

Response

201400401422500

Created

Body

application/json

success*boolean

data*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:8000/api/v1/invoice', {
    method: 'POST',
    headers: {
      "x-api-key": "api_key <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "providerId": 0,
      "paymentCurrency": "BNB",
      "customerId": "text",
      "baseCurrency": "EUR"
    }),
});
const data = await response.json();

Response

201400401422500

{
  "data": "[checkout link]",
  "success": true
}

Remember to authorize the request with your x-api-key header.

Headers

Name	Type	Description
x-api-key*	String	Your API key

Invoice with short time to live. Exchange rate fixes in a moment of invoice activation. Customers can create an unlimited amount of invoices but can have only up to 10 activated invoices. To activate a new one wait till previous invoices expire.