Listar reembolsos
Lista paginada dos reembolsos da conta, com filtros por etapa, transação, pagamento, forma de pagamento e período.
GET /refunds
Faz parte do recurso Reembolsos — o objeto, os status e o ciclo estão lá.
Retorna uma lista paginada de todos os reembolsos da conta. Todos os filtros são opcionais e podem
ser combinados. As datas seguem ISO 8601 com timezone (veja Convenções).
status e paymentMethod aceitam uma lista separada por
vírgula, e o resultado traz qualquer reembolso que case com um dos valores. Ex.:
?status=pending,approved&paymentMethod=boleto,pix.dateField decide sobre qual data o período incide. Com createdAt (o padrão) você pergunta
“o que foi pedido neste mês”; com refundedAt, “quando o dinheiro efetivamente voltou”. A segunda
é a que fecha com o extrato — um reembolso pedido em junho e liquidado em julho aparece em meses
diferentes conforme a escolha.?transactionId= e
?paymentId= fazem correspondência exata, e aceitam etapa, período e ordenação na mesma
consulta — ?transactionId=txn_123&status=refunded&dateField=refundedAt.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Query Parameters
Retorna os reembolsos desta transação. Correspondência exata.
Retorna os reembolsos deste pagamento. Correspondência exata.
Forma de pagamento estornada: credit_card, boleto ou pix. Aceita vários separados por vírgula.
credit_card, boleto, pix Etapa do reembolso. Aceita vários separados por vírgula. Valores: pending, approved, processing, refunded, refused, failed, awaiting_bank_details, bank_details_received, invalid_bank_details, ted_processing.
pending, approved, processing, refunded, refused, failed, awaiting_bank_details, bank_details_received, invalid_bank_details, ted_processing Início do período (ISO 8601 com timezone), inclusive. Aplica-se ao dateField.
Fim do período (ISO 8601 com timezone), inclusive. Aplica-se ao dateField.
Campo a que startDate e endDate se aplicam: createdAt (pedido) ou refundedAt (dinheiro devolvido). Default: createdAt.
createdAt, refundedAt Campo de ordenação: createdAt (pedido) ou refundedAt (dinheiro devolvido). Default: createdAt.
createdAt, refundedAt Direção da ordenação: asc ou desc. Default: desc.
asc, desc Número da página a retornar.
x > 0Quantidade de itens por página.
0 < x <= 100