Tester WebHook

Test de paiement

post
https://api.cryptomus.com/v1/test-webhook/payment
COPIE

Pour valider la signature du tableau de données WebHook, utilisez la clé de l'API de paiement.

Pour vous assurer que vous recevez correctement les webhooks et que vous pouvez valider la signature, vous devez utiliser cette méthode pour tester les webhooks pour le paiement.
Veuillez noter qu'aucune donnée n'est enregistrée dans la base de données, et que toutes les données reçues dans le webhook ne sont stockées que dans un tableau à des fins de test pour assurer l'exactitude de la signature et tester la récupération de ce tableau de notre part.

Pour tester un webhook avec une facture existante, veuillez fournir son UUID ou ID de commande. Si ces paramètres ne sont pas fournis, le webhook sera envoyé avec une facture de test.

Demande

Paramètres de requête

NomType de paramètreValeur par défautDéfinition
url_callback*stringmin:6max:150urlURL à laquelle les webhooks avec l'état de paiement seront envoyés
currency*stringCode de devise de facture
network*stringCode réseau de facture
uuidstringuuidchaîne UUID aléatoireuuid de la facture
order_idstringmin:1max:32alpha_dashcorde aléatoireID de commande de la facture
status*stringpaidStatut de paiementOptions disponibles:processcheckpaidpaid_overfailwrong_amountcancelsystem_failrefund_processrefund_failrefund_paid

Type de paramètre

stringmin:6max:150url

Définition

URL à laquelle les webhooks avec l'état de paiement seront envoyés

Type de paramètre

string

Définition

Code de devise de facture

Type de paramètre

string

Définition

Code réseau de facture

Type de paramètre

stringuuid

Définition

uuid de la facture

Type de paramètre

stringmin:1max:32alpha_dash

Définition

ID de commande de la facture

Type de paramètre

string

Définition

Statut de paiementOptions disponibles:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - paramètre obligatoire

Vous pouvez passer l'un des paramètres UUID ou Order_ID, si vous passez les deux, le compte sera identifié par UUID

Demander un exemple


curl https://api.cryptomus.com/v1/test-webhook/payment \
-X POST \
-H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
COPIE

Réponse

Exemple de réponse


1{
2  "state": 0,
3  "result": []
4}
COPIE

Test de paiement

post
https://api.cryptomus.com/v1/test-webhook/payout
COPIE

Pour valider la signature du tableau de données WebHook, utilisez la clé de l'API de paiement.

Demande

Paramètres de requête

NomType de paramètreValeur par défautDéfinition
url_callback*stringmin:6max:150urlURL à laquelle les webhooks avec l'état de paiement seront envoyés
currency*stringCode de devise de paiement
network*stringCode réseau de paiement
uuidstringuuidchaîne UUID aléatoireuuid du paiement
order_idstringmin:1max:32alpha_dashcorde aléatoireID de commande du paiement
status*stringpaidStatut de paiementOptions disponibles:processcheckpaidfailcancelsystem_fail

Type de paramètre

stringmin:6max:150url

Définition

URL à laquelle les webhooks avec l'état de paiement seront envoyés

Type de paramètre

string

Définition

Code de devise de paiement

Type de paramètre

string

Définition

Code réseau de paiement

Type de paramètre

stringuuid

Définition

uuid du paiement

Type de paramètre

stringmin:1max:32alpha_dash

Définition

ID de commande du paiement

Type de paramètre

string

Définition

Statut de paiementOptions disponibles:- process- check- paid- fail- cancel- system_fail

* - paramètre obligatoire

Vous pouvez passer l'un des paramètres UUID ou Order_ID, si vous passez les deux, le compte sera identifié par UUID

Demander un exemple


curl https://api.cryptomus.com/v1/test-webhook/payout \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
COPIE

Réponse

Exemple de réponse


1{
2  "state": 0,
3  "result": []
4}
COPIE

Portefeuille de test

post
https://api.cryptomus.com/v1/test-webhook/wallet
COPIE

Pour valider la signature du tableau de données WebHook, utilisez la clé de l'API de paiement.

Demande

Paramètres de requête

NomType de paramètreValeur par défautDéfinition
url_callback*stringmin:6max:150urlURL à laquelle les webhooks avec l'état de paiement seront envoyés
currency*stringCode de devise de paiement
network*stringCode réseau de paiement
uuidstringuuidchaîne UUID aléatoireUUID de portefeuille d'affaires
order_idstringmin:1max:32alpha_dashcorde aléatoireID de commande de la facture
status*stringpaidStatut de paiementOptions disponibles:processcheckpaidpaid_overfailwrong_amountcancelsystem_failrefund_processrefund_failrefund_paid

Type de paramètre

stringmin:6max:150url

Définition

URL à laquelle les webhooks avec l'état de paiement seront envoyés

Type de paramètre

string

Définition

Code de devise de paiement

Type de paramètre

string

Définition

Code réseau de paiement

Type de paramètre

stringuuid

Définition

UUID de portefeuille d'affaires

Type de paramètre

stringmin:1max:32alpha_dash

Définition

ID de commande de la facture

Type de paramètre

string

Définition

Statut de paiementOptions disponibles:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - paramètre obligatoire

Demander un exemple


curl https://api.cryptomus.com/v1/test-webhook/wallet \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
COPIE

Réponse

Exemple de réponse


1{
2  "state": 0,
3  "result": []
4}
COPIE

Erreurs possibles

Erreurs de validation

code : 422

Exemples de réponses:

Si vous passez uuid ou order_id et le portefeuille / paiement statique n'est pas trouvé:


1{
2    "state": 1,
3    "message": "Not found payment"
4}
COPIE


1{
2    "state": 1,
3    "message": "Not found payout"
4}
COPIE


1{
2    "state": 1,
3    "message": "Not found wallet"
4}
COPIE

Si vous ne transmettez pas les paramètres requis:


1{
2	"state": 1,
3	"errors": {
4		"currency": ["validation.required"]
5	}
6}
COPIE

Si la monnaie et le réseau fournis ne sont pas crypto ou non pris en charge:


1{
2    "state": 1,
3    "message": "Payment service not found"
4}
COPIE


1{
2    "state": 1,
3    "message": "Payout service not found"
4}
COPIE