Получение списка ордеров

Метод позволяет получить список ордеров

Получение списка ордеров

post

Header parameters

x-api-public-keystringoptional

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

x-api-signaturestringoptional

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

Content-typestringoptional

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

Example: application/json

Body

Тело запроса для получения списка ордеров

statusstring · enum[]optional

Массив для фильтрации ордеров по статусам

Example: pending

limitintegeroptional

Количество элементов на странице

offsetintegeroptional

Количество элементов для пропуска

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/orders' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": [
      "pending"
    ],
    "limit": 1,
    "offset": 1
  }'

200

200

{
  "success": true,
  "response": {
    "orders": [
      {
        "status": "pending",
        "link": "https://payment.domain/a3cb5179-babb-422e-8c34-9d4658cacc7f",
        "amount": "123.12",
        "paymentTolerancePercent": "1.5",
        "advancedBalanceId": "50781c26-1005-4b1e-94ea-a19a17017e90",
        "currency": "USDT",
        "network": "ethereum",
        "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
        "addressId": "47ce6b06-bce3-4172-b2a4-ce5206487491",
        "tag": null,
        "orderId": "a3cb5179-babb-422e-8c34-9d4658cacc7f",
        "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-25T15:05:23.163Z",
        "createdAt": "2024-12-25T14:35:23.164Z"
      }
    ],
    "total": "1000"
  }
}