Skip to main content
GET
Listar reembolsos
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).
Filtro com valor inválido é rejeitado, não ignorado. ?status=xpto responde 400 com error.issues[] apontando o campo e os valores aceitos.O formato do erro e a lista de códigos estão em Erros.
Vários valores no mesmo filtro. 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.
Para ver os reembolsos de uma transação ou de um pagamento, filtre aqui. ?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

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

transactionId
string | null

Retorna os reembolsos desta transação. Correspondência exata.

paymentId
string | null

Retorna os reembolsos deste pagamento. Correspondência exata.

paymentMethod
enum<string>[] | null

Forma de pagamento estornada: credit_card, boleto ou pix. Aceita vários separados por vírgula.

Available options:
credit_card,
boleto,
pix
status
enum<string>[] | null

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.

Available options:
pending,
approved,
processing,
refunded,
refused,
failed,
awaiting_bank_details,
bank_details_received,
invalid_bank_details,
ted_processing
startDate
string<date-time> | null

Início do período (ISO 8601 com timezone), inclusive. Aplica-se ao dateField.

endDate
string<date-time> | null

Fim do período (ISO 8601 com timezone), inclusive. Aplica-se ao dateField.

dateField
enum<string> | null

Campo a que startDate e endDate se aplicam: createdAt (pedido) ou refundedAt (dinheiro devolvido). Default: createdAt.

Available options:
createdAt,
refundedAt
sortBy
enum<string> | null

Campo de ordenação: createdAt (pedido) ou refundedAt (dinheiro devolvido). Default: createdAt.

Available options:
createdAt,
refundedAt
sortDir
enum<string> | null

Direção da ordenação: asc ou desc. Default: desc.

Available options:
asc,
desc
page
integer
default:1

Número da página a retornar.

Required range: x > 0
limit
integer
default:10

Quantidade de itens por página.

Required range: 0 < x <= 100

Response

Lista de reembolsos

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.