Создание ордера

Создание ордера для оплаты

Создание ордера

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

Header parameters

Body

application/json

advancedBalanceId*string

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

Example: "1503cf18-597f-447f-b172-112dfe377e1b"

currency*string

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

Example: "USDT"

network*string

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

Example: "ethereum"

amount*string

Сумма к оплате

Example: "123.12"

paymentTolerancePercentstring

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

Example: "1.5"

errorWebhookstring

URL для отправки вебхука при ошибке или истечении ордера

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

successWebhookstring

URL для отправки вебхука при успешной оплате

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

returnUrlstring

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

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

order*string

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

Example: "Order #123456"

descriptionstring

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

Example: "Payment by order #123456"

lifetime*integer

Время жизни ордера в секундах, доступные значения от 1800 (30 минут) до 43200 (12 часов)

checkRisksboolean

Проверять ли входящие транзакции по данному ордеру

externalUserIdstring

Внешний идентификатор пользователя в вашей системе. При указании идентификатора будет использован функционал раздела "Персональные адреса" - будет зарезервирован статический адрес под данного пользователя, но вебхук придет на указанный в этом запросе адрес

Example: "10099"

payerEmailstring

Почта плательщика. Если указана в связке с параметром 'externalUserId' - будет создан пользователь с таким email в разделе "Персональные адреса"

Example: "[e-mail]"

Response

200

Body

application/json

success*boolean

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

response*MakeOrderResponse (object)

Тело ответа при запросе создания ордера

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/make-order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
      "currency": "USDT",
      "network": "ethereum",
      "amount": "123.12",
      "order": "Order #123456",
      "lifetime": 0
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "status": "pending",
    "link": "https://payment.domain/a7ff7a80-dd8e-40e7-a262-4599b007211b",
    "amount": "123.12",
    "paymentTolerancePercent": "1.5",
    "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
    "currency": "USDT",
    "network": "ethereum",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
    "tag": null,
    "orderId": "a7ff7a80-dd8e-40e7-a262-4599b007211b",
    "clientOrderId": "Order #123456",
    "externalUserId": "10099",
    "payerEmail": "[e-mail]",
    "description": "Payment by order #123456",
    "successWebhook": "https://merchant.domain/webhooks/success",
    "errorWebhook": "https://merchant.domain/webhooks/fail",
    "returnUrl": "https://merchant.domain/",
    "expiresAt": "2024-12-26T08:51:33.210Z",
    "createdAt": "2024-12-26T08:21:33.210Z"
  }
}