Reembolso

El reembolso revierte un pago capturado previamente y devuelve los fondos al tarjetahabiente. El tiempo que tarda el reembolso en aparecer en el estado de cuenta del tarjetahabiente varía según el banco emisor.

Reglas clave

Solo es posible para pagos capturados (use Anulación para autorizaciones no capturadas)
Puede reembolsar el monto total o un monto parcial
Se permiten múltiples reembolsos parciales hasta que se reembolse el monto total capturado
Una vez reembolsado por completo, los intentos de reembolso adicionales devuelven un error
Si no se especifica un monto, se reembolsa el monto total capturado

Endpoint

POST https://{FQDN}/payments/{externalPaymentId}/refund

Encabezados:

Encabezado	Valor
`Authorization`	`Bearer {accessToken}`
`Content-Type`	`application/json`

Cuerpo de la solicitud (opcional)

Omita el cuerpo para reembolsar el monto total capturado. Inclúyalo para un reembolso parcial:

{
  "amount": {
    "total": 25.00,
    "currency": "USD"
  }
}

Campo	Tipo	Requerido	Descripción
`amount.total`	number	No	Monto a reembolsar (debe ser ≤ al monto capturado restante)
`amount.currency`	string	No	Código de moneda (debe coincidir con el pago original)

Ejemplo — Reembolso total

curl -X POST https://{FQDN}/payments/order-12345/refund \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json'

Ejemplo — Reembolso parcial

curl -X POST https://{FQDN}/payments/order-12345/refund \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": {
      "total": 25.00,
      "currency": "USD"
    }
  }'

Respuesta (200)

{
  "paymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "parentPaymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "externalPaymentId": "order-12345",
  "amount": 100.10,
  "created": "2024-04-22 16:22:06",
  "approved": true,
  "message": "Payment Approved",
  "automaticReversed": false,
  "status": "REFUNDED",
  "captured": true,
  "voided": false,
  "authCode": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "issuerName": "BANK OF AMERICA",
  "issuerCountry": "US",
  "cvcResult": "APPROVED",
  "avsResult": "NOT_SENT"
}

Para reembolsos parciales, el status será PARTIALLY_REFUNDED hasta que se devuelva el monto total.