Listar cobranças

get

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

Lista as cobranças cadastradas na conta conforme os filtros informados.

Use esta operação para localizar cobranças existentes, realizar consultas e conciliações ou recuperar conjuntos de cobranças vinculados a clientes, assinaturas, parcelamentos e outros recursos.

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

📘
Acompanhamento de mudanças
Para acompanhar mudanças de status 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

offset

integer

Elemento inicial da lista

limit

integer

≤ 100

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

customer

string

Filtrar pelo Identificador único do cliente

customerGroupName

string

Filtrar pelo nome do grupo de cliente

billingType

string

enum

Filtrar por forma de pagamento

Allowed:

status

string

enum

Filtrar por status

subscription

string

Filtrar pelo Identificador único da assinatura

installment

string

Filtrar pelo Identificador único do parcelamento

externalReference

string

Filtrar pelo Identificador do seu sistema

paymentDate

string

Filtrar pela data de pagamento

invoiceStatus

string

enum

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

Allowed:

estimatedCreditDate

string

Filtrar pela data estimada de crédito

pixQrCodeId

string

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

anticipated

boolean

Filtrar registros antecipados ou não

anticipable

boolean

Filtrar registros antecipaveis ou não

dateCreated[ge]

string

Filtrar a partir da data de criação inicial

dateCreated[le]

string

Filtrar até a data de criação final

paymentDate[ge]

string

Filtrar a partir da data de recebimento inicial

paymentDate[le]

string

Filtrar até a data de recebimento final

estimatedCreditDate[ge]

string

Filtrar a partir da data estimada de crédito inicial

estimatedCreditDate[le]

string

Filtrar até a data estimada de crédito final

dueDate[ge]

string

Filtrar a partir da data de vencimento inicial

dueDate[le]

string

Filtrar até a data de vencimento final

user

string

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

checkoutSession

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.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Acompanhamento de mudanças

Conteúdos relacionados

Guides

200Ok

400Bad Request

401Unauthorized