Payout information

post
https://api.cryptomus.com/v1/payout/info
COPY

Request

Query parameters

NameParameter typeDefinition
uuiduuidrequired_without: order_idPayout uuid
order_idstringmin:1max:32alpha_dashrequired_without: uuidPayout order ID

Parameter type

uuidrequired_without: order_id

Definition

Payout uuid

Parameter type

stringmin:1max:32alpha_dashrequired_without: uuid

Definition

Payout order ID
To get the payout information you need to pass one of the parameters, if you pass both, the payout will be identified by order_id

Request example


1curl https://api.cryptomus.com/v1/payout/info \
2-X POST \
3-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
4-H 'sign: fe99035f86fa436181717b302b95bacff1' \
5-H 'Content-Type: application/json' \
6-d '{
7    "uuid": "8b03432e-385b-4670-8d06-064591096795"
8}'
9
COPY

Response

Response parameters

Object of payment - see

Response example


1{
2    "state": 0,
3    "result": {
4        "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
5        "amount": "3",
6        "currency": "USDT",
7        "network": "TRON",
8        "address": "TJ...",
9        "txid": null,
10        "status": "process",
11        "is_final": false,
12        "balance": 129,
13        "payer_currency": "USD",
14        "payer_amount": 3
15    }
16}
17
COPY

Possible errors

Validation errors

code : 422

example responses:

If you will not pass a uuid and order_id, you will receive this message. It means that at least one of the parameters is required.


1{
2	"state": 1,
3	"errors": {
4		"uuid": ["validation.required_without"],
5		"order_id": ["validation.required_without"]
6	}
7}
COPY