Reembolso

O reembolso reverte um pagamento previamente capturado e devolve os fundos ao portador do cartão. O tempo para o reembolso aparecer na fatura do portador varia conforme o banco emissor.

Regras Principais

Só é possível para pagamentos capturados (use o Cancelamento (Void) para autorizações não capturadas)
Você pode reembolsar o valor total ou um valor parcial
Múltiplos reembolsos parciais são permitidos até que o valor total capturado seja reembolsado
Uma vez totalmente reembolsado, novas tentativas de reembolso retornam um erro
Se nenhum valor for especificado, o valor total capturado é reembolsado

Endpoint

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

Headers:

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

Corpo da Requisição (Opcional)

Omita o corpo para reembolsar o valor total capturado. Inclua-o para um reembolso parcial:

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

Campo	Tipo	Obrigatório	Descrição
`amount.total`	number	Não	Valor a reembolsar (deve ser ≤ ao valor capturado restante)
`amount.currency`	string	Não	Código da moeda (deve corresponder ao pagamento original)

Exemplo — Reembolso Total

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

Exemplo — 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"
    }
  }'

Resposta (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 parciais, o status será PARTIALLY_REFUNDED até que o valor total seja devolvido.