Esta rota permite consultar todos os pagamentos realizados pela conta Paytime, atualmente limitados a pagamentos de boletos bancários.
Nome Tipo Obrigatório Descrição integration-keystring Sim Chave de integração. x-token string Sim Token utilizado para autenticação. Pode ser encontrado no portal da API. AuthorizationAuth Type Bearer Token Sim Inserir o Bearer Token, gerado na rota Auth
Nome Tipo Local Descrição Exemplo filtersstring (JSON) query Filtros personalizados. Campos disponíveis: status, amount, expected_on, created_at, establishment.id, entre outros. { "status": "CREATED" }searchstring query Texto de busca livre nos campos _id, establishment.first_name, marketplace.document, etc. 123456perPagenumber query Limitado ao máximo de 100 por página. 20pagenumber query Página a ser retornada. 1sortersstring (JSON) query Lista de ordenação. [{"column":"created_at","direction":"DESC"}]
JSON
{
"total": 1,
"page": 1,
"perPage": 20,
"lastPage": 1,
"data": [
{
"_id": "68fa6717335fe7e377c83322",
"status": "PROCESSING",
"expected_on": "2025-10-23T12:00:00.000Z",
"amount": 150000,
"payment_details": {
"balance": 150000,
"card": 0,
"total": 150000,
"fees": 0
},
"establishment": {
"id": 155100,
"type": "BUSINESS",
"access_type": "ACQUIRER",
"active": 1,
"first_name": "Teste Sandbox",
"last_name": "Solucoes",
"document": "11299221000129"
},
"marketplace": {
"id": 26,
"type": "LICENSED",
"nickname": "Parceiro Integrações",
"active": 1,
"first_name": "Webhooks Integrações",
"last_name": "API Integrações",
"document": "60274849000185"
},
"created_at": "2025-10-23T17:34:15.554Z"
}
]
}Campo Tipo Descrição total numberQuantidade total de registros retornados. page numberPágina atual dos resultados paginados. perPage numberQuantidade de registros exibidos por página. lastPage numberNúmero total de páginas disponíveis. data arrayLista de pagamentos retornados conforme filtros e paginação.
Campo Tipo Descrição _id stringIdentificador único do pagamento. status stringStatus atual do pagamento. Valores possíveis: PAID, PENDING, PROCESSING, REFUNDED, CANCELED expected_on string($date-time)Data prevista para o pagamento. amount numberValor total do pagamento.
Campo Tipo Descrição balance numberValor pago utilizando saldo da conta. card numberValor pago utilizando cartão. total numberValor total do pagamento (saldo + cartão). fees numberValor total das taxas aplicadas.
Campo Tipo Descrição id numberIdentificador do estabelecimento. type stringTipo do estabelecimento (INDIVIDUAL ou BUSINESS). access_type stringTipo de acesso do estabelecimento. active numberIndica se o estabelecimento está ativo (1 ou 0). first_name stringNome / Razão Social. last_name stringSobrenome / Nome Fantasia. document stringCPF ou CNPJ do estabelecimento.
Campo Tipo Descrição id numberIdentificador do marketplace. type stringTipo do marketplace (WHITELABEL, LICENSED, REPRESENTATIVE). nickname stringApelido ou nome curto do marketplace. active numberIndica se o marketplace está ativo (1 ou 0). first_name stringNome / Razão Social. last_name stringSobrenome / Nome Fantasia. document stringCPF ou CNPJ do marketplace.
Campo Tipo Descrição created_at string($date-time)Data e hora da criação do pagamento. payment_date string($date-time)Data e hora em que o pagamento foi efetivado.
Os pagamentos de boletos são processados via Banking Paytime.
Para acompanhar a evolução de status, é essencial consumir os webhooks relacionados, como updated-billet-status.
A resposta desta rota serve para consultas e conciliação dos pagamentos já registrados no sistema.
