Void Payment

Utilisez ceci pour annuler un paiement avant son règlement, habituellement le jour même où il a été effectué.

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


Point de terminaison

The following endpoint can be used to void 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/void
Demande
Champ
Type
Description
id
String
L'identifiant du paiement. Une annulation annule la totalité du paiement avant son règlement, donc aucun argent n'est déplacé. Lorsque le processeur refuse l'annulation, par exemple après le règlement du paiement, la demande échoue. Elle ne bascule jamais vers un remboursement. Le paiement doit être payé et traité par nous, et un paiement n'accepte qu'un seul remboursement ou une seule annulation au total.
reason
String
Raison facultative de l'annulation.
Sample Request
			
{
  "id": "64fa4489fb1eaa8e5ae93475"
}


		
Réponse
Champ
Type
Description
success
Boolean
Si le vide 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