Conta
Bem-vindo à seção de conta da API. Aqui você encontrará os endpoints relacionados à verificação de disponibilidade da conta para transações.
Verificação de Conta
Endpoint utilizado para verificar se uma conta está disponível para realizar transações, com base no CPF ou CNPJ informado.
Endpoint
POST {{apiUrl}}/v4/account/check/:document
Headers da requisição
| Header | Obrigatório | Valor | Descrição |
|---|---|---|---|
| Accept | Sim | application/json | Formato de resposta aceito |
| Content-Type | Sim | application/json | Formato do corpo da requisição |
| Authorization | Sim | Bearer token | Token de autenticação |
Parâmetros da requisição
O corpo da requisição deve ser enviado no formato JSON com os seguintes campos:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| taxId | string | Sim | CPF (11 dígitos) ou CNPJ (14 dígitos) da conta a ser consultada |
Exemplo de requisição
Request Body
{
"taxId": "84284250604"
}
Resposta
Em caso de sucesso, o servidor retornará um status code 200 OK com um objeto JSON no corpo da resposta:
| Campo | Tipo | Descrição |
|---|---|---|
| taxId | string | CPF/CNPJ enviado na requisição |
| availableForTransaction | boolean | Indica se a conta está disponível para transações (true = aprovada, false = reprovada) |
- availableForTransaction: true: a conta está disponível para transações
- availableForTransaction: false: a conta não está disponível para transações
Conta disponível para transação
Response 200 OK - disponível
{
"taxId": "84284250604",
"availableForTransaction": true
}
Conta não disponível para transação
Response 200 OK - não disponível
{
"taxId": "70347358241",
"availableForTransaction": false
}
Conta não existe para o documento
Response 404 NOT FOUND - não disponível
{
"statusCode": 404,
"message": "Conta não encontrada"
}
Dados de Mock para Homologação
Em ambiente de homologação, é possível simular diferentes cenários utilizando os seguintes CPF/CNPJ no campo taxId do corpo da requisição. O sistema retornará respostas mockadas conforme o mapeamento abaixo:
| Tax ID (CPF/CNPJ) | Disponível para transação |
|---|---|
| 86258863450 | true |
| 70685213633 | false |
| Outro Doc | Erro |
Atenção (ambiente de homologação): Qualquer documento (CPF/CNPJ) diferente dos informados na tabela de mocks acima irá gerar erro ao consultar este endpoint em ambiente de homologação. Utilize exclusivamente os tax IDs listados para testes.