Getting information about an order

The method allows you to get information on a previously created order by its identifier in the system

Getting information about an order

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

Header parameters

Body

application/json

orderIdstring

Order ID in the system

Example: "1f627ca9-009d-47e9-9873-40920fe8c9cf"

Response

200

Body

application/json

success*boolean

Request success indicator

response*GetOrderResponse (object)

Body of the response to the request to receive an order

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "response": {
    "id": "1f627ca9-009d-47e9-9873-40920fe8c9cf",
    "advancedBalanceId": "dcde70b7-e684-434f-9a7c-377d2010e66e",
    "currency": "USDT",
    "network": "ethereum",
    "status": "pending",
    "orderId": "Order #123456",
    "description": "Payment by order #123456",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "66d31527-ab99-4909-b8cc-77f26577c6e7",
    "tag": null,
    "amount": "123.12",
    "received": "100.32",
    "paymentTolerancePercent": "1.5",
    "successWebhook": "https://merchant.domain/webhooks/success",
    "errorWebhook": "https://merchant.domain/webhooks/fail",
    "returnUrl": "https://merchant.domain/",
    "link": "https://payment.domain/1f627ca9-009d-47e9-9873-40920fe8c9cf",
    "expiresAt": "2024-12-11T11:24:03.327Z",
    "createdAt": "2024-12-11T10:54:03.327Z",
    "updatedAt": "2024-12-11T10:54:03.327Z",
    "transactions": [
      {
        "id": "12df0273-01d5-4480-9c2e-2aa1b43aef78",
        "status": "processed",
        "currency": "USDT",
        "network": "ethereum",
        "amount": "100.32",
        "tx": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
        "confirmations": 0,
        "sender": "0x00000005707bf50efa35a2db020ede9ac08ae226",
        "priceUSD": "2000",
        "amountUSD": "100"
      }
    ],
    "orphanDeposits": [
      {
        "id": "95b32a3b-5058-40b0-ba39-ed4682bec2a9",
        "organizationId": "dcde70b7-e684-434f-9a7c-377d2010e66e",
        "orderId": "1f627ca9-009d-47e9-9873-40920fe8c9cf",
        "stage": "WITHDRAWAL",
        "status": "PENDING",
        "currency": "BUSD",
        "network": "bsc",
        "amount": "200",
        "canWithdrawal": false,
        "inTransaction": {
          "addressType": "PAY_IN",
          "addressId": "66d31527-ab99-4909-b8cc-77f26577c6e7",
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed"
        },
        "outTransactions": {
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed",
          "feeAmount": "1.2",
          "feeAmountUSD": "1.22",
          "withdrawalId": "cb65d6c9-6dd4-4be9-9193-899757e57125",
          "createdAt": "2024-12-12T10:54:03.328Z"
        },
        "createdAt": "2024-12-11T10:54:03.328Z"
      }
    ]
  }
}