Refund Payment

Utilisez ceci pour rembourser un paiement qui a déjà été réglé.

The following endpoint can be used to refund a Payment within the Hyfin application.


Point de terminaison

The following endpoint can be used to refund a Payment. You must replace the {base_url} and {site_id} variables with the appropriate values.

POST
{base_url}/api/v4/site/{site_id}/payment/refund
Demande
Champ
Type
Description
id
String
L'identifiant du paiement. Le paiement doit être payé et traité par nous. Un paiement enregistré à partir d'un autre système est rejeté avec Cannot refund external payment. Un paiement n'accepte qu'un seul remboursement ou une seule annulation au total, donc une deuxième demande est rejetée.
amount
Number
Le montant à rembourser, en cents entiers (p. ex. 1035 = 10,35 $). Envoyez un montant inférieur à celui du paiement pour un remboursement partiel. Une décimale ou un montant supérieur à celui du paiement est rejeté. Ce point de terminaison envoie toujours un remboursement, jamais une annulation. Utilisez le point de terminaison d'annulation pour annuler un paiement qui n'a pas été réglé. Sur les sites configurés pour attendre le règlement ACH, un paiement ACH non réglé passe à refundRequested et est remboursé une fois réglé.
reason
String
Raison facultative du remboursement.
Sample Request
			
{
  "id": "64fa4489fb1eaa8e5ae93475",
  "amount": 1035
}


		
Réponse
Champ
Type
Description
success
Boolean
Si le remboursement a été traité avec succès.
errors
String [ ]
Une liste d'erreurs. Ne sera retournée que si success est false.
			
{
  "success": true
}


		

Voir aussi