Refund Payment

Usa esto para devolver dinero de un pago que ya se liquidó.

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/v4/site/{site_id}/payment/refund
Solicitud
Campo
Tipo
Descripción
id
String
El ID del pago. El pago debe estar pagado y procesado por nosotros. Un pago registrado desde otro sistema se rechaza con Cannot refund external payment. Un pago admite un solo reembolso o anulación en total, por lo que una segunda solicitud se rechaza.
amount
Number
El monto a reembolsar, en centavos enteros (p. ej., 1035 = $10.35). Envíe un monto menor al del pago para un reembolso parcial. Un decimal o un monto mayor al del pago se rechaza. Este endpoint siempre envía un reembolso, nunca una anulación. Use el endpoint de anulación para cancelar un pago que no se ha liquidado. En los sitios configurados para esperar la liquidación de ACH, un pago ACH sin liquidar pasa a refundRequested y se reembolsa una vez que se liquide.
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 [ ]
Una lista de errores. Solo se devolverá si success es false.
			
{
  "success": true
}


		

Ver también