> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar chargebacks
> Lista paginada de contestações, com filtros por etapa, transação, pagamento e período.
`GET /chargebacks`
Faz parte do recurso [Chargebacks](/pt-BR/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](/pt-BR/convencoes)).
**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](/pt-BR/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.
```bash theme={null}
?dateField=deadlineAt&startDate=2026-07-01T00:00:00-03:00&endDate=2026-07-31T23:59:59-03:00&status=opened,under_review
```
## Exemplo
```bash theme={null}
curl -G https://api.sandbox.z2pay.com/v1/chargebacks \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
--data-urlencode "status=opened,under_review" \
--data-urlencode "dateField=openedAt" \
--data-urlencode "startDate=2026-06-01T00:00:00-03:00" \
--data-urlencode "endDate=2026-06-30T23:59:59-03:00" \
--data-urlencode "sortDir=desc" \
--data-urlencode "limit=10"
```
```json theme={null}
{
"data": [
{
"id": "cbk_sadcdemslpvvxfn87kpzgjgy2",
"transactionId": "txn_zbivi7anej6en8lu8fxnv0mgq",
"paymentId": "pay_v9amuqt179u31q34g6nyipf5y",
"externalId": "chb_pgmto_abc123",
"amount": 14990,
"currency": "BRL",
"status": "under_review",
"reasonCode": "4853",
"reason": "Produto não recebido",
"deadlineAt": "2026-07-01T23:59:59-03:00",
"openedAt": "2026-06-24T10:12:00-03:00",
"resolvedAt": null,
"createdAt": "2026-06-24T10:12:01-03:00",
"updatedAt": "2026-06-24T10:12:03-03:00"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1
}
}
```
## OpenAPI
````yaml openapi/psp.json GET /chargebacks
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/chargebacks:
get:
tags:
- Chargebacks
summary: Listar chargebacks
description: Retorna chargebacks com paginação e filtros.
operationId: ChargebackController_list
parameters:
- name: page
in: query
required: false
description: 'Página da listagem. Padrão: 1.'
schema:
type: integer
minimum: 1
default: 1
description: 'Página da listagem. Padrão: 1.'
- name: limit
in: query
required: false
description: 'Itens por página. Padrão: 20. Máximo: 100.'
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: 'Itens por página. Padrão: 20. Máximo: 100.'
- name: transactionId
in: query
required: false
description: Retorna as contestações desta transação. Correspondência exata.
schema:
type: string
nullable: true
description: Retorna as contestações desta transação. Correspondência exata.
- name: paymentId
in: query
required: false
description: Retorna as contestações deste pagamento. Correspondência exata.
schema:
type: string
nullable: true
description: Retorna as contestações deste pagamento. Correspondência exata.
- name: status
in: query
required: false
description: >-
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.
schema:
type: array
items:
type: string
enum:
- opened
- under_review
- submitted
- won
- lost
description: >-
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.
- name: startDate
in: query
required: false
description: >-
Início do período (ISO 8601 com timezone), inclusive. Aplica-se ao
campo indicado em `dateField`.
schema:
type: string
format: date-time
nullable: true
description: >-
Início do período (ISO 8601 com timezone), inclusive. Aplica-se ao
campo indicado em `dateField`.
- name: endDate
in: query
required: false
description: >-
Fim do período (ISO 8601 com timezone), inclusive. Aplica-se ao
campo indicado em `dateField`.
schema:
type: string
format: date-time
nullable: true
description: >-
Fim do período (ISO 8601 com timezone), inclusive. Aplica-se ao
campo indicado em `dateField`.
- name: dateField
in: query
required: false
description: >-
Campo a que `startDate` e `endDate` se aplicam: `openedAt` (abertura
da contestação) ou `deadlineAt` (prazo de defesa). Default:
`openedAt`.
schema:
type: string
enum:
- openedAt
- deadlineAt
nullable: true
description: >-
Campo a que `startDate` e `endDate` se aplicam: `openedAt`
(abertura da contestação) ou `deadlineAt` (prazo de defesa).
Default: `openedAt`.
- name: sortBy
in: query
required: false
description: >-
Campo de ordenação: `openedAt` (abertura) ou `deadlineAt` (prazo de
defesa). Default: `openedAt`.
schema:
type: string
enum:
- openedAt
- deadlineAt
nullable: true
description: >-
Campo de ordenação: `openedAt` (abertura) ou `deadlineAt` (prazo
de defesa). Default: `openedAt`.
- name: sortDir
in: query
required: false
description: 'Direção da ordenação: `asc` ou `desc`. Default: `desc`.'
schema:
type: string
enum:
- asc
- desc
nullable: true
description: 'Direção da ordenação: `asc` ou `desc`. Default: `desc`.'
responses:
'200':
description: Lista de chargebacks
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
description: Identificador único do registro.
transactionId:
type: string
description: ID da transação relacionada ao registro.
paymentId:
type: string
description: ID do pagamento relacionado ao registro.
externalId:
type: string
nullable: true
description: >-
Identificador do chargeback no sistema do
adquirente/PSP.
amount:
type: integer
description: Valor em centavos.
currency:
type: string
description: 'Moeda no padrão ISO 4217 (ex.: BRL).'
status:
type: string
description: >-
Situação da contestação. Valores: `opened`,
`under_review`, `submitted`, `won`, `lost`.
reasonCode:
type: string
nullable: true
description: >-
Código do motivo do chargeback informado pela
bandeira.
reason:
type: string
nullable: true
description: Motivo informado para a operação.
deadlineAt:
type: string
format: date-time
nullable: true
description: >-
Data e hora limite para envio da defesa do
chargeback (ISO 8601).
openedAt:
type: string
format: date-time
nullable: true
description: >-
Data e hora em que o chargeback foi aberto (ISO
8601).
resolvedAt:
type: string
format: date-time
nullable: true
description: >-
Data e hora em que o chargeback foi resolvido (ISO
8601).
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: >-
Data e hora da última atualização do registro (ISO
8601).
description: Lista de registros retornados na página atual.
pagination:
type: object
properties:
page:
type: integer
description: Página atual retornada.
limit:
type: integer
description: Quantidade de itens por página.
total:
type: integer
description: Total de itens que atendem ao filtro.
totalPages:
type: integer
description: Total de páginas disponíveis.
description: Dados de paginação do resultado.
example:
data:
- id: cbk_v5wylkgvv2rls5tihmuybrz9v
transactionId: txn_aqbcw2lky42xfidw5pcdss8h1
paymentId: pay_jxt9b5qv1x0h0h8ustleqjgr8
externalId: ch_mw198ybczrn8y2fd6y7dnznft
amount: 14990
currency: BRL
status: under_review
reasonCode: '4853'
reason: Produto ou serviço não recebido
deadlineAt: '2025-07-06T23:59:59.000Z'
openedAt: '2025-06-29T10:00:00.000Z'
resolvedAt: null
createdAt: '2025-06-29T10:00:05.000Z'
updatedAt: '2025-06-29T10:00:10.000Z'
pagination:
page: 1
limit: 20
total: 1
totalPages: 1
'400':
description: >-
Requisição inválida — algum parâmetro ou campo do corpo não passou
na validação
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
issues:
type: array
description: >-
Um item por campo rejeitado. Nunca vem vazio: se há
400 de validação, há pelo menos um.
items:
type: object
properties:
path:
type: string
description: >-
Campo que falhou. Vem vazio quando o erro é do
corpo como um todo.
message:
type: string
description: O que há de errado com esse campo.
example:
error:
code: VALIDATION_ERROR
message: Validation failed
issues:
- path: status
message: >-
Status inválido. Valores aceitos: pending,
waiting_payment, paid, refused, canceled, refunded
- path: startDate
message: >-
Data deve ser ISO 8601 com timezone (ex.:
2026-06-24T00:00:00Z)
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````