Payout history

post https://api.cryptomus.com/v1/payout/list Copy

Request

Query parameters

Name	Parameter type	Default value	Definition
date_from	stringformat: YYYY-MM-DD H:mm:ss	null	Filtering by creation date, from
date_to	stringformat: YYYY-MM-DD H:mm:ss	null	Filtering by creation date, to

: Parameter type
stringformat: YYYY-MM-DD H:mm:ss
Default value
null
Definition
Filtering by creation date, from
: Parameter type
stringformat: YYYY-MM-DD H:mm:ss
Default value
null
Definition
Filtering by creation date, to

Request example


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'

Copy

To filter payouts by creation date from may 4 to may 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"
}'

Copy

Response

Response parameters

Name	Parameter type	Definition
merchant_uuid	string	Merchant's Uuid
items		Array of Payouts. Structure
paginate		Data for pagination. Structure

: Parameter type
string
Definition
Merchant's Uuid
: Definition
Array of Payouts. Structure
: Definition
Data for pagination. Structure

Structure of item

Name	Parameter type	Definition
uuid	string	uuid of the payout
amount	string	Payout amount in currency
currency	string	Currency code for the payout
network	string\|null	The code of the blockchain network in which the payout is made
payer_currency	string\|null	Cryptocurrency code in which the payout will be actually made. The payout address will receive the payout currency.
payer_amount	string\|null	Amount in payer_currency of the payout.
address	string	The address of the wallet to which the payment is made
txid	string\|null	Transaction ID in the blockchain
status	string	Payout status statuses
payment_status	string	Payment status
is_final	boolean	Whether the payout is finalizedThe payout process is considered finalized once it has been successfully paid or if it has failed. In the event of a payout failure, the funds will be returned to your balance, requiring you to initiate the payout process again.
balance	string\|null	The remaining funds on the merchant's wallet.
order_id	string\|null	Order ID in your system
commission	string\|null	Cryptomus commission amount
merchant_amount	string\|null	The amount that is debited from the merchant's balance, including all commissions.
created_at	string\|null	Creation date of the payout. Timezone is UTC+3
updated_at	string\|null	Last payout updated date. Timezone is UTC+3
convert		Information about the currency to which the payment will be automatically converted. Conversion is performed from payer_currency to USDTPresent if from_currency is passed
convert.to_currency	string\|null	The currency code to which the payment will be converted
convert.from_currency	string	From currency
convert.commission	string	Conversion fee
convert.rate	string\|null	Conversion rate
convert.from_amount	string\|null	Amount from

: Parameter type
string
Definition
uuid of the payout
: Parameter type
string
Definition
Payout amount in currency
: Parameter type
string
Definition
Currency code for the payout
: Parameter type
string|null
Definition
The code of the blockchain network in which the payout is made
: Parameter type
string|null
Definition
Cryptocurrency code in which the payout will be actually made. The payout address will receive the payout currency.
: Parameter type
string|null
Definition
Amount in payer_currency of the payout.
: Parameter type
string
Definition
The address of the wallet to which the payment is made
: Parameter type
string|null
Definition
Transaction ID in the blockchain
: Parameter type
string
Definition
Payout status statuses
: Parameter type
string
Definition
Payment status
: Parameter type
boolean
Definition
Whether the payout is finalizedThe payout process is considered finalized once it has been successfully paid or if it has failed. In the event of a payout failure, the funds will be returned to your balance, requiring you to initiate the payout process again.
: Parameter type
string|null
Definition
The remaining funds on the merchant's wallet.
: Parameter type
string|null
Definition
Order ID in your system
: Parameter type
string|null
Definition
Cryptomus commission amount
: Parameter type
string|null
Definition
The amount that is debited from the merchant's balance, including all commissions.
: Parameter type
string|null
Definition
Creation date of the payout. Timezone is UTC+3
: Parameter type
string|null
Definition
Last payout updated date. Timezone is UTC+3
: Definition
Information about the currency to which the payment will be automatically converted. Conversion is performed from payer_currency to USDTPresent if from_currency is passed
: Parameter type
string|null
Definition
The currency code to which the payment will be converted
: Parameter type
string
Definition
From currency
: Parameter type
string
Definition
Conversion fee
: Parameter type
string|null
Definition
Conversion rate
: Parameter type
string|null
Definition
Amount from

To get next/previous page entries, specify the next/previous cursor hash in the query parameters (?cursor=nextCursorHash)

Example:


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

Copy

Response example


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}

Copy

Possible errors

Validation errors

code : 422

example responses:

If the date_from or date_to parameter is passed in the wrong format.


1{
2	"state": 1,
3	"errors": {
4	"date_from": ["validation.regex"]
5	}
6}

Copy