Skip to main content
GET
Essa rota utiliza os certificados e o Bearer Token de Cash In.

Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de Cash In, a chave e a senha na requisição:
file
required
Certificado de Cash In do cliente (client.crt).
file
required
Chave privada do cliente (client.key).
string
required
Senha para descriptografar a chave .key, enviada por e-mail junto com os certificados.

Headers

string
required
Bearer Token de Cash In. Formato: Bearer {access_token}.

Query

string
required
Início do período consultado, no formato RFC 3339. Exemplo: 2026-07-01T00:00:00Z.
string
required
Fim do período consultado, no formato RFC 3339. Exemplo: 2026-07-31T23:59:59Z.
string
Filtra as cobranças pelo CPF do devedor.
string
Filtra as cobranças pelo CNPJ do devedor.
string
Filtra pelo status da cobrança: ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR ou REMOVIDA_PELO_PSP.
integer
Página que você quer consultar. Padrão: 0.
integer
Itens por página, de 1 a 1000. Padrão: 100.

Resposta

object
Parâmetros aplicados na consulta, incluindo período e dados de paginação.
array
Lista de cobranças encontradas no período. Cada item traz txid, status, valor, chave, devedor, calendario e solicitacaoPagador.