Getting a list of orders
The method allows you to get a list of orders
Header parameters
x-api-public-keystringOptional
Public API-key
x-api-signaturestringOptional
Signing the request body with a private API-key
Content-typestringOptionalExample:
Request content type
application/json
Body
Request body for getting a list of orders
limitintegerOptional
Number of elements per page
offsetintegerOptional
Number of items to skip
Responses
200Success
application/json
post
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/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"
}
],
"total": "1000"
}
}
Last updated