Getting a list of orders

The method allows you to get a list of orders

Getting a list of orders

POSThttps://ocp.onchainpay.io/api-gateway/orders

Header parameters

Body

application/json

statusarray of enum

Array for filtering orders by status

limitinteger

Number of elements per page

offsetinteger

Number of items to skip

Response

200

Body

application/json

success*boolean

Request success indicator

response*GetOrdersResponse (object)

The body of the response to the request for a list of orders

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "orders": [
      {
        "status": "pending",
        "link": "https://payment.domain/904c0d61-b7d4-4aca-9824-fd8c51ab13bf",
        "amount": "123.12",
        "paymentTolerancePercent": "1.5",
        "advancedBalanceId": "193f2c21-e245-4791-a4fd-9d852f3f434d",
        "currency": "USDT",
        "network": "ethereum",
        "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
        "addressId": "1a8cc737-cf2b-4e74-9b78-c4b7a7ace939",
        "tag": null,
        "orderId": "904c0d61-b7d4-4aca-9824-fd8c51ab13bf",
        "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-09-24T12:38:44.674Z",
        "createdAt": "2024-09-24T12:08:44.675Z"
      }
    ],
    "total": "1000"
  }
}