Listar chargebacks
Lista paginada de contestações, com filtros por etapa, transação, pagamento e período.
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).
status aceita uma lista separada por vírgula, e o resultado
traz as contestações em qualquer uma das etapas: ?status=opened,under_review.?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
API Key da Credential (gerada no Backoffice)
Query Parameters
Página da listagem. Padrão: 1.
x >= 1Itens por página. Padrão: 20. Máximo: 100.
1 <= x <= 100Retorna as contestações desta transação. Correspondência exata.
Retorna as contestações deste pagamento. Correspondência exata.
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.
opened, under_review, submitted, won, lost Início do período (ISO 8601 com timezone), inclusive. Aplica-se ao campo indicado em dateField.
Fim do período (ISO 8601 com timezone), inclusive. Aplica-se ao campo indicado em dateField.
Campo a que startDate e endDate se aplicam: openedAt (abertura da contestação) ou deadlineAt (prazo de defesa). Default: openedAt.
openedAt, deadlineAt Campo de ordenação: openedAt (abertura) ou deadlineAt (prazo de defesa). Default: openedAt.
openedAt, deadlineAt Direção da ordenação: asc ou desc. Default: desc.
asc, desc