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).

CampoTipoObrigatórioDescrição
amount_centsintegernãoValor a devolver, em centavos. Sem ele (ou com 0), devolvemos tudo o que ainda pode ser devolvido.
reasonstringsimMotivo: customer_request, duplicate, fraud ou other.
descriptionstringnãoExplicação, até 500 caracteres. Use quando o motivo for other.

Resposta

A API responde 201 com o reembolso em requested.

CampoTipoDescrição
idstringId do reembolso.
payment_idstringId do pagamento devolvido.
statusstringStatus do reembolso. Veja os status.
amount_centsintegerValor devolvido, em centavos.
reasonstringO motivo enviado.
descriptionstring | nullA explicação enviada.
decision_reasonstring | nullPor que o reembolso foi recusado. null nos outros casos.
fee_returned_centsinteger | nullQuanto da taxa voltou ao seu saldo, quando o reembolso termina.
created_atstring (ISO 8601)Quando o reembolso foi pedido.
completed_atstring (ISO 8601) | nullQuando o valor foi devolvido ao cliente.

Erros

HTTPCódigoQuando aconteceO que fazer
404not_foundNão existe pagamento com este id na sua conta.Confira o id.
409payment_not_refundableO pagamento não está pago ou já foi devolvido por inteiro.Confira o status do pagamento.
409insufficient_balanceSeu saldo disponível não cobre o reembolso.Espere novos pagamentos entrarem no saldo.
409infraction_openO pagamento tem uma infração em aberto.Espere a infração ser resolvida.
422validation_failedCampo inválido, ou valor maior do que o que ainda pode ser devolvido.Veja o campo fields.