Історія виплат

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}

Копія