Creating an order

Create an order for payment

Creating an order

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

Request body for creating a payment order

advancedBalanceIdstringRequired

Identifier of the advance balance for writing off commissions

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

currencystringRequired

Ticker of the coins in which the payment will be made

Example: USDT

networkstringRequired

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

Example: ethereum

amountstringRequired

Payment amount

Example: 123.12

paymentTolerancePercentstringOptional

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

errorWebhookstringOptional

URL to send webhook on error or order expiration

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

successWebhookstringOptional

URL to send webhook on successful payment

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

returnUrlstringOptional

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

Example: https://merchant.domain/

orderstringRequired

Order ID in the merchant system

Example: Order #123456

descriptionstringOptional

Order Description

Example: Payment by order #123456

lifetimeintegerRequired

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

checkRisksbooleanOptional

Whether to check incoming transactions for this order

externalUserIdstringOptional

The external user ID in your system. When specifying the identifier, the functionality of the "Personal addresses" section will be used - a static address will be reserved for this user, but the webhook will be sent to the URL specified in this request

Example: 10099

payerEmailstringOptional

Payer's email address. If it is specified alongside with the 'externalUserId' parameter, a user with such an email will be created in the "Personal addresses" section

Example: [e-mail]

Responses

application/json

objectOptional

Successful response

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