> For the complete documentation index, see [llms.txt](https://docs.barte.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.barte.com/api-reference/pedidos-e-cobrancas/cobrancas/listar-cobrancas.md).

# Listar Cobranças

## Listar cobranças

> Retorna uma lista paginada de cobranças com filtros

```json
{"openapi":"3.0.0","info":{"title":"Barte Payment Service API - Charges","version":"2.0.0"},"servers":[{"url":"https://api.barte.com","description":"Servidor de Produção"},{"url":"https://sandbox-api.barte.com","description":"Servidor de Sandbox"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Token-Api","description":"Token de autenticação para acesso à API"}},"schemas":{"ChargeListResponse":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"title":{"type":"string"},"expirationDate":{"type":"string","format":"date"},"value":{"type":"number","format":"double"},"paymentMethod":{"type":"string","enum":["CREDIT_CARD","DEBIT_CARD","PIX","BANK_SLIP","CREDIT_CARD_EARLY_SELLER","CREDIT_CARD_EARLY_BUYER"]},"status":{"type":"string","enum":["SENT","PENDING","AUTHORIZED","CAPTURED","PAID","CANCELED","REFUNDED","PARTIALLY_REFUNDED","CHARGEBACK","EXPIRED","REFUND"]},"customer":{"$ref":"#/components/schemas/CustomerListResponse"},"authorizationCode":{"type":"string"},"authorizationNsu":{"type":"string"},"refunds":{"type":"array","items":{"type":"object"}},"createdAt":{"type":"string"},"paidDate":{"type":"string","format":"date"},"originalValue":{"type":"number","format":"double"},"installments":{"type":"integer"},"brand":{"type":"string"},"errorReason":{"type":"string","nullable":true}}},"CustomerListResponse":{"type":"object","properties":{"document":{"type":"string"},"type":{"type":"string","enum":["CPF","CNPJ","SSN"]},"name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"}}},"Error":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"ErrorDetail":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"string","enum":["PAYMENT-0000","PAYMENT-0500","PAYMENT-9999","BAR-0300","BAR-0502","BAD_REQUEST","FORBIDDEN","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","UNSUPPORTED_MEDIA_TYPE","BAR-7001"]},"title":{"type":"string","enum":["BUSINESS_SELLER","BUSINESS_CHECKOUT","BUSINESS_COMMON","BUSINESS_SECURITY","BUSINESS_SUBSCRIPTION","INVALID_REQUEST_PARAM","BUSINESS_METRIC","BUSINESS_ACCOUNTANCY","BUSINESS_NOTIFICATION","BUSINESS_BARTE","BUSINESS_COMPANY","BUSINESS_INVOICE","BUSINESS_TRANSFER","BUSINESS_CARD","BUSINESS_ORDER","card_not_supported"]},"description":{"type":"string"},"action":{"type":"string"},"additionalInfo":{"type":"object","additionalProperties":{"type":"object"}}}},"Metadata":{"type":"object","properties":{"totalRecords":{"type":"integer"},"totalPages":{"type":"integer"},"requestDatetime":{"type":"string","format":"date-time"}}}}},"paths":{"/v2/charges":{"get":{"summary":"Listar cobranças","description":"Retorna uma lista paginada de cobranças com filtros","tags":["Cobranças"],"parameters":[{"name":"X-Token-Api","in":"header","required":true,"schema":{"type":"string"},"description":"Token de autenticação para acesso à API"},{"name":"Content-Type","in":"header","required":false,"schema":{"type":"string","enum":["application/json"]},"description":"Tipo de conteúdo da requisição"},{"name":"x-ip-origin-request","in":"header","required":false,"schema":{"type":"string"},"description":"IP de origem da requisição"},{"name":"x-idempotency-key","in":"header","required":false,"schema":{"type":"string"},"description":"Chave de idempotência"},{"name":"customerDocument","in":"query","required":false,"schema":{"type":"string"},"description":"Documento do cliente para filtro"},{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Nome para filtro"},{"name":"email","in":"query","required":false,"schema":{"type":"string","format":"email"},"description":"Email para filtro"},{"name":"document","in":"query","required":false,"schema":{"type":"string"},"description":"Documento para filtro"},{"name":"notificationEmail","in":"query","required":false,"schema":{"type":"string","format":"email"},"description":"Email de notificação para filtro"},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["PENDING","AUTHORIZED","CAPTURED","CANCELED","REFUNDED","PARTIALLY_REFUNDED","CHARGEBACK","EXPIRED"]},"description":"Status da cobrança para filtro"},{"name":"paymentMethod","in":"query","required":false,"schema":{"type":"string"},"description":"Método de pagamento para filtro"},{"name":"expirationDateInitial","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Data inicial de expiração para filtro"},{"name":"expirationDateFinal","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Data final de expiração para filtro"},{"name":"startCreatedAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Data inicial de criação para filtro"},{"name":"endCreatedAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Data final de criação para filtro"},{"name":"sort","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"description":"Critérios de ordenação (sort=name,asc&sort=createdAt,desc)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Número da página (começando em 0)"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"default":20},"description":"Quantidade de itens por página"},{"name":"idempotencyKey","in":"query","required":false,"schema":{"type":"string"},"description":"Chave de idempotência como query parameter"}],"responses":{"200":{"description":"Lista de cobranças retornada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ChargeListResponse"}},"totalElements":{"type":"integer"},"totalPages":{"type":"integer"},"size":{"type":"integer"},"number":{"type":"integer"}}}}}},"400":{"description":"Erro de validação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Token inativo ou inexistente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Acesso negado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Muitas requisições","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro interno do servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.barte.com/api-reference/pedidos-e-cobrancas/cobrancas/listar-cobrancas.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.