Historique de paiement

post

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

COPIE

Demande

Paramètres de requête

Nom	Type de paramètre	Valeur par défaut	Définition
date_from	stringformat: YYYY-MM-DD H:mm:ss	null	Filtrage par date de création, à partir de
date_to	stringformat: YYYY-MM-DD H:mm:ss	null	Filtrage par date de création, pour

Type de paramètre

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

Définition

Filtrage par date de création, à partir de

Type de paramètre

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

Définition

Filtrage par date de création, pour

Demander un exemple


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'

COPIE

Pour filtrer les paiements par date de création du 4 mai au 16 mai.


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

COPIE

Réponse

Paramètres de réponse

Nom	Définition
merchant_uuid	UUID du marchand
items	Tableau de paiements. Structure
paginate	Données pour la pagination. Structure

: Définition
UUID du marchand
: Définition
Tableau de paiements. Structure
: Définition
Données pour la pagination. Structure

Structure de article

Nom	Définition
uuid	uuid du paiement
amount	Montant de paiement dans currency
currency	Code de devise pour le paiement
network	Le code du réseau de blockchain dans lequel le paiement est effectué
address	L'adresse du portefeuille auquel le paiement est effectué
txid	ID de transaction dans la blockchain
status	Statut de paiement statuts
is_final	Si le paiement est finaliséLe processus de paiement est considéré comme finalisé une fois qu'il a été payé avec succès ou s'il a échoué. En cas de défaillance de paiement, les fonds seront retournés à votre solde, vous obligeant à initier à nouveau le processus de paiement.
balance	Les fonds restants sur le portefeuille du marchand.
created_at	Date de création du paiement. Le fuseau horaire est UTC + 3
updated_at	Dernière date de mise à jour. Le fuseau horaire est UTC + 3

: Définition
uuid du paiement
: Définition
Montant de paiement dans currency
: Définition
Code de devise pour le paiement
: Définition
Le code du réseau de blockchain dans lequel le paiement est effectué
: Définition
L'adresse du portefeuille auquel le paiement est effectué
: Définition
ID de transaction dans la blockchain
: Définition
Statut de paiement statuts
: Définition
Si le paiement est finaliséLe processus de paiement est considéré comme finalisé une fois qu'il a été payé avec succès ou s'il a échoué. En cas de défaillance de paiement, les fonds seront retournés à votre solde, vous obligeant à initier à nouveau le processus de paiement.
: Définition
Les fonds restants sur le portefeuille du marchand.
: Définition
Date de création du paiement. Le fuseau horaire est UTC + 3
: Définition
Dernière date de mise à jour. Le fuseau horaire est UTC + 3

Pour obtenir les entrées de page suivantes / précédentes, spécifiez le hachage du curseur suivant / précédent dans les paramètres de requête (?cursor=nextCursorHash)

Exemple:


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

COPIE

Exemple de réponse


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}

COPIE

Erreurs possibles

Erreurs de validation

code : 422

Exemples de réponses:

Si le paramètre date_from ou date_to est passé dans le mauvais format.


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

COPIE