Refund Payment
The following endpoint can be used to refund a Payment within the Hyfin application.
Punto Final
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/v3.1/site/{site_id}/Payment/refund
Solicitud
Campo
Tipo
Requerido
Descripción
id
String
El ID de pago.
amount
Number
La cantidad reembolsada en centavos (por ejemplo, 1035 = $10.35).
reason
String
--
Motivo opcional para el reembolso.
Sample Request
{
"id": "64fa4489fb1eaa8e5ae93475",
"amount": 1035
}
Respuesta
Campo
Tipo
Descripción
success
Boolean
Si el reembolso se procesó correctamente.
errors
String [ ]
A list of errors. Will only be returned if `success` is `false`.
Sample Response (Successful)
{
"success": true
}
Sample Response (Failed)
{
"success": false,
"errors": [
"NO PAYMENT FOUND",
"Invalid refund amount"
]
}