Создание счета на оплату

Метод позволяет создать счет на оплату без строгого указания монеты и сети, вы можете указать оплату 30 USD и список доступных к оплате монет/сетей, пользователь сам выберет в чем ему удобнее оплатить. Сумма автоматически пересчитается в выбранную монету для оплаты

Создание счета на оплату

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

Header parameters

Body

application/json

advancedBalanceId*string

Идентификатор авансового баланса для списания комиссий

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

externalIdstring

Уникальный идентификатор в системе мерчанта, для предотвращения дублирования создания инвойсов

Example: "merchantExternalId123"

orderstring

Идентификатор ордера в системе мерчанта

Example: "Order #123456"

descriptionstring

Описание ордера

Example: "Payment by order #123456"

currency*string

Монеты для оплаты. Можно указывать любую доступную монету, в том числе фиатную. На странице инвойса сумма в указанной монете будет пересчитана к доступным для оплаты монет

Example: "USD"

amount*string

Сумма к оплате в указанной монете. На странице инвойса сумма будет пересчитана по курсу к доступным для оплаты монетам

Example: "20"

includeFeeboolean

Флаг позволяет включить в сумму к оплате комиссию сети блокчейна выбранного для оплаты. Будет полезно чтобы заложить свои издержки на вывод монет после оплаты.

additionalFeesarray of string

Массив с названиями тарифов, который позволяет включить в сумму к оплате комиссии по указанным тарифам

insurancePercentstring

Позволяет добавить к сумме оплаты указанный процент

Example: "1"

slippagePercentstring

При открытия страници инвойса пользователь может провести на ней столько времени что курс смениться. Если после перехода к оплате сумма измениться больше указанного процента, то сумма к оплате будет пересчитана по текущему курсу

Example: "2"

paymentTolerancePercentstring

Допустимый процент недоплаты ОРДЕРА. Например, после выбора монеты инвойса был создан ордер на 100 USDT. Если параметр установлен как 1.5%, то ордер завершится с успехом при оплате 98.5 USDT

Example: "1.5"

webhookURLstring

URL для уведомлений при изменении статуса инвойса или полученной суммы

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

returnURLstring

URL для указания в качестве "Вернуться в магазин" на странице оплаты

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

lifetime*integer

Время жизни инвойса в минутах

currencies*array of array of any

Список монет и сетей доступных для оплаты, при указании пустого массива будут выбраны все монеты/сети доступные в системе

Response

200

Body

application/json

success*boolean

Признак успешности запроса

response*MakeInvoiceResponse (object)

Тело ответа инвойса

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"
          }
        ]
      }
    ]
  }
}