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://app.apollopayment.io/api-gateway/order

Header parameters

Body

application/json

orderIdstring

Order ID in the system

Example: "c4f1e9ad-895c-4250-b5e0-e261f1ab79e5"

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://app.apollopayment.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": "c4f1e9ad-895c-4250-b5e0-e261f1ab79e5",
    "advancedBalanceId": "0535cf62-7de6-460b-a0ad-45ac93dfa915",
    "currency": "USDT",
    "network": "ethereum",
    "status": "pending",
    "orderId": "Order #123456",
    "description": "Payment by order #123456",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "d974910c-9f67-4681-bf33-5a10b645402f",
    "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/c4f1e9ad-895c-4250-b5e0-e261f1ab79e5",
    "expiresAt": "2024-11-07T13:12:22.639Z",
    "createdAt": "2024-11-07T12:42:22.639Z",
    "updatedAt": "2024-11-07T12:42:22.639Z",
    "transactions": [
      {
        "id": "8cdc1a4d-1420-4823-8182-84e8e384ba6c",
        "status": "processed",
        "currency": "USDT",
        "network": "ethereum",
        "amount": "100.32",
        "tx": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
        "sender": "0x00000005707bf50efa35a2db020ede9ac08ae226",
        "priceUSD": "2000",
        "amountUSD": "100"
      }
    ],
    "orphanDeposits": [
      {
        "id": "2a814287-50e8-40cd-b424-8ce959cdf280",
        "organizationId": "0535cf62-7de6-460b-a0ad-45ac93dfa915",
        "orderId": "c4f1e9ad-895c-4250-b5e0-e261f1ab79e5",
        "stage": "WITHDRAWAL",
        "status": "PENDING",
        "currency": "BUSD",
        "network": "bsc",
        "amount": "200",
        "canWithdrawal": false,
        "inTransaction": {
          "addressType": "PAY_IN",
          "addressId": "d974910c-9f67-4681-bf33-5a10b645402f",
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed"
        },
        "outTransactions": {
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed",
          "feeAmount": "1.2",
          "feeAmountUSD": "1.22",
          "withdrawalId": "fd562f1b-afe2-4e7d-b3e8-71c7e4b86542",
          "createdAt": "2024-11-08T12:42:22.639Z"
        },
        "createdAt": "2024-11-07T12:42:22.639Z"
      }
    ]
  }
}