История выплат
post
https://api.cryptomus.com/v1/payout/list
Запрос
Параметры запроса
| Имя | Тип параметра | Значение по умолчанию | Описание |
|---|---|---|---|
| date_from | stringformat: YYYY-MM-DD H:mm:ss | null | Фильтрация по дате создания, от |
| date_to | stringformat: YYYY-MM-DD H:mm:ss | null | Фильтрация по дате создания, до |
Тип параметра
stringformat: YYYY-MM-DD H:mm:ssОписание
Фильтрация по дате создания, отТип параметра
stringformat: YYYY-MM-DD H:mm:ssОписание
Фильтрация по дате создания, до
Пример запроса
curl https://api.cryptomus.com/v1/payout/list \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: f80fa426a89eb62bd53997326865d850' \
-H 'Content-Type: application/json'
Отфильтровать выплаты по дате создания с 4 по 16 мая.
curl https://api.cryptomus.com/v1/payout/list \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: f80fa426a89eb62bd53997326865d850' \
-H 'Content-Type: application/json' \
-d '{
"date_from": "2023-05-04 00:00:00"
"date_to": "2023-05-16 23:59:59"
}'Ответ
Параметры отклика
| Имя | Описание |
|---|---|
| merchant_uuid | Uuid мерчанта |
| items | Массив выплат. Структура |
| paginate | Данные для разбивки на страницы. Структура |
Структура пункт
| Имя | Описание |
|---|---|
| uuid | uuid выплаты |
| amount | Сумма выплаты в currency |
| currency | Код валюты для выплаты |
| network | Код блокчейн-сети, в которой производится выплата |
| address | Адрес кошелька, на который производится платеж |
| txid | Идентификатор транзакции в блокчейне |
| status | Статус выплаты статусы |
| is_final | Завершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты. |
| balance | Оставшиеся средства на кошельке продавца. |
| created_at | Дата создания выплаты. Часовой пояс - UTC+3 |
| updated_at | Дата последней выплаты обновлена. Часовой пояс - UTC+3 |
Описание
uuid выплатыОписание
Сумма выплаты в currencyОписание
Код валюты для выплатыОписание
Код блокчейн-сети, в которой производится выплатаОписание
Адрес кошелька, на который производится платежОписание
Идентификатор транзакции в блокчейнеОписание
Статус выплаты статусыОписание
Завершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.Описание
Оставшиеся средства на кошельке продавца.Описание
Дата создания выплаты. Часовой пояс - UTC+3Описание
Дата последней выплаты обновлена. Часовой пояс - UTC+3
Чтобы получить записи следующей/предыдущей страницы, укажите хэш следующего/предыдущего курсора в параметрах запроса (?cursor=nextCursorHash)
Пример:
1curl https://api.cryptomus.com/v1/payout/list?cursor=eyJpZCI6MjEyLCJf cG9pbnRzVzVG9OZXh0SXRlbXMiOnRydWV9 \
2-X POST \
3-H 'merchant: cb2131ff-a3d4-46dd-94c6-3714fae65f89' \
4-H 'sign: f80fa426a89eb62bd53997326865d850' \
5-H 'Content-Type: application/json' \
6Пример ответа
1{
2"state": 0,
3"result": {
4 "items": [{
5 "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
6 "amount": "3",
7 "currency": "USDT",
8 "network": "TRON",
9 "address": "TJ...",
10 "txid": null,
11 "status": "process",
12 "is_final": false,
13 "balance": "129.00000000",
14 "created_at": "2023-06-21T17:25:55+03:00",
15 "updated_at": "2023-06-21T17:34:38+03:00"
16 }, {
17 "uuid": "92c39264-d180-4503-9c16-ee16f083bbb8",
18 "amount": "5.40000000",
19 "currency": "DOGE",
20 "network": "doge",
21 "address": "DEw8CJLfxg9fhumeXP1zvVNjZicsqtDv7V",
22 "txid": "5e5810946152ea569d2a2aa9aa32a45c0e4223a4f9aad8e31d2fc660d2cdedb8",
23 "order_id": null,
24 "payment_status": null,
25 "status": "paid",
26 "is_final": true,
27 "balance": "26.77966652",
28 "created_at": "2023-07-21T17:25:55+03:00",
29 "updated_at": "2023-07-21T17:34:38+03:00"
30 },
31 ...
32 ],
33 "paginate": {
34 "count": 15,
35 "hasPages": true,
36 "nextCursor": "eyJpZCI6MjkxNTU0MywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
37 "previousCursor": null,
38 "perPage": 15
39 }
40}
41}Возможные ошибки
Ошибки проверки
код : 422
Примеры ответов:
Если параметр date_from или date_to передан в неправильном формате.
1{
2 "state": 1,
3 "errors": {
4 "date_from": ["validation.regex"]
5 }
6}