Skip to main content
GET
Listar chargebacks
GET /chargebacks Faz parte do recurso Chargebacks — as etapas do caso e o objeto de resposta estão lá. Retorna uma lista paginada. 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 aceita uma lista separada por vírgula, e o resultado traz as contestações em qualquer uma das etapas: ?status=opened,under_review.
Para ver as contestações de uma transação ou de um pagamento, filtre aqui. ?transactionId= e ?paymentId= fazem correspondência exata, e aceitam status, período e ordenação na mesma consulta — ?transactionId=txn_123&status=under_review&dateField=deadlineAt.
dateField decide sobre qual data o período incide. Com openedAt (o padrão) você pergunta “o que foi contestado neste mês”; com deadlineAt, “o que vence neste mês”. A segunda é a que responde a pergunta operacional — quais casos ainda dá tempo de defender.

Exemplo

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100
transactionId
string | null

Retorna as contestações desta transação. Correspondência exata.

paymentId
string | null

Retorna as contestações deste pagamento. Correspondência exata.

status
enum<string>[]

Etapa da contestação: opened (aberta), under_review (em análise), submitted (defesa enviada), won (ganha) ou lost (perdida). Aceita vários valores separados por vírgula.

Available options:
opened,
under_review,
submitted,
won,
lost
startDate
string<date-time> | null

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

endDate
string<date-time> | null

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

dateField
enum<string> | null

Campo a que startDate e endDate se aplicam: openedAt (abertura da contestação) ou deadlineAt (prazo de defesa). Default: openedAt.

Available options:
openedAt,
deadlineAt
sortBy
enum<string> | null

Campo de ordenação: openedAt (abertura) ou deadlineAt (prazo de defesa). Default: openedAt.

Available options:
openedAt,
deadlineAt
sortDir
enum<string> | null

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

Available options:
asc,
desc

Response

Lista de chargebacks

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.