# Listar cobranças (/docs/cartao/endpoints/charges/get_charges)

## GET /charges

`GET https://api.payzu.io/v1/charges`

Retorna uma lista com as cobranças

### Query params

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `startDate` | string | no | Data inicial para filtrar os resultados |
| `endDate` | string | no | Data final para filtrar os resultados |
| `limit` | number | no | Limite máximo de itens a serem retornados na consulta — default: 10 |
| `page` | number | no | Número da página para a paginação dos resultados — default: 1 |
| `recurrentPaymentId` | string | no | Filtra a cobrança inicial e os ciclos gerados por uma recorrência |

### Responses

**200** Requisição bem sucedida

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `page` | integer | no | Página atual |
| `total` | integer | no | Total de cobranças encontradas |
| `totalPages` | integer | no | Total de páginas |
| `charges` | object[] | no |  |
| `charges.id` | string | no | Identificador da cobrança |
| `charges.externalId` | string | no | Identificador único gerado externamente |
| `charges.postbackUrl` | string | no | Url para notificações sobre o status da cobrança |
| `charges.amount` | number | no | Valor da cobrança em centavos |
| `charges.paymentType` | string | no | Tipo de pagamento da cobrança. Valores em [Códigos de referência](https://docs.payzu.com.br/docs/cartao/reference-codes) |
| `charges.createdAt` | string | no | Data de criação da cobrança |
| `charges.updatedAt` | string | no | Data da última atualização da cobrança |
| `charges.customer` | object | no | Dados do comprador |
| `charges.customer.id` | number | no | Identificador do comprador. |
| `charges.customer.name` | string | no | Nome completo do comprador |
| `charges.customer.identity` | string | no | Número do documento de identificação do comprador |
| `charges.customer.identityType` | string | no | Tipo de documento de identificação do comprador |
| `charges.customer.email` | string | no | E-mail do comprador |
| `charges.customer.birthdate` | string | no | Data de nascimento do comprador |
| `charges.customer.phone` | string | no | Número do telefone do comprador |
| `charges.customer.address` | object | no | Endereço de cobrança |
| `charges.cart` | object[] | no | Carrinho do comprador |
| `charges.cart.name` | string | yes | Nome do produto |
| `charges.cart.quantity` | number | yes | Quantidade do produto |
| `charges.cart.sku` | string | yes | SKU (Stock Keeping Unit - Unidade de Controle de Estoque) do produto |
| `charges.cart.unitPrice` | number | yes | Preço unitário do produto em centavos |
| `charges.creditCardPayment` | object | no | Detalhes do pagamento com cartão de crédito |
| `charges.creditCardPayment.installments` | number | no | Número de parcelas |
| `charges.creditCardPayment.authenticate` | boolean | no | Indica se o comprador foi direcionado ao emissor para autenticação 3DS |
| `charges.creditCardPayment.currency` | string | no | Moeda da cobrança. Lista em [Moedas suportadas](https://docs.payzu.com.br/docs/cartao/currencies) |
| `charges.creditCardPayment.acquirerTransactionId` | string | no | Identificador da transação na adquirente |
| `charges.creditCardPayment.authorizationCode` | string | no | Código de autorização retornado pela adquirente |
| `charges.creditCardPayment.reasonCode` | number | no | Código do motivo do resultado. Lista em [Status e motivos da transação](https://docs.payzu.com.br/docs/cartao/transaction-status) |
| `charges.creditCardPayment.reasonMessage` | string | no | Mensagem do motivo do resultado. Lista em [Status e motivos da transação](https://docs.payzu.com.br/docs/cartao/transaction-status) |
| `charges.creditCardPayment.status` | integer | no | Status da transação. Lista em [Status e motivos da transação](https://docs.payzu.com.br/docs/cartao/transaction-status) |
| `charges.creditCardPayment.returnCode` | string | no | Código de retorno da adquirente, lido na tabela de [Códigos de erro](https://docs.payzu.com.br/docs/cartao/error-codes). O mesmo número tem outro significado na tabela [ABECS](https://docs.payzu.com.br/docs/cartao/abecs-codes), que é o padrão das bandeiras para recusas. |
| `charges.creditCardPayment.returnMessage` | string | no | Mensagem de retorno da adquirente |
| `charges.creditCardPayment.externalAuthentication` | object | no | Dados da autenticação externa 3DS, quando enviados na criação |
| `charges.creditCardPayment.reversedAmount` | number | no | Valor estornado em centavos, quando houver estorno |
| `charges.creditCardPayment.reversedDate` | string | no | Data do estorno, quando houver |
| `charges.creditCardPayment.chargeId` | string | no | Identificador da cobrança |
| `charges.creditCardPayment.card` | object | no | Detalhes do cartão utilizado na cobrança |
| `charges.creditCardPayment.chargebacks` | object[] | no | Chargebacks vinculados à cobrança |
| `charges.recurrence` | object | no | Estado de uma recorrência |
| `charges.recurrence.recurrentPaymentId` | string | no | Identificador da recorrência. Use nos endpoints de consulta e gestão de recorrências |
| `charges.recurrence.interval` | string | no | Intervalo configurado — `MONTHLY`, `ANNUAL` |
| `charges.recurrence.status` | string | no | Status da recorrência. Valores em [Pagamentos recorrentes](https://docs.payzu.com.br/docs/cartao/recurrence) — `ACTIVE`, `INACTIVE`, `ENDED` |
| `charges.recurrence.amount` | number | no | Valor de cada ciclo, em centavos |
| `charges.recurrence.nextRecurrency` | string | no | Data da próxima cobrança automática |
| `charges.recurrence.endDate` | string | no | Data final, se informada na criação |
| `charges.recurrenceCycle` | integer | no | Número do ciclo da recorrência a que esta cobrança pertence: 0 é a cobrança inicial, 1..n são os ciclos gerados automaticamente. Presente apenas em cobranças de recorrência |