Create an invoice for payment

The method allows you to create an invoice for payment without a strict indication of the coin and network, you can specify a payment of 30 USD and a list of coins/networks available for payment, the user himself will choose what is more convenient for him to pay. The amount will be automatically converted to the selected coin for payment

Create an invoice for payment

POSThttps://ocp.onchainpay.io/api-gateway/make-invoice

Header parameters

Body

application/json

advancedBalanceId*string

Identifier of the advance balance for writing off commissions

Example: "dcde70b7-e684-434f-9a7c-377d2010e66e"

externalIdstring

A unique identifier in the merchant's system to prevent duplication of invoices

Example: "merchantExternalId123"

orderstring

Order ID in the merchant system

Example: "Order #123456"

descriptionstring

Order Description

Example: "Payment by order #123456"

currency*string

Coins for payment. You can specify any available coin, including fiat. On the invoice page, the amount in the specified coin will be recalculated to the coins available for payment

Example: "USD"

amount*string

Amount payable in the specified coin. On the invoice page, the amount will be recalculated at the rate of coins available for payment

Example: "20"

includeFeeboolean

The flag allows you to include the commission of the blockchain network selected for payment in the amount payable. It will be useful to lay down your costs for the withdrawal of coins after payment.

additionalFeesarray of string

Array with the tariff names, which allows you to include commission in final amount for the specified tariffs

insurancePercentstring

Allows you to add the specified percentage to the payment amount'

Example: "1"

slippagePercentstring

When opening the invoice page, the user can spend so much time on it that the exchange rate changes. If after the transition to payment the amount changes more than the specified percentage, then the amount payable will be recalculated at the current rate

Example: "2"

paymentTolerancePercentstring

Acceptable underpayment percentage of an ORDER. For example, after selecting the invoice coin, an order for 100 USDT was created. If the parameter is set to 1.5%, the order will be completed successfully after payment of 98.5 USDT

Example: "1.5"

webhookURLstring

URL for notifications when the status of an invoice or amount received changes

Example: "https://merchant.domain/webhooks/invoice"

returnURLstring

URL to specify as "Return to Store" on the checkout page

Example: "https://merchant.domain/"

lifetime*integer

Invoice lifetime in minutes

currencies*array of array of any

List of coins and networks available for payment, if you specify an empty array, all coins/networks available in the system will be selected

Response

200

Body

application/json

success*boolean

Request success indicator

response*MakeInvoiceResponse (object)

Invoice response body

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/make-invoice', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "dcde70b7-e684-434f-9a7c-377d2010e66e",
      "currency": "USD",
      "amount": "20",
      "lifetime": 0,
      "currencies": [
        []
      ]
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "7ddf4231-4fba-40c3-9be4-b0b3ead76cb8",
    "advancedBalanceId": "dcde70b7-e684-434f-9a7c-377d2010e66e",
    "externalId": "merchantExternalId123",
    "orderId": "1f627ca9-009d-47e9-9873-40920fe8c9cf",
    "orderLink": "https://payment.domain/1f627ca9-009d-47e9-9873-40920fe8c9cf",
    "invoiceLink": "https://invoices.domain/7ddf4231-4fba-40c3-9be4-b0b3ead76cb8",
    "status": "INIT",
    "order": "Order #123456",
    "description": "Payment by order #123456",
    "currency": "USD",
    "amount": "20",
    "receivedNetwork": "USDT",
    "receivedCurrency": "USDT",
    "receivedAmount": "100.32",
    "receivedAmountInInvoiceCurrency": "100.94",
    "rate": "100.32",
    "includeFee": false,
    "additionalFees": [
      "SEPA_WITHDRAWAL"
    ],
    "insurancePercent": "1",
    "slippagePercent": "2",
    "paymentTolerancePercent": "1.5",
    "webhookURL": "https://merchant.domain/webhooks/invoice",
    "returnUrl": "https://merchant.domain/",
    "expiresAt": "2024-12-11T10:54:33.330Z",
    "createdAt": "2024-12-11T10:54:03.330Z",
    "currencies": [
      {
        "currency": "USDT",
        "networks": [
          {
            "name": "ethereum",
            "amount": "25"
          }
        ]
      }
    ]
  }
}