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: "c74ff3eb-5732-4ff5-be31-a03ef7f7f237"

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": "c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
    "advancedBalanceId": "882f4ed6-82c8-43c3-8dd6-d755cee5f1af",
    "currency": "USDT",
    "network": "ethereum",
    "status": "pending",
    "orderId": "Order #123456",
    "description": "Payment by order #123456",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "7504dcc8-e87e-4dce-862f-0a9b765bfbda",
    "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/c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
    "expiresAt": "2024-11-07T13:11:09.821Z",
    "createdAt": "2024-11-07T12:41:09.821Z",
    "updatedAt": "2024-11-07T12:41:09.821Z",
    "transactions": [
      {
        "id": "43844cdf-0f04-45d0-a8d5-7036e5bd05f4",
        "status": "processed",
        "currency": "USDT",
        "network": "ethereum",
        "amount": "100.32",
        "tx": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
        "sender": "0x00000005707bf50efa35a2db020ede9ac08ae226",
        "priceUSD": "2000",
        "amountUSD": "100"
      }
    ],
    "orphanDeposits": [
      {
        "id": "70a02878-dea2-4cdf-a8a8-3ca81a0067cb",
        "organizationId": "882f4ed6-82c8-43c3-8dd6-d755cee5f1af",
        "orderId": "c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
        "stage": "WITHDRAWAL",
        "status": "PENDING",
        "currency": "BUSD",
        "network": "bsc",
        "amount": "200",
        "canWithdrawal": false,
        "inTransaction": {
          "addressType": "PAY_IN",
          "addressId": "7504dcc8-e87e-4dce-862f-0a9b765bfbda",
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed"
        },
        "outTransactions": {
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed",
          "feeAmount": "1.2",
          "feeAmountUSD": "1.22",
          "withdrawalId": "2fa7bb7e-8d51-4c2c-8b53-ec90080970bf",
          "createdAt": "2024-11-08T12:41:09.821Z"
        },
        "createdAt": "2024-11-07T12:41:09.821Z"
      }
    ]
  }
}