История выплат

post https://api.cryptomus.com/v1/payout/list Скопировать

Запрос

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

ИмяТип параметраЗначение по умолчаниюОписание
date_fromstringformat: YYYY-MM-DD H:mm:ssnullФильтрация по дате создания, от
date_tostringformat: YYYY-MM-DD H:mm:ssnullФильтрация по дате создания, до

Тип параметра

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_uuidstringUuid мерчанта
itemsМассив выплат. Структура
paginateДанные для разбивки на страницы. Структура

Тип параметра

string

Описание

Uuid мерчанта

Описание

Массив выплат. Структура

Описание

Данные для разбивки на страницы. Структура

Структура пункт

ИмяТип параметраОписание
uuidstringuuid выплаты
amountstringСумма выплаты в currency
currencystringКод валюты для выплаты
networkstring|nullКод блокчейн-сети, в которой производится выплата
payer_currencystring|nullКод криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты.
payer_amountstring|nullСумма выплаты в payer_currency.
addressstringАдрес кошелька, на который производится платеж
txidstring|nullИдентификатор транзакции в блокчейне
statusstringСтатус выплаты статусы
payment_statusstringСтатус платежа
is_finalbooleanЗавершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.
balancestring|nullОставшиеся средства на кошельке продавца.
order_idstring|nullИдентификатор заказа в Вашей системе
commissionstring|nullСумма комиссии Cryptomus
merchant_amountstring|nullСумма, которая списывается с баланса продавца, включая все комиссии.
created_atstring|nullДата создания выплаты. Часовой пояс - UTC+3
updated_atstring|nullДата последней выплаты обновлена. Часовой пояс - UTC+3
convertИнформация о валюте, в которую будет автоматически конвертирован платеж. Конвертация производится из payer_currency в USDTПрисутствует, если передан параметр from_currency.
convert.to_currencystring|nullКод валюты, в которую будет конвертирован платеж
convert.from_currencystringИз валюты
convert.commissionstringКомиссия за конвертацию
convert.ratestring|nullКоэффициент конверсии
convert.from_amountstring|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}
Скопировать