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

currency*string

Ticker of the coins in which the payment will be made

network*string

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

amount*string

Payment amount

errorWebhookstring

URL to send webhook on error or order expiration

successWebhookstring

URL to send webhook on successful payment

returnUrlstring

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

order*string

Order ID in the merchant system

descriptionstring

Order Description

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

JavaScriptCurl

const response = await fetch('https://ocp.onchainpay.io/api-gateway/make-order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "3e8eed11-69a6-40d2-8b1f-d5d1b3f1fd72",
      "currency": "USDT",
      "network": "ethereum",
      "amount": "123.12",
      "order": "Order #123456"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "response": {
    "status": "pending",
    "link": "https://payment.domain/ad71343a-e1e8-4285-a02d-234ab23ef239",
    "amount": "123.12",
    "advancedBalanceId": "3e8eed11-69a6-40d2-8b1f-d5d1b3f1fd72",
    "currency": "USDT",
    "network": "ethereum",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "82123f7b-25a7-4e0c-ba10-d611d4fffd86",
    "orderId": "ad71343a-e1e8-4285-a02d-234ab23ef239",
    "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-05-07T11:57:25.610Z",
    "createdAt": "2024-05-07T11:27:25.610Z"
  }
}