Void Payment
The following endpoint can be used to void a Payment within the Hyfin application.
Punto Final
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
Solicitud
Campo
Tipo
Requerido
Descripción
id
String
El ID de pago.
reason
String
--
Motivo opcional para la anulación.
Sample Request
{
"id": "64fa4489fb1eaa8e5ae93475"
}
Respuesta
Campo
Tipo
Descripción
success
Boolean
Si el vacío 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",
"Payment not voidable"
]
}