Получение информации об ордере

Метод позволяет получить информацию по ранее созданному ордеру по его идентификатору в системе

Получение информации об ордере

post

/api-gateway/order

Header parameters

x-api-public-keystring

Публичный API-ключ

x-api-signaturestring

Подпись тела запроса приватным API-ключем

Content-typestring

Тип тела запроса

Example: application/json

Body

orderIdstring

Идентификатор ордера в системе

Example: a7ff7a80-dd8e-40e7-a262-4599b007211b

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/order' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderId": "a7ff7a80-dd8e-40e7-a262-4599b007211b"
  }'

200

200

{
  "success": true,
  "response": {
    "id": "a7ff7a80-dd8e-40e7-a262-4599b007211b",
    "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
    "currency": "USDT",
    "network": "ethereum",
    "status": "pending",
    "orderId": "Order #123456",
    "description": "Payment by order #123456",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
    "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/a7ff7a80-dd8e-40e7-a262-4599b007211b",
    "expiresAt": "2024-12-26T08:51:33.210Z",
    "createdAt": "2024-12-26T08:21:33.210Z",
    "updatedAt": "2024-12-26T08:21:33.210Z",
    "transactions": [
      {
        "id": "2b84d277-c644-435f-a364-7d2ece3dce6d",
        "status": "processed",
        "currency": "USDT",
        "network": "ethereum",
        "amount": "100.32",
        "tx": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
        "confirmations": 1,
        "sender": "0x00000005707bf50efa35a2db020ede9ac08ae226",
        "priceUSD": "2000",
        "amountUSD": "100"
      }
    ],
    "orphanDeposits": [
      {
        "id": "4c91e826-19eb-4cbe-9479-8719316b500f",
        "organizationId": "1503cf18-597f-447f-b172-112dfe377e1b",
        "orderId": "a7ff7a80-dd8e-40e7-a262-4599b007211b",
        "stage": "WITHDRAWAL",
        "status": "PENDING",
        "message": null,
        "currency": "BUSD",
        "network": "bsc",
        "amount": "200",
        "canWithdrawal": true,
        "inTransaction": {
          "addressType": "PAY_IN",
          "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed"
        },
        "outTransactions": {
          "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
          "txId": "0x123456...",
          "amount": "200",
          "status": "processed",
          "feeAmount": "1.2",
          "feeAmountUSD": "1.22",
          "withdrawalId": "54f31a93-3d02-457a-9e5e-4a1cf6ee257f",
          "createdAt": "2024-12-27T08:21:33.210Z"
        },
        "createdAt": "2024-12-26T08:21:33.210Z"
      }
    ]
  }
}