Pular para o conteúdo principal

Consultar canais por documento

Consulta canais e seus dados bancários a partir de um CPF e/ou CNPJ.

MétodoGET
Path/api/channel/by-document
AutenticaçãoJWT no header Authorization, com esquema Bearer
CorpoNão possui

Autenticação e autorização​

Utilize um token JWT válido, obtido pelo endpoint de login.

Esta rota não exige Channel-ID.

Parâmetros de consulta​

ParâmetroTipoObrigatórioDescrição
cpfstringCondicionalCPF a consultar. Obrigatório se cnpj não for informado.
cnpjstringCondicionalCNPJ a consultar. Obrigatório se cpf não for informado.

Informe pelo menos um dos parâmetros com valor não vazio. Ambos podem ser enviados na mesma requisição.

Exemplos cURL​

Substitua CASH_IN_BASE_URL pelo host do Cash-In do ambiente desejado, TOKEN_JWT pelo token e os documentos pelos valores a consultar. Os exemplos utilizam --oauth2-bearer para enviar o JWT no header Authorization com o esquema Bearer.

Consultar por CPF​

curl --get "${CASH_IN_BASE_URL}/api/channel/by-document" \
--oauth2-bearer "${TOKEN_JWT}" \
--header 'Accept: application/json' \
--data-urlencode 'cpf=CPF_DO_TITULAR'

Consultar por CNPJ​

curl --get "${CASH_IN_BASE_URL}/api/channel/by-document" \
--oauth2-bearer "${TOKEN_JWT}" \
--header 'Accept: application/json' \
--data-urlencode 'cnpj=CNPJ_DA_EMPRESA'

Para enviar ambos, inclua os dois parâmetros com --data-urlencode. Não envie um corpo JSON.

Resposta de sucesso​

200 OK — lista de canais retornada.

[
{
"channel_id": "5b3ac5c0-0caf-4c1d-a2b9-5e2ddac1f5dc",
"name": "Canal de exemplo",
"account": {
"bank": "000",
"bank_branch": "0001",
"bank_account": "123456",
"bank_account_digit": "0"
}
}
]
CampoTipoDescrição
channel_idUUIDIdentificador do canal.
namestring ou nullNome do canal.
accountobjectDados bancários do canal.
account.bankstring ou nullBanco.
account.bank_branchstring ou nullAgência.
account.bank_accountstring ou nullNúmero da conta.
account.bank_account_digitstring ou nullDígito da conta.

A resposta é uma lista, não um objeto único. Os dados bancários permanecem como strings, preservando eventuais zeros à esquerda.

Erros​

400 Bad Request — nenhum documento informado ou ambos vazios:

{ "message": "pelo menos um dos campos cpf ou cnpj deve ser preenchido" }

401 Unauthorized — token ausente ou mal formatado:

{ "error": "Token ausente ou inválido" }

Token inválido ou expirado:

{ "error": "Token inválido" }