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

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
lifetimeintegerOptional

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: [email protected]
Responses
200Success
application/json
post
/api-gateway/make-order
POST /api-gateway/make-order HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "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": "[email protected]"
}
200Success
{
  "success": true,
  "response": {
    "status": "pending",
    "link": "https://payment.domain/4b3399ee-3690-4984-8c39-a911c8b0aad4",
    "amount": "123.12",
    "paymentTolerancePercent": "1.5",
    "currency": "USDT",
    "network": "ethereum",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "258e95ed-a3c2-4c85-bf6f-09f8b8f1c0be",
    "tag": null,
    "orderId": "4b3399ee-3690-4984-8c39-a911c8b0aad4",
    "clientOrderId": "Order #123456",
    "externalUserId": "10099",
    "payerEmail": "[email protected]",
    "description": "Payment by order #123456",
    "successWebhook": "https://merchant.domain/webhooks/success",
    "errorWebhook": "https://merchant.domain/webhooks/fail",
    "returnUrl": "https://merchant.domain/",
    "expiresAt": "2025-06-09T13:48:11.523Z",
    "createdAt": "2025-06-09T13:18:11.523Z"
  }
}
PreviousOrdersNextGetting information about an order

Last updated