Histórico de pagamento

post https://api.cryptomus.com/v1/payout/list Cópia

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
Valor padrão
null
Definição
Filtragem por data da criação, de
: Tipo de parâmetro
stringformat: YYYY-MM-DD H:mm:ss
Valor padrão
null
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

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

Resposta

Parâmetros de resposta

Nome	Tipo de parâmetro	Definição
merchant_uuid	string	Uuid do comerciante
items		Matriz de pagamentos. Estrutura
paginate		Dados para paginação. Estrutura

: Tipo de parâmetro
string
Definição
Uuid do comerciante
: Definição
Matriz de pagamentos. Estrutura
: Definição
Dados para paginação. Estrutura

Estrutura de item

Nome	Tipo de parâmetro	Definição
uuid	string	uuid do pagamento
amount	string	Valor de pagamento em currency
currency	string	Código da moeda para o pagamento
network	string\|null	O código da rede blockchain na qual o pagamento é feito
payer_currency	string\|null	Código de criptomoeda no qual o pagamento será realmente feito. O endereço de pagamento receberá a moeda de pagamento.
payer_amount	string\|null	Valor em pager_currency do pagamento.
address	string	O endereço da carteira com o qual o pagamento é feito
txid	string\|null	ID da transação no blockchain
status	string	Status de pagamento status
payment_status	string	Status do pagamento
is_final	boolean	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	string\|null	Os restantes fundos na carteira do comerciante.
order_id	string\|null	Pedido ID em seu sistema
commission	string\|null	Montante da Comissão Cryptomus
merchant_amount	string\|null	O valor que é debitado do saldo do comerciante, incluindo todas as comissões.
created_at	string\|null	Data de criação do pagamento. O fuso horário é UTC+3
updated_at	string\|null	Última data de pagamento atualizada. O fuso horário é UTC+3
convert		Informações sobre a moeda para a qual o pagamento serão convertidas automaticamente. A conversão é realizada de pager_currency para USDTPresente se from_currency for passado
convert.to_currency	string\|null	O código da moeda para o qual o pagamento será convertido
convert.from_currency	string	Da moeda
convert.commission	string	Taxa de conversão
convert.rate	string\|null	Taxa de conversão
convert.from_amount	string\|null	Quantia de

: Tipo de parâmetro
string
Definição
uuid do pagamento
: Tipo de parâmetro
string
Definição
Valor de pagamento em currency
: Tipo de parâmetro
string
Definição
Código da moeda para o pagamento
: Tipo de parâmetro
string|null
Definição
O código da rede blockchain na qual o pagamento é feito
: Tipo de parâmetro
string|null
Definição
Código de criptomoeda no qual o pagamento será realmente feito. O endereço de pagamento receberá a moeda de pagamento.
: Tipo de parâmetro
string|null
Definição
Valor em pager_currency do pagamento.
: Tipo de parâmetro
string
Definição
O endereço da carteira com o qual o pagamento é feito
: Tipo de parâmetro
string|null
Definição
ID da transação no blockchain
: Tipo de parâmetro
string
Definição
Status de pagamento status
: Tipo de parâmetro
string
Definição
Status do pagamento
: Tipo de parâmetro
boolean
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.
: Tipo de parâmetro
string|null
Definição
Os restantes fundos na carteira do comerciante.
: Tipo de parâmetro
string|null
Definição
Pedido ID em seu sistema
: Tipo de parâmetro
string|null
Definição
Montante da Comissão Cryptomus
: Tipo de parâmetro
string|null
Definição
O valor que é debitado do saldo do comerciante, incluindo todas as comissões.
: Tipo de parâmetro
string|null
Definição
Data de criação do pagamento. O fuso horário é UTC+3
: Tipo de parâmetro
string|null
Definição
Última data de pagamento atualizada. O fuso horário é UTC+3
: Definição
Informações sobre a moeda para a qual o pagamento serão convertidas automaticamente. A conversão é realizada de pager_currency para USDTPresente se from_currency for passado
: Tipo de parâmetro
string|null
Definição
O código da moeda para o qual o pagamento será convertido
: Tipo de parâmetro
string
Definição
Da moeda
: Tipo de parâmetro
string
Definição
Taxa de conversão
: Tipo de parâmetro
string|null
Definição
Taxa de conversão
: Tipo de parâmetro
string|null
Definição
Quantia de

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

Exemplo de resposta


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}

Cópia

Possíveis erros

Erros de validação

código : 422

exemplos 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