v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Listar Pagamentos

Lista pagamentos de boleto de uma conta

get/

Query parameters

startinteger

Quantos registros pular do início da pesquisa, usado para paginação.

limitinteger

Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em paginação.

created_at_fromstring date

Registros criados a partir dessa data passada no parâmetro. Formato (AAAA-MM-DD)

created_at_tostring date

Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD)

statusstring

Usado para filtrar os pagamentos pelo status (pending, processing, rejected, done)

barcodestring

Código de barras do pagamento

updated_at_fromstring date

Registros atualizados a partir dessa data passada no parâmetro. Formato (AAAA-MM-DD)

updated_at_tostring date

Registros atualizados a até esta data passada no parâmetro. Formato (AAAA-MM-DD)

Response

200

idstring

account_idstring

barcodestring

statusstring

document_amount_centsinteger

amount_centsinteger

{"stackTrail":"paths:/:get:responses:200:content:application/json:schema:items:properties:description","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

[
  {
    "id": "00000000000000000000000000000000",
    "account_id": "00000000000000000000000000000000",
    "barcode": "846100000013310502962023004200030007003752691117",
    "status": "pending",
    "document_amount_cents": 13105,
    "amount_cents": 13105,
    "created_at": "2024-08-16T17:09:59-03:00",
    "updated_at": "2024-08-16T17:10:09-03:00"
  }
]