Remboursement

post

https://api.cryptomus.com/v1/payment/refund

COPIE

Demande

Paramètres de requête

Nom	Type de paramètre	Définition
address*	string	L'adresse à laquelle le remboursement doit être effectué
is_subtract*	boolean	Que ce soit pour prendre une commission du solde du marchand ou du montant du remboursement true - Prenez la commission de l'équilibre des marchands false - Réduisez le montant remboursable du montant de la commission
uuid*	uuidrequired_without: order_id	Facture uuid
order_id*	stringmin:1max:128alpha_dashrequired_without: uuid	ID de commande de facture

Type de paramètre

string

Définition

L'adresse à laquelle le remboursement doit être effectué

Type de paramètre

boolean

Définition

Que ce soit pour prendre une commission du solde du marchand ou du montant du remboursement true - Prenez la commission de l'équilibre des marchands false - Réduisez le montant remboursable du montant de la commission

Type de paramètre

uuidrequired_without: order_id

Définition

Facture uuid

Type de paramètre

stringmin:1max:128alpha_dashrequired_without: uuid

Définition

ID de commande de facture

* - paramètre obligatoire

La facture est identifiée par order_id ou uuid, si vous passez les deux, le compte sera identifié par UUID

Demander un exemple


curl https://api.cryptomus.com/v1/payment/refund \
    -X POST \
    -H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
    -H 'sign: fe99035f86fa436181717b302b95bacff1' \
    -H 'Content-Type: application/json' \
    -d '{
            "uuid": "8b03432e-385b-4670-8d06-064591096795",
            "address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm", 
            "is_subtract": "true"
        }'

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 la facture avec uuid ou order_id que vous avez fournie n'existe pas:


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

COPIE

Si vous ne passerez pas un uuid et order_id , vous recevrez ce message. Cela signifie qu'au moins un des paramètres est requis.


1{
2	"state": 1,
3	"errors": {
4		"uuid": ["validation.required_without"],
5		"order_id": ["validation.required_without"]
6	}
7}

COPIE

Si les paiements sont bloqués sur votre marchand, vous recevrez ce message d'erreur. Cela se produit, par exemple, lorsque vous modifiez votre mot de passe et que les paiements sont bloqués pendant 24 heures.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}
5

COPIE

Si le portefeuille marchand qui est connecté à une facture n'existe pas:


1{
2    "state": 1,
3    "message": "Undefined merchant wallet"
4}

COPIE

Si la facture n'est pas finalisée ou non payée.


1{
2    "state": 1,
3    "message": "Refunds are made only for completed payments"
4}

COPIE

Si le montant à rembourser dépasse le montant du paiement de la facture:


1{
2    "state": 1,
3    "message": "The refund amount should not be more than the amount paid"
4}

COPIE

Si le travail technique se produit et que le paiement est temporairement indisponible, vous pouvez recevoir ce message d'erreur:


1{
2    "state": 1,
3    "message": "Server error"
4}

COPIE