История выплат
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Значение по умолчанию
nullОписание
Фильтрация по дате создания, отТип параметра
stringformat: YYYY-MM-DD H:mm:ssЗначение по умолчанию
nullОписание
Фильтрация по дате создания, до
Пример запроса
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 | string | Uuid мерчанта |
| items | Массив выплат. Структура | |
| paginate | Данные для разбивки на страницы. Структура |
Тип параметра
stringОписание
Uuid мерчанта
Структура пункт
| Имя | Тип параметра | Описание |
|---|---|---|
| uuid | string | uuid выплаты |
| amount | string | Сумма выплаты в currency |
| currency | string | Код валюты для выплаты |
| network | string|null | Код блокчейн-сети, в которой производится выплата |
| payer_currency | string|null | Код криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты. |
| payer_amount | string|null | Сумма выплаты в payer_currency. |
| address | string | Адрес кошелька, на который производится платеж |
| txid | string|null | Идентификатор транзакции в блокчейне |
| status | string | Статус выплаты статусы |
| payment_status | string | Статус платежа |
| is_final | boolean | Завершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты. |
| balance | string|null | Оставшиеся средства на кошельке продавца. |
| order_id | string|null | Идентификатор заказа в Вашей системе |
| commission | string|null | Сумма комиссии Cryptomus |
| merchant_amount | string|null | Сумма, которая списывается с баланса продавца, включая все комиссии. |
| created_at | string|null | Дата создания выплаты. Часовой пояс - UTC+3 |
| updated_at | string|null | Дата последней выплаты обновлена. Часовой пояс - UTC+3 |
| convert | Информация о валюте, в которую будет автоматически конвертирован платеж. Конвертация производится из payer_currency в USDTПрисутствует, если передан параметр from_currency. | |
| convert.to_currency | string|null | Код валюты, в которую будет конвертирован платеж |
| convert.from_currency | string | Из валюты |
| convert.commission | string | Комиссия за конвертацию |
| convert.rate | string|null | Коэффициент конверсии |
| convert.from_amount | string|null | Сумма от |
Тип параметра
stringОписание
uuid выплатыТип параметра
stringОписание
Сумма выплаты в currencyТип параметра
stringОписание
Код валюты для выплатыТип параметра
string|nullОписание
Код блокчейн-сети, в которой производится выплатаТип параметра
string|nullОписание
Код криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты.Тип параметра
string|nullОписание
Сумма выплаты в payer_currency.Тип параметра
stringОписание
Адрес кошелька, на который производится платежТип параметра
string|nullОписание
Идентификатор транзакции в блокчейнеТип параметра
stringТип параметра
stringОписание
Статус платежаТип параметра
booleanОписание
Завершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.Тип параметра
string|nullОписание
Оставшиеся средства на кошельке продавца.Тип параметра
string|nullОписание
Идентификатор заказа в Вашей системеТип параметра
string|nullОписание
Сумма комиссии CryptomusТип параметра
string|nullОписание
Сумма, которая списывается с баланса продавца, включая все комиссии.Тип параметра
string|nullОписание
Дата создания выплаты. Часовой пояс - UTC+3Тип параметра
string|nullОписание
Дата последней выплаты обновлена. Часовой пояс - UTC+3Описание
Информация о валюте, в которую будет автоматически конвертирован платеж. Конвертация производится из payer_currency в USDTПрисутствует, если передан параметр from_currency.Тип параметра
string|nullОписание
Код валюты, в которую будет конвертирован платежТип параметра
stringОписание
Из валютыТип параметра
stringОписание
Комиссия за конвертациюТип параметра
string|nullОписание
Коэффициент конверсииТип параметра
string|nullОписание
Сумма от
Чтобы получить записи следующей/предыдущей страницы, укажите хэш следующего/предыдущего курсора в параметрах запроса (?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 "merchant_uuid": "8b03432e-385b-4670-8d06-064591096795",
5 "items": [{
6 "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
7 "amount": "3",
8 "currency": "USDT",
9 "network": "TRON",
10 "payer_currency": "USDT",
11 "payer_amount": "3",
12 "address": "TJ...",
13 "txid": null,
14 "status": "process",
15 "payment_status": "process",
16 "is_final": false,
17 "balance": "129.00000000",
18 "order_id": "1",
19 "commission": null,
20 "merchant_amount": null,
21 "created_at": "2023-06-21T17:25:55+03:00",
22 "updated_at": "2023-06-21T17:34:38+03:00"
23 }, {
24 "uuid": "92c39264-d180-4503-9c16-ee16f083bbb8",
25 "amount": "5.40000000",
26 "currency": "DOGE",
27 "network": "doge",
28 "payer_currency": "DOGE",
29 "payer_amount": "5.40000000",
30 "address": "DEw8CJLfxg9fhumeXP1zvVNjZicsqtDv7V",
31 "txid": "5e5810946152ea569d2a2aa9aa32a45c0e4223a4f9aad8e31d2fc660d2cdedb8",
32 "status": "paid",
33 "payment_status": "paid",
34 "is_final": true,
35 "balance": "26.77966652",
36 "order_id": null,
37 "commission": "0.00000000",
38 "merchant_amount": "5.40000000",
39 "created_at": "2023-07-21T17:25:55+03:00",
40 "updated_at": "2023-07-21T17:34:38+03:00"
41 },
42 ...
43 ],
44 "paginate": {
45 "count": 15,
46 "hasPages": true,
47 "nextCursor": "eyJpZCI6MjkxNTU0MywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
48 "previousCursor": null,
49 "perPage": 15
50 }
51}
52}СкопироватьВозможные ошибки
Ошибки проверки
код : 422
примеры ответов:
Если параметр date_from или date_to передан в неправильном формате.
1{
2 "state": 1,
3 "errors": {
4 "date_from": ["validation.regex"]
5 }
6}Скопировать