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

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

Order information request body

orderIdstringOptional

Order ID in the system

Example: a9236d98-9d22-4495-b387-cfa72b45b0d8

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/order HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "orderId": "a9236d98-9d22-4495-b387-cfa72b45b0d8"
}

200Success

{
  "success": true,
  "response": {
    "id": "a9236d98-9d22-4495-b387-cfa72b45b0d8",
    "advancedBalanceId": "d464decd-5cc8-42de-8f57-c55a862d0e87",
    "currency": "USDT",
    "network": "ethereum",
    "status": "pending",
    "orderId": "Order #123456",
    "description": "Payment by order #123456",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "4b40f3ab-687b-48b5-bd67-0e76b189ea3c",
    "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/a9236d98-9d22-4495-b387-cfa72b45b0d8",
    "expiresAt": "2025-05-14T14:20:31.648Z",
    "createdAt": "2025-05-14T13:50:31.648Z",
    "updatedAt": "2025-05-14T13:50:31.648Z",
    "transactions": [
      {
        "id": "ee9c0f05-c910-4465-a6d4-bc79810ec263",
        "status": "processed",
        "currency": "USDT",
        "network": "ethereum",
        "amount": "100.32",
        "tx": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
        "confirmations": 1,
        "sender": "0x00000005707bf50efa35a2db020ede9ac08ae226",
        "priceUSD": "2000",
        "amountUSD": "100"
      }
    ],
    "orphanDeposits": [
      {
        "id": "7de0a04c-8d60-4291-83e9-b752bf47ed68",
        "organizationId": "d464decd-5cc8-42de-8f57-c55a862d0e87",
        "orderId": "a9236d98-9d22-4495-b387-cfa72b45b0d8",
        "stage": "WITHDRAWAL",
        "status": "PENDING",
        "message": null,
        "currency": "BUSD",
        "network": "bsc",
        "amount": "200",
        "canWithdrawal": true,
        "inTransaction": {
          "addressType": "PAY_IN",
          "addressId": "4b40f3ab-687b-48b5-bd67-0e76b189ea3c",
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed"
        },
        "outTransactions": {
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed",
          "feeAmount": "1.2",
          "feeAmountUSD": "1.22",
          "withdrawalId": "0e954625-4a9e-4363-a225-33107618fa87",
          "createdAt": "2025-05-15T13:50:31.648Z"
        },
        "createdAt": "2025-05-14T13:50:31.648Z"
      }
    ]
  }
}