v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Dados Bancários

Realiza a consulta das informações e credenciais de uma conta.

K8 conta- Realiza a consulta de uma determinada conta<br/>Permite que usuários autorizados recuperem informações abrangentes sobre uma conta específica no sistema de pagamentos. Essa API otimiza a gestão de contas, fornecendo uma visão centralizada dos atributos da conta, permitindo que os usuários verifiquem os detalhes da conta, gerenciem as configurações da conta e acessem serviços relacionados à conta.<br/><br/><br/>Consulta os dados e credenciais de uma conta.</br> <br/><br/><br/>Decodificar a Payload:</br> <br/> - É necessário converter a string Base64 URL Safe de volta para a forma original. A string criptografada foi modificada para ser segura para URLs, substituindo os caracteres + e / por - e _, respectivamente. <br/> - Use uma função para substituir - por + e _ por /, em seguida, realize a decodificação Base64 (base64_decode). <br/><br/><br/>Descriptografar a Payload:</br> <br/> Será necessário utilizar o algoritmo AES-128-CBC para descriptografar a payload. Você precisará da chave de criptografia e de um vetor de inicialização (IV). <br/> O IV utilizado durante a criptografia deve ser o mesmo durante a descriptografia. No nosso caso, utilizamos um IV preenchido com bytes nulos. <br/><br/><br/>Segue exemplo de uma função utilizando a linguagem PHP:</br> <br/> <pre> function base64UrlDecode(string $value) <br/> { <br/> return base64_decode(str_replace(['-', '_'], ['+', '/'], $value)); <br/> } <br/><br/> function decryptResponse($data, $key = '') <br/> { <br/> return openssl_decrypt(base64UrlDecode($data), 'AES-128-CBC', $key, OPENSSL_RAW_DATA, (pack('x'.openssl_cipher_iv_length('AES-128-CBC')))); <br/> } <br/><br/> $decryptedPayload = $this->decryptResponse($payload);</pre><br/><br/><br/>A chave para descriptografar o payload deve ser solicitada via email.</br><br/><br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>client-id</td><td>Texto</td><td>Client ID enviado no Header</td><td>Sim</td></tr><tr><td>cnpj</td><td>Texto</td><td>CNPJ da conta</td><td>Sim</td></tr><tr><td>type</td><td>Texto</td><td>Tipo da conta (contaMovimento, contaCobranca ou contaRapida)</td><td>Não</td></tr><tr><td>number</td><td>Texto</td><td>Número da conta</td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de retorno.</td></tr><tr><td>cnpj</td><td>Texto</td><td>CNPJ da conta consultada </td></tr><tr><td>type</td><td>Texto</td><td>Tipo da conta consultada </td></tr><tr><td>dadosBancarios</td><td>-</td><td>Dados bancários da conta consultada </td></tr><tr><td>Agencia - numero</td><td>Texto</td><td>Número da agência da conta consultada </td></tr><tr><td>Agencia - dv</td><td>Texto</td><td>Número identificador da agência da conta consultada </td></tr><tr><td>Conta - numero</td><td>Texto</td><td>Número da conta da conta consultada </td></tr><tr><td>Conta - dv</td><td>Texto</td><td>Número identificador da conta da conta consultada </td></tr><tr><td>credenciaisApis</td><td>-</td><td>Credenciais de API integradas da conta </td></tr><tr><td>Conta - clientId</td><td>Texto</td><td>Client ID da API Clientes </td></tr><tr><td>Conta - clientSecret</td><td>Texto</td><td>Client Secret da API Clientes </td></tr><tr><td>Gateway - clientId</td><td>Texto</td><td>Client ID do Gateway integrado </td></tr><tr><td>Gateway - secret</td><td>Texto</td><td>Client Secret do Gateway integrado </td></tr><tr><td>Gateway - aesKey</td><td>Texto</td><td>AES Key do Gateway integrado </td></tr><tr><td>Cobranças - clientId</td><td>Texto</td><td>Client ID do Cobranças </td></tr><tr><td>Cobranças - secret</td><td>Texto</td><td>Client Secret do Cobranças </td></tr><tr><td>Cobranças - aesKey</td><td>Texto</td><td>AES Key do Cobranças </td></tr><tr><td>Cliente - clientePagamentosId</td><td>Texto</td><td>Client ID de Pagamentos </td></tr></tbody></table>

get/api/v1/account

Query parameters

cnpjstring required
Example:00000000000100

CNPJ da conta.

typestring
Example:contaMovimento

Tipo da conta.

numberstring
Example:0550000116

Número da conta.

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

CNPJ consultado com sucesso.

messagestring

Example response

{
  "message": "CNPJ consultado com sucesso.",
  "data": [
    {
      "cnpj": "99.999.999/0001-91",
      "type": "conta_corrente",
      "dadosBancarios": [
        {
          "agencia": [
            {
              "numero": "0001",
              "dv": "9"
            }
          ],
          "conta": [
            {
              "numero": "0001",
              "dv": "0"
            }
          ]
        }
      ]
    }
  ]
}