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

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

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

post

Header parameters

x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json

Body

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

advancedBalanceIdstringRequired

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

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

currencystringRequired

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

Example: USDT

networkstringRequired

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

Example: ethereum

amountstringRequired

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

Example: 123.12

paymentTolerancePercentstringOptional

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

Example: 1.5

errorWebhookstringOptional

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

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

successWebhookstringOptional

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

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

returnUrlstringOptional

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

Example: https://merchant.domain/

orderstringRequired

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

Example: Order #123456

descriptionstringOptional

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

Example: Payment by order #123456

lifetimeintegerRequired

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

checkRisksbooleanOptional

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

externalUserIdstringOptional

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

Example: 10099

payerEmailstringOptional

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

Example: [e-mail]

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/make-order HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 455

{
  "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
  "currency": "USDT",
  "network": "ethereum",
  "amount": "123.12",
  "paymentTolerancePercent": "1.5",
  "errorWebhook": "https://merchant.domain/webhooks/fail",
  "successWebhook": "https://merchant.domain/webhooks/success",
  "returnUrl": "https://merchant.domain/",
  "order": "Order #123456",
  "description": "Payment by order #123456",
  "lifetime": 1,
  "checkRisks": true,
  "externalUserId": "10099",
  "payerEmail": "[e-mail]"
}

200Success

{
  "success": true,
  "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"
  }
}