Getting a list of orders

The method allows you to get a list of orders

Getting a list of orders

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 getting a list of orders

statusstring · enum[]Optional

Array for filtering orders by status

Example: pending

limitintegerOptional

Number of elements per page

offsetintegerOptional

Number of items to skip

Responses

application/json

objectOptional

Successful response

post

HTTPcURLJavaScriptPython

POST /api-gateway/orders HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "status": [
    "pending"
  ],
  "limit": 1,
  "offset": 1
}

200Success

{
  "success": true,
  "response": {
    "orders": [
      {
        "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"
      }
    ],
    "total": "1000"
  }
}