Reembolsos
Pedir um reembolso
Pede a devolução de um pagamento pago, inteira ou parcial. O valor fica reservado no seu saldo até a análise.
POST
/v1/payments/{id}/refunds Requer o escopo REFUND:CREATE
Envie o id do pagamento no caminho. Sem amount_cents, devolvemos todo o valor que ainda pode ser devolvido. Veja como funciona em Reembolsos.
Requisição
Cabeçalhos: Authorization, Content-Type: application/json e Idempotency-Key (obrigatório).
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount_cents | integer | não | Valor a devolver, em centavos. Sem ele (ou com 0), devolvemos tudo o que ainda pode ser devolvido. |
reason | string | sim | Motivo: customer_request, duplicate, fraud ou other. |
description | string | não | Explicação, até 500 caracteres. Use quando o motivo for other. |
Resposta
A API responde 201 com o reembolso em requested.
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Id do reembolso. |
payment_id | string | Id do pagamento devolvido. |
status | string | Status do reembolso. Veja os status. |
amount_cents | integer | Valor devolvido, em centavos. |
reason | string | O motivo enviado. |
description | string | null | A explicação enviada. |
decision_reason | string | null | Por que o reembolso foi recusado. null nos outros casos. |
fee_returned_cents | integer | null | Quanto da taxa voltou ao seu saldo, quando o reembolso termina. |
created_at | string (ISO 8601) | Quando o reembolso foi pedido. |
completed_at | string (ISO 8601) | null | Quando o valor foi devolvido ao cliente. |
Erros
| HTTP | Código | Quando acontece | O que fazer |
|---|---|---|---|
| 404 | not_found | Não existe pagamento com este id na sua conta. | Confira o id. |
| 409 | payment_not_refundable | O pagamento não está pago ou já foi devolvido por inteiro. | Confira o status do pagamento. |
| 409 | insufficient_balance | Seu saldo disponível não cobre o reembolso. | Espere novos pagamentos entrarem no saldo. |
| 409 | infraction_open | O pagamento tem uma infração em aberto. | Espere a infração ser resolvida. |
| 422 | validation_failed | Campo inválido, ou valor maior do que o que ainda pode ser devolvido. | Veja o campo fields. |