DiscordStatus
Referência / Reference

Listar cobranças com dados resumidos

get
https://api-sandbox.asaas.com/v3/lean/payments

Lista as cobranças da conta conforme os filtros informados e retorna dados resumidos de cada registro.

Use esta operação quando sua integração precisar consultar cobranças sem receber o objeto completo retornado pela listagem tradicional. Os endpoints com dados resumidos possuem payload de resposta mais leve e retorno mais rápido que os endpoints padrão de cobrança.

A resposta segue o padrão de listagem e paginação da API.

Se precisar dos dados completos de cada cobrança, utilize Listar cobranças.

📘

Acompanhamento de mudanças

Para acompanhar mudanças de estado das cobranças, utilize Webhooks em vez de consultar este endpoint repetidamente.

Use este GET para consultas pontuais, recuperação ou conciliação.

Consulte os eventos de Webhook para cobranças.

Conteúdos relacionados

Guides

Query Params
integer

Elemento inicial da lista

integer
≤ 100

Número de elementos da lista (max: 100)

string

Filtrar pelo Identificador único do cliente

string

Filtrar pelo nome do grupo de cliente

string
enum

Filtrar por forma de pagamento

Allowed:
string
enum

Filtrar por status

string

Filtrar pelo Identificador único da assinatura

string

Filtrar pelo Identificador único do parcelamento

string

Filtrar pelo Identificador do seu sistema

string

Filtrar pela data de pagamento

string
enum

Filtro para retornar cobranças que possuem ou não nota fiscal

Allowed:
string

Filtrar pela data estimada de crédito

string

Filtrar recebimentos originados de um QrCode estático utilizando o id gerado na hora da criação do QrCode

boolean

Filtrar registros antecipados ou não

boolean

Filtrar registros antecipaveis ou não

string

Filtrar a partir da data de criação inicial

string

Filtrar até a data de criação final

string

Filtrar a partir da data de recebimento inicial

string

Filtrar até a data de recebimento final

string

Filtrar a partir da data estimada de crédito inicial

string

Filtrar até a data estimada de crédito final

string

Filtrar a partir da data de vencimento inicial

string

Filtrar até a data de vencimento final

string

Filtrar pelo endereço de e-mail do usuário que criou a cobrança

string

Filtrar pelo identificador único da checkout

Responses

403

Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.

Updated 5 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?