Histórico de pagamento

post

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

CÓPIA DE

Solicitar

Parâmetros de consulta

Nome	Tipo de parâmetro	Valor padrão	Definição
date_from	stringformat: YYYY-MM-DD H:mm:ss	null	Filtragem por data da criação, de
date_to	stringformat: YYYY-MM-DD H:mm:ss	null	Filtragem por data da criação, para

Tipo de parâmetro

stringformat: YYYY-MM-DD H:mm:ss

Definição

Filtragem por data da criação, de

Tipo de parâmetro

stringformat: YYYY-MM-DD H:mm:ss

Definição

Filtragem por data da criação, para

Exemplo de solicitação


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'

CÓPIA DE

Filtrar os pagamentos por data da criação de 4 de maio a 16 de maio.


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"
}'

CÓPIA DE

Resposta

Parâmetros de resposta

Nome	Definição
merchant_uuid	Uuid do comerciante
items	Matriz de pagamentos. Estrutura
paginate	Dados para paginação. Estrutura

: Definição
Uuid do comerciante
: Definição
Matriz de pagamentos. Estrutura
: Definição
Dados para paginação. Estrutura

Estrutura de item

Nome	Definição
uuid	uuid do pagamento
amount	Valor de pagamento em currency
currency	Código da moeda para o pagamento
network	O código da rede blockchain na qual o pagamento é feito
address	O endereço da carteira com o qual o pagamento é feito
txid	ID da transação no blockchain
status	Status de pagamento status
is_final	Se o pagamento é finalizadoO processo de pagamento é considerado finalizado depois de pagar com sucesso ou se tiver falhado. No caso de uma falha de pagamento, os fundos serão devolvidos ao seu saldo, exigindo que você inicie o processo de pagamento novamente.
balance	Os restantes fundos na carteira do comerciante.
created_at	Data de criação do pagamento. O fuso horário é UTC+3
updated_at	Última data de pagamento atualizada. O fuso horário é UTC+3

: Definição
uuid do pagamento
: Definição
Valor de pagamento em currency
: Definição
Código da moeda para o pagamento
: Definição
O código da rede blockchain na qual o pagamento é feito
: Definição
O endereço da carteira com o qual o pagamento é feito
: Definição
ID da transação no blockchain
: Definição
Status de pagamento status
: Definição
Se o pagamento é finalizadoO processo de pagamento é considerado finalizado depois de pagar com sucesso ou se tiver falhado. No caso de uma falha de pagamento, os fundos serão devolvidos ao seu saldo, exigindo que você inicie o processo de pagamento novamente.
: Definição
Os restantes fundos na carteira do comerciante.
: Definição
Data de criação do pagamento. O fuso horário é UTC+3
: Definição
Última data de pagamento atualizada. O fuso horário é UTC+3

Para obter entradas de página seguintes/anteriores, especifique o Hash Cursor próximo/anterior nos parâmetros de consulta (?cursor=nextCursorHash)

Exemplo:


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

CÓPIA DE

Exemplo de resposta


1{
2"state": 0,
3"result": {
4	"items": [{
5		"uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
6		"amount": "3",
7		"currency": "USDT",
8		"network": "TRON",
9		"address": "TJ...",
10		"txid": null,
11		"status": "process",
12		"is_final": false,
13		"balance": "129.00000000",
14		"created_at": "2023-06-21T17:25:55+03:00",
15		"updated_at": "2023-06-21T17:34:38+03:00"
16	}, {
17		"uuid": "92c39264-d180-4503-9c16-ee16f083bbb8",
18		"amount": "5.40000000",
19		"currency": "DOGE",
20		"network": "doge",
21		"address": "DEw8CJLfxg9fhumeXP1zvVNjZicsqtDv7V",
22		"txid": "5e5810946152ea569d2a2aa9aa32a45c0e4223a4f9aad8e31d2fc660d2cdedb8",
23		"order_id": null,
24		"payment_status": null,
25		"status": "paid",
26		"is_final": true,
27		"balance": "26.77966652",
28		"created_at": "2023-07-21T17:25:55+03:00",
29		"updated_at": "2023-07-21T17:34:38+03:00"
30	},
31	...
32	],
33	"paginate": {
34		"count": 15,
35		"hasPages": true,
36		"nextCursor": "eyJpZCI6MjkxNTU0MywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
37		"previousCursor": null,
38		"perPage": 15
39	}
40}
41}

CÓPIA DE

Possíveis erros

Erros de validação

código : 422

Exemplo de respostas:

Se o parâmetro date_from ou date_to for passado no formato errado.


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

CÓPIA DE