Skip to main content
GET
cURL

Escopo

Como funciona o reembolso pedido pelo comprador

Quando o comprador pede reembolso, a venda vira refund_requested, o valor fica retido no seu saldo e abre-se uma janela que termina em autoApproveAt:
  • o comprador pode desistir até lá, e a venda volta a paid;
  • você pode aprovar antes, com Aprovar Reembolso;
  • se ninguém agir, o reembolso é efetivado automaticamente em autoApproveAt.
A devolução não depende da sua aprovação. A janela existe para você falar com o comprador, e o contato dele vem em customer.
Para saber na hora que um reembolso foi pedido, sem consultar esta lista de tempos em tempos, assine o evento de webhook refund_requested. Ver Guia de Webhooks.

Estados

O id de cada reembolso é o id do pedido. Reembolso feito direto pelo painel, sem pedido do comprador, também aparece aqui, com requestedAt nulo.
O estorno é da cobrança inteira. Numa compra com order bump, os pedidos da mesma cobrança são reembolsados juntos, e cada um aparece nesta lista com o seu id. parentOrderId liga o order bump ao pedido principal.

Filtros

A resposta vem no envelope de paginação do contrato: count, next, previous e results, do pedido de reembolso mais recente para o mais antigo.
A listagem traz só pedidos de produto da conta dona do token, que é quem pode aprovar.

Exemplo

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

limit
integer

Itens por página. Default 10, máximo 500.

page
integer

Página a retornar. Default 1.

product
string

Id do produto.

requestedAt__gte
string<date>

Pedidos de reembolso a partir desta data (YYYY-MM-DD), inclusive.

requestedAt__lte
string<date>

Pedidos de reembolso até esta data (YYYY-MM-DD), inclusive.

status
enum<string>

Filtra por estado. refund_requested é a fila do que ainda pode ser aprovado.

Available options:
acquirer_error,
in_settlement,
refund_requested,
refunded

Response

Reembolsos dos seus produtos, do pedido de reembolso mais recente para o mais antigo.

count
integer
Example:

123

next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

results
object[]