Listar Pagamentos

get

https://{apiHost}/v2/payments

Lista todos os pagamentos de qualquer tipo (PIX, Boleto, DARF, Tributos, Contas). Suporta filtros e paginação. Este é um endpoint unificado que retorna payments de todos os tipos através de uma única consulta.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Número da Página

per_page

integer

≤ 50

Defaults to 50

Quantidade de registros por página

kind

string

enum

Filtrar por tipo de pagamento

Allowed:

status

string

enum

Filtrar por status

Allowed:

created_from

date

Filtrar por data de criação inicial (formato: YYYY-MM-DD, inclusivo)

created_to

date

Filtrar por data de criação final (formato: YYYY-MM-DD, inclui o dia inteiro)

updated_from

date

Filtrar por data de atualização inicial (formato: YYYY-MM-DD, inclusivo)

updated_to

date

Filtrar por data de atualização final (formato: YYYY-MM-DD, inclui o dia inteiro)

scheduled_from

date

Filtrar por data de agendamento inicial (formato: YYYY-MM-DD)

scheduled_to

date

Filtrar por data de agendamento final (formato: YYYY-MM-DD)

scheduled

boolean

Filtrar apenas pagamentos agendados (true) ou não agendados (false)

identifier

string

Buscar por identificador (busca parcial)

external_id

string

Filtrar por ID externo

Headers

User-Agent

string

Informar um e-mail válido para contatos.

Response

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200Pagamentos encontrados