Поиск операции по TX-хешу

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

В ответе будет указан тип операции, направление транзакции, адрес, который использовался для операции и тело операции в записимости от типа

Доступные типы операций:

Тип	Описание
ORDER	Адрес транзакции был найден во входящих транзакциях ордера
INVOICE	Адрес транзакции был найден во входящих транзакциях ордера созданного для исполнения счета
ORPHAN_TRANSACTION	Адрес транзакции был во входящих транзакция адреса созданного для иной монеты или сети
WITHDRAWAL	Адрес транзакции был найден среди операций вывода
DEPOSIT	Адрес транзакции был найден во входящих транзакция адреса как "свободное пополнение"
PERSONAL_DEPOSIT	Адрес транзакции был найден во входящих транзакциях по адресу системы "персональных адресов пользователей"

Доступные направления транзакций:

Направление	Описание
IN	Входящая транзакция
OUT	Исходящая транзакция

Пример тела адреса:

{
  "id": "cf95ea41-20c5-4528-b689-c21f4da6359f", // идентификатор адреса
  "type": "PAY_IN" // тип адреса: PAY_IN, PERSONAL, PAY_OUT, BUSINESS, RECURRENT
}

В теле результата модет быть несколько записей, поэтому результат представлен в виде массива:

Пример тела ответа:

{
  "success": true,
  "response": [
    {
      "type": "OUT",
      "source": "WITHDRAWAL",
      "address": {
        ... // тело адреса
      },
      "result": {
        ... // тело для WITHDRAWAL
      }
    },
    {
      "type": "IN",
      "source": "DEPOSIT",
      "address": {
        ... // тело адреса
      },
      "result": {
        ... // тело для DEPOSIT 
      }
    }
  ]
}

---

Пример тела операции PERSONAL_DEPOSIT:

{                                                       // тело идентично телу отправляемому в вебхуке
  "id": "2fa68ddf-2479-47cb-9e66-ae91139c3063",         // идентификатор персонального депозита
  "addressId": "dcb1a9fe-4b8d-40f6-baf6-241dc88436d9",  // идентификатор адреса получателя
  "userId": "6196a1f2-b6b5-40a5-a672-f1ffd70fdd7d",     // идентификатор пользователя в системе для которого был создан адрес
  "amount": "0.005",                                    // сумма депозита
  "currency": "USDT",                                   // монета депозита
  "addressFrom": ["0x....", "0x...."],                  // массив адресов отправителей
  "addressTo": "0x....",                                // адрес получатель
  "network": "bsc",                                     // сети депозита
  "status": "PROCESSED",                                // статус, доступные значение: PROCESSED
  "tx": "0x5b9b3b55b366266025e...",                        // адрес транзакции в блокчейне
  "createdAt": "2023-03-02T06:58:00.365Z",
  "updatedAt": "2023-03-02T07:01:50.693Z"
}

---

Пример тела операции DEPOSIT:

{                                                       // тело идентично телу отправляемому в вебхуке
  "id": "2fa68ddf-2479-47cb-9e66-ae91139c3063",         // идентификатор записи
  "status": "processed",                                // статус, доступные значение: processed, error, rejected, pending
  "addressType": "BUSINESS",                            // тип адреса: PAY_IN, PERSONAL, PAY_OUT, BUSINESS, RECURRENT
  "addressFrom": "0x5b9b3b55b366266025e...",            // адреса отправителя в блокчейне
  "addressTo": "0x3f4e3d79a244189e25e...",              // адрес получателя в блокчейне
  "type": "deposit",                                    // тип операции: withdrawal, deposit
  "amount": "0.005",                                    // сумма депозита
  "currency": "USDT",                                   // монета депозита
  "network": "bsc",                                     // сети депозита
  "txId": "0x5b9b3b55b366266025e...",                   // адрес транзакции в блокчейне
  "alias": "My address",                                // имя адреса указанное при создании
  "comment": null,                                      // комментарий к операции
  "createdAt": "2023-03-02T06:58:00.365Z",
  "updatedAt": "2023-03-02T07:01:50.693Z"
}

---

Пример тела операции WITHDRAWAL:

{                                                               // тело ответа идентично телу ответа при получении данных вывода
  "id": "2a2d464b-231a-baf3-6f8a-7b9dc0f8cef7",                 // идентификатор вывода в системе
  "advancedBalanceId": "017f444f-a6ce-487f-0f80-9777199a6ff5",  // идентификатор авансого баланса
  "addressId": "5bcb11d2-cfe8-3a09-0c51-dd7be7243c5d",          // идентификатор адреса отправителя
  "currency": "ETH",                                            // монета отправки
  "network": "ethereum",                                        // сеть отправки
  "tx": "0x00000000000000000000c8950e52aa3...",                 // адрес транзакции в блокчейне
  "status": "processed",                                        // статус вывода: init, error, pending, processed, rejected
  "address": "0x000000000c8950e52aa315030efedc861da658e2",      // адрес получателя в блокчейне
  "tag": null,
  "amount": "2.12345",                                          // сумма вывода
  "feeAmount": "0.005",                                         // сумма комиссии
  "createdAt": "2023-03-02T07:01:50.693Z"
}

---

Пример тела операции ORDER:

{                                                               // тело ответа идентично телу ответа запроса получения информации об ордере
  "id": "d01d03e2-15dc-b03a-b34e-46cad2345b92",                 // ид ордера
  "advancedBalanceId": "c6e7d8dc-ce10-637d-147b-2dda3015b8a4",  // ид авансового баланса
  "currency": "ETH",                                            // монета оплаты
  "network": "etehereum",                                       // сеть оплаты
  "link": "https://payment.domain/...",                         // ссылка на оплату
  "status": "processed",                                        // статус: init, error, processed, pending, expired, partial
  "order": "#123456789",
  "description": "Order #123456789",
  "address": "0x000000000c8950e52aa315030efedc861da658e2",      // адрес для приема оплаты
  "addressId": "8eae79cf-1db2-4858-9023-aca473d805e2",          // ид адреса в сисетеме
  "tag": null,                                                  // тег адреса
  "amount": "0.84",                                             // сумма к оплате
  "received": "0.86",                                           // полученная сумма
  "transactions": [
    {
      "id": "f0b22f11-007c-4f65-bb9b-265432ab64c3",
      "status": "processed",
      "currency": "BNB",
      "network": "bsc",
      "amount": "0.0001",
      "tx": "0x8fb0d40678d1bb4b6c0b2095c18d9280aa8ccf966e778e6b209f4f71c7f1e835",
      "confirmations": "15",
      "sender": "0xcD62a4E08513f16F86C1c0AF0860DD6b3De1B83d",
      "priceUSD": "212.90000000",
      "amountUSD": "0.02129"
    },
    {
      "id": "a2a7ed3b-a8af-42c4-900c-d21e1d9eda3c",
      "status": "processed",
      "currency": "BNB",
      "network": "bsc",
      "amount": "0.0006",
      "tx": "0x60032c394fcc7a103bc2826f9b81e5086be90628331e1ce163e1c576c64baf06",
      "confirmations": "15",
      "sender": "0x54936CE809bBccC7f1378c7ec88F5504cE49605C",
      "priceUSD": "212.70000000",
      "amountUSD": "0.12762"
    }
  ],
  "orphanDeposits": [
    {
      "id": "7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1",
      "organizationId": "1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39",
      "orderId": "d01d03e2-15dc-b03a-b34e-46cad2345b92",
      "stage": "WITHDRAWAL",
      "status": "PROCESSED",
      "message": null,
      "currency": "BNB",
      "network": "bsc",
      "amount": "0.00000001",
      "canWithdrawal": true,
      "inTransaction": {
        "addressType": "PAY_IN",
        "addressId": "8519ba89-68d5-4914-9a0f-d99e77dc88ea",
        "address": "0x68f8a74b5fD0b687369536607214acfA3b1572Ff",
        "txId": "0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362",
        "amount": "0.00000001",
        "status": "processed",
        "createdAt": "2023-05-30T14:10:27.276Z"
      },
      "outTransaction": {
        "withdrawalId": "4429ba89-68d5-4914-9a0f-d99e77dc88ea",
        "address": "0x68f8a74b5fD0b687369536607214acfA3b1572Ff",
        "txId": "0x5511285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362",
        "amount": "0.00000001",
        "status": "processed",
        "createdAt": "2023-05-30T14:10:27.276Z"
      },
      "createdAt": "2023-05-30T14:10:27.283Z"
    }
  ],
  "successWebhook": "https://example.com/success-webhook-url",
  "errorWebhook": "https://example.com/error-webhook-url",
  "returnUrl": "null",
  "expiresAt": "2021-05-23T15:00:00Z",
  "createdAt": "2021-05-23T15:00:00Z",
  "updatedAt": "2021-05-23T15:00:00Z"
}

---

Пример тела операции INVOICE:

{ // тело ответа идентично телу ответа запроса получения данных счета
  "id": "fe31e1f3-bd23-4c89-bced-7fecc60cbb34", // ID счета
  "advancedBalanceId": "1cabe6ba-52b8-42bf-88a4-b3c953c3fd36", // ID авансового баланса
  "orderId": "ae31e1f3-bd23-4c89-bced-7fecc60cbb31", // ID ордера (до статуса INIT будет null)
  "orderLink": "https://payment.domain/...", // ссылка на ордер (до статуса INIT будет null)
  "invoiceLink": "https://invoices.domain/...", // ссылка счета
  "status": "PENDING", // статус счета (CREATED - создан, INIT - выбрана монета для оплаты, PENDING - пользователь сделал транзакцию, PROCESSED - оплачен, PARTIAL - частичная оплата, ERROR - ошибка, EXPIRED - срок жизни счета истек)
  "order": "Order #1234",
  "description": "Buy 1 Bitcoin",
  "currency": "USD",
  "amount": "3000",
  "receivedCurrency": "USDT", // выбраная монета для оплаты (до статуса INIT будет null)
  "receivedAmount": "123", // полученная сумма
  "includeFee": true,
  "insurancePercent": "2",
  "slippagePercent": "3.5",
  "webhookURL": "https://my-shop.com/api/webhooks",
  "returnURL": "https://my-shop.com/",
  "currencies": [
    {
      "currency": "USDT",
      "networks": [
        {
          "name": "tron",
          "amount": "3030.123" // конечная сумма к оплате для USDT в сети tron
        },
        {
          "name": "bsc",
          "amount": "3030.123"
        }
      ]
    }
  ],
  "expiresAt": "2022-12-16T08:36:38.130Z",
  "createdAt": "2022-12-16T07:36:38.130Z"
}

---

Пример тела операции ORPHAN_DEPOSIT:

{ // тело ответа идентично телу ответа запроса получения данных депозита
  "id": "7cd20ea9-0e2c-46c5-8e12-82b0485d5ba1",
  "organizationId": "1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39",
  "orderId": "4db8ba00-20f8-4e3f-8292-301dd66618af",
  "stage": "WITHDRAWAL",
  "status": "PROCESSED",
  "message": null,
  "currency": "BNB",
  "network": "bsc",
  "amount": "0.00000001",
  "canWithdrawal": true,
  "inTransaction": {
    "addressType": "PAY_IN",
    "addressId": "8519ba89-68d5-4914-9a0f-d99e77dc88ea",
    "address": "0x68f8a74b5fD0b687369536607214acfA3b1572Ff",
    "txId": "0x6751285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362",
    "amount": "0.00000001",
    "status": "processed",
    "createdAt": "2023-05-30T14:10:27.276Z"
  },
  "outTransaction": {
    "withdrawalId": "4429ba89-68d5-4914-9a0f-d99e77dc88ea",
    "address": "0x68f8a74b5fD0b687369536607214acfA3b1572Ff",
    "txId": "0x5511285829e38b1bb53d1df887dde750182f08e230b58a5a2d3e867ba7327362",
    "amount": "0.00000001",
    "status": "processed",
    "createdAt": "2023-05-30T14:10:27.276Z"
  },
  "createdAt": "2023-05-30T14:10:27.283Z"
}

Поиск операции по TX-хешу

post

Header parameters

x-api-public-keystringOptional

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

x-api-signaturestringOptional

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

Content-typestringOptional

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

Example: application/json

Body

Тело запроса поиска операций по tx-хешу

txstringOptional

Идентификатор транзакции в блокчейне

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/find-tx HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 9

{
  "tx": ""
}

200Success

{
  "success": true,
  "response": [
    {
      "type": "IN",
      "source": "ORDER",
      "address": "",
      "result": {
        "id": "fb353f4e-9d5e-43d5-b3c2-9c9057236ce8",
        "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
        "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
        "currency": "USDT",
        "network": "ethereum",
        "tx": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
        "status": "pending",
        "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
        "tag": null,
        "amount": "123.12",
        "feeCurrency": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
        "feeSource": "advanced_balance",
        "feeAmount": "1.12",
        "createdAt": "2024-12-26T08:21:33.209Z"
      }
    }
  ]
}