Список платежей

Описание

Сервис автоматически ищет все платежи, поступающие на ваши крипто кошельки, но только при наличии счетов, по которым еще ведется поиск. Поиск ведется, пока счет актуален, и продолжается еще один час после истечения срока оплаты — с учетом медленных сетей. Если таких счетов нет, входящая транзакция в систему не попадет.

Запрос

curl -X POST https://api.bitsby.app/payments/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
	-F "startDate=2000-01-01" \
	-F "endDate=2030-01-01" \
	-F "offset=0" \
	-F "limit=10"

Параметры запроса

Параметр	Тип данных	Описание	Пример	Обязательный?	По умолчанию
walletId	UUID	ID кошелька в формате UUID	1c48b092-9878-48f5-b441-07a8a48e7b54	нет
invoiceId	UUID	ID счета в формате UUID	1c48b092-9878-48f5-b441-07a8a48e7b54	нет
startDate	String	Начальная дата транзакции в блокчейне в формате Y-m-d	2000-01-01	нет
endDate	String	Конечная дата транзакции в блокчейне в формате Y-m-d	2030-01-01	нет
offset	Integer	Номер начальной записи, с которой начнется вывод данных	0	нет	0
limit	Integer	Количество записей, которые вы хотите получить	50	нет	10

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

Платеж, который уже связан со счетом:

{
   "result":"success",
   "data":[
      {
         "id":"f986ad8d-2298-473d-982a-efbc817b975d",
         "amount":12,
         "hash":"f09352627039c088688806821b864895ff237558612d834861621fc026de5f68",
         "transactionDatetime":"2024-02-27 21:05:36",
         "invoice":{
            "id":"f31c61f6-407f-4999-95cf-56477eff06d4",
            "uid":"riUZBnNvd2rX",
            "projectId":"9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime":"2024-02-27 20:57:23",
            "timeToPayDatetime":"2024-02-28 08:57:23",
            "commissionFiatUSD":0.12,
            "amountFiatUSD":12,
            "amountFiat":12,
            "currencyFiat":"USD",
            "description":null,
            "serviceData":"orderId:2444",
            "views":1,
            "status":"paid"
         },
         "wallet":{
            "id":"47aa71e2-07a0-482e-9172-7114d7376ba0",
            "name":"usdt-tron",
            "blockchain":"tron",
            "cryptocurrency":"usdt",
            "address":"TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
         }
      },
      {
         "id":"f3195184-9a6f-4c82-928b-d7fe7c015b7b",
         "amount":5.02,
         "hash":"74763b65e43bcc9492a6ce9a7f26fbfdbd7635aecd3454420b5e9534cba50ee6",
         "transactionDatetime":"2024-02-26 13:32:57",
         "invoice":{
            "id":"fac8ef03-2c41-4ce0-a432-7c33b928f16f",
            "uid":"AFhygKX21ecd",
            "projectId":"9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime":"2024-02-26 13:29:24",
            "timeToPayDatetime":"2024-02-27 01:29:24",
            "commissionFiatUSD":0.05,
            "amountFiatUSD":5.02, 
            "amountFiat":5,
            "currencyFiat":"USD",
            "description":null,
            "serviceData":"orderId:3419",
            "views":3,
            "status":"paid"
         },
         "wallet":{
            "id":"47aa71e2-07a0-482e-9172-7114d7376ba0",
            "name":"usdt-tron",
            "blockchain":"tron",
            "cryptocurrency":"usdt",
            "address":"TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
         }
      }
   ]
}

Платеж, который сервис нашел, но еще не связал со счетом, приходит без блока invoice. Такие платежи и являются кандидатами на ручную привязку:

{
   "result":"success",
   "data":[
      {
         "id":"c1d0f4a2-93b7-4f61-8c25-1a6f0e2b7d94",
         "amount":9.87,
         "hash":"5b1e4b1cf0a4c3d2e9f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f708192",
         "transactionDatetime":"2024-02-28 09:14:02",
         "wallet":{
            "id":"47aa71e2-07a0-482e-9172-7114d7376ba0",
            "name":"usdt-tron",
            "blockchain":"tron",
            "cryptocurrency":"usdt",
            "address":"TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
         }
      }
   ]
}

Параметры ответа

Параметр	Описание
id	ID платежа в формате UUID
amount	Сумма платежа в криптовалюте
hash	Хэш транзакции в блокчейне
transactionDatetime	Дата и время транзакции в блокчейне (UTC)
invoice	Раздел, содержащий параметры счета. Отображается в случае, если к платежу привязан счет
invoice.id	ID счета в формате UUID
invoice.uid	ID счета (для покупателя)
invoice.projectId	ID проекта в формате UUID
invoice.createDatetime	Дата и время создания счета (UTC)
invoice.timeToPayDatetime	Дата и время, до которого действителен счет (UTC)
invoice.commissionFiatUSD	Сумма комиссии сервиса. Рассчитывается относительно суммы invoice.amountFiatUSD
invoice.amountFiatUSD	Сумма счета, приведенная к USD. При создании счета рассчитывается по текущему курсу относительно суммы invoice.amountFiat. В момент оплаты перезаписывается фактически поступившей суммой, приведенной к USD по курсу на этот момент. От нее же пересчитывается комиссия в invoice.commissionFiatUSD
invoice.amountFiat	Оригинальная сумма счета в фиатной валюте. Не меняется
invoice.currencyFiat	Валюта фиата
invoice.description	Описание, которое было задано при создании счета
invoice.serviceData	Служебные данные, которые были заданы при создании счета
invoice.views	Количество просмотров платежной страницы
invoice.status	Статус счета
wallet	Раздел, содержащий параметры кошелька
wallet.id	ID кошелька в формате UUID
wallet.name	Название кошелька
wallet.blockchain	Блокчейн крипто кошелька
wallet.cryptocurrency	Криптовалюта кошелька
wallet.address	Адрес крипто кошелька