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
Valeur par défaut
null
Définition
Filtrage par date de création, à partir de
: Type de paramètre
stringformat: YYYY-MM-DD H:mm:ss
Valeur par défaut
null
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	Type de paramètre	Définition
merchant_uuid	string	UUID du marchand
items		Tableau de paiements. Structure
paginate		Données pour la pagination. Structure

: Type de paramètre
string
Définition
UUID du marchand
: Définition
Tableau de paiements. Structure
: Définition
Données pour la pagination. Structure

Structure de article

Nom	Type de paramètre	Définition
uuid	string	uuid du paiement
amount	string	Montant de paiement dans currency
currency	string	Code de devise pour le paiement
network	string\|null	Le code du réseau de blockchain dans lequel le paiement est effectué
payer_currency	string\|null	Code de crypto-monnaie dans lequel le paiement sera réellement effectué. L'adresse de paiement recevra la monnaie de paiement.
payer_amount	string\|null	Montant dans Payer_Currency du paiement.
address	string	L'adresse du portefeuille auquel le paiement est effectué
txid	string\|null	ID de transaction dans la blockchain
status	string	Statut de paiement statuts
payment_status	string	Statut de paiement
is_final	boolean	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	string\|null	Les fonds restants sur le portefeuille du marchand.
order_id	string\|null	Commandez ID dans votre système
commission	string\|null	Montant de la commission Cryptomus
merchant_amount	string\|null	Le montant qui est débité du solde du marchand, y compris toutes les commissions.
created_at	string\|null	Date de création du paiement. Le fuseau horaire est UTC + 3
updated_at	string\|null	Dernière date de mise à jour. Le fuseau horaire est UTC + 3
convert		Des informations sur la monnaie à laquelle le paiement sera automatiquement converti. La conversion est effectuée à partir de Payer_Currency en USDTPrésent si from_currency est transmis
convert.to_currency	string\|null	Le code de devise auquel le paiement sera converti
convert.from_currency	string	De la monnaie
convert.commission	string	Frais de conversion
convert.rate	string\|null	Taux de conversion
convert.from_amount	string\|null	Montant de

: Type de paramètre
string
Définition
uuid du paiement
: Type de paramètre
string
Définition
Montant de paiement dans currency
: Type de paramètre
string
Définition
Code de devise pour le paiement
: Type de paramètre
string|null
Définition
Le code du réseau de blockchain dans lequel le paiement est effectué
: Type de paramètre
string|null
Définition
Code de crypto-monnaie dans lequel le paiement sera réellement effectué. L'adresse de paiement recevra la monnaie de paiement.
: Type de paramètre
string|null
Définition
Montant dans Payer_Currency du paiement.
: Type de paramètre
string
Définition
L'adresse du portefeuille auquel le paiement est effectué
: Type de paramètre
string|null
Définition
ID de transaction dans la blockchain
: Type de paramètre
string
Définition
Statut de paiement statuts
: Type de paramètre
string
Définition
Statut de paiement
: Type de paramètre
boolean
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.
: Type de paramètre
string|null
Définition
Les fonds restants sur le portefeuille du marchand.
: Type de paramètre
string|null
Définition
Commandez ID dans votre système
: Type de paramètre
string|null
Définition
Montant de la commission Cryptomus
: Type de paramètre
string|null
Définition
Le montant qui est débité du solde du marchand, y compris toutes les commissions.
: Type de paramètre
string|null
Définition
Date de création du paiement. Le fuseau horaire est UTC + 3
: Type de paramètre
string|null
Définition
Dernière date de mise à jour. Le fuseau horaire est UTC + 3
: Définition
Des informations sur la monnaie à laquelle le paiement sera automatiquement converti. La conversion est effectuée à partir de Payer_Currency en USDTPrésent si from_currency est transmis
: Type de paramètre
string|null
Définition
Le code de devise auquel le paiement sera converti
: Type de paramètre
string
Définition
De la monnaie
: Type de paramètre
string
Définition
Frais de conversion
: Type de paramètre
string|null
Définition
Taux de conversion
: Type de paramètre
string|null
Définition
Montant de

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

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