Creating an order

Create an order for payment

Creating an order

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

Header parameters

Body

application/json

advancedBalanceId*string

Identifier of the advance balance for writing off commissions

Example: "882f4ed6-82c8-43c3-8dd6-d755cee5f1af"

currency*string

Ticker of the coins in which the payment will be made

Example: "USDT"

network*string

The network of the coin in which the payment will be made

Example: "ethereum"

amount*string

Payment amount

Example: "123.12"

paymentTolerancePercentstring

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

Example: "1.5"

errorWebhookstring

URL to send webhook on error or order expiration

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

successWebhookstring

URL to send webhook on successful payment

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

returnUrlstring

URL to be placed on the payment page as "Return to Store" links

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

order*string

Order ID in the merchant system

Example: "Order #123456"

descriptionstring

Order Description

Example: "Payment by order #123456"

lifetime*integer

Order lifetime in seconds, available values from 1800 (30 minutes) to 43200 (12 hours)

checkRisksboolean

Whether to check incoming transactions for this order

Response

200

Body

application/json

success*boolean

Request success indicator

response*MakeOrderResponse (object)

Response body when requesting to create an order

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": "882f4ed6-82c8-43c3-8dd6-d755cee5f1af",
      "currency": "USDT",
      "network": "ethereum",
      "amount": "123.12",
      "order": "Order #123456"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "status": "pending",
    "link": "https://payment.domain/c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
    "amount": "123.12",
    "paymentTolerancePercent": "1.5",
    "advancedBalanceId": "882f4ed6-82c8-43c3-8dd6-d755cee5f1af",
    "currency": "USDT",
    "network": "ethereum",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "7504dcc8-e87e-4dce-862f-0a9b765bfbda",
    "tag": null,
    "orderId": "c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
    "clientOrderId": "Order #123456",
    "description": "Payment by order #123456",
    "successWebhook": "https://merchant.domain/webhooks/success",
    "errorWebhook": "https://merchant.domain/webhooks/fail",
    "returnUrl": "https://merchant.domain/",
    "expiresAt": "2024-11-07T13:11:09.821Z",
    "createdAt": "2024-11-07T12:41:09.821Z"
  }
}