Pular para o conteúdo principal

Cadastro de Conta

O conjunto de endpoints a seguir são destinados a lidar com o Cadastro de uma conta.

A API de Abertura de Contas permite criar contas Efí para seus clientes finais por meio de integração.

Existem dois tipos de abertura de conta:

  1. Abertura de Conta Completa, que é realizada com dados completos, incluindo informações de PEP, renda, patrimônio e cidadanias estrangeiras. O cliente final acessa um link de onboarding para concluir o processo.

  2. Abertura de Conta Simplificada, que é realizada com dados básicos. O cliente final recebe uma notificação via SMS ou WhatsApp para autorizar a integração.


Solicitar abertura de conta completa​

Neste passo, você pode solicitar a abertura de uma conta completa para integração. Basta fornecer os dados detalhados do cliente final, incluindo informações de PEP, renda, patrimônio e cidadanias estrangeiras. Se os dados forem válidos, o cliente final recebe um link de onboarding para concluir o processo de abertura da conta.

Criação de conta/aplicação

Se o cliente final já tiver uma conta na Efí, ele terá duas opções:

  • Criar uma aplicação na conta atual, onde você terá acesso às credenciais e poderá definir os escopos, com excessão dos escopos pix.send, gn.pix.send.read, gn.qrcodes.pay, gn.qrcodes.read, gn.barcode.read, gn.barcode.pay.write e gn.barcode.pay.read;
  • Criar uma conta secundária para o cliente final com as configurações/acessos definidos em sua requisição.

Negação da abertura de conta

Caso o seu cliente recuse o processo de abertura de conta, será necessário esperar 2 dias corridos até iniciar um novo processo.


POST /v1/conta
Requer autorização para o escopo: gn.registration.write


Requisição

{
  "clienteFinal": {
    "cpf": "12345678900",
    "nomeCompleto": "Nome Exemplo",
    "dataNascimento": "01/08/2000",
    "nomeMae": "Exemplo de nome da mãe",
    "celular": "31987654321",
    "email": "[email protected]",
    "endereco": {
      "logradouro": "AV JK",
      "numero": "31",
      "complemento": "",
      "bairro": "Bauxita",
      "cidade": "Ouro Preto",
      "estado": "MG",
      "cep": "35402179"
    },
    "paisNascimento": "Brasil",
    "cidadaniasEstrangeiras": [],
    "renda": "10",
    "patrimonio": "100",
    "pep": false,
    "profissao": "Artista"
  },
  "escoposIntegrados": [
    "cob.write",
    "cob.read",
    "pix.write",
    "pix.read",
    "webhook.write",
    "webhook.read",
    "payloadlocation.write",
    "payloadlocation.read",
    "gn.pix.send.read",
    "gn.pix.evp.write",
    "gn.pix.evp.read",
    "gn.balance.read",
    "gn.settings.write",
    "gn.settings.read"
  ],
  "cupom": "NOVOCUPOM123"
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "conta": {
    "identificador": "92ccd29b-54c9-49fc-b8e8-717a3b373c5e",
    "linkOnboarding": "https://caf.io/id"
  }
}

Recuperar credenciais de uma conta completa​

Recupera as credenciais Client_Id e Client_Secret para integrar à uma conta criada.

GET /v1/conta/:idConta/credenciais
Requer autorização para o escopo: gn.registration.read


Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
"clientId": "92ccd29b-54c9-49fc-b8e8-717a3b373c5e",
"clientSecret": "b2e9dcca-c46d-4b9b-89d2-c625949bea40",
"conta": {
  "numero": "10000",
  "digito": "1",
  "payeeCode": "6edo0034843gfr5trtPtgt343"
},
"escopos": [
  "pix.send",
  "cob.write",
  "webhook.read"
],
"ativo": true
}

Criar certificado de uma conta completa​

Cria o certificado para integrar à uma conta criada.

Conversão da String Base64 para .p12

O output retornado por este endpoint está codificado em base64. O integrador deverá converter a string para um buffer e, em seguida, salvar o conteúdo em um arquivo no formato .p12.


POST /v1/conta/:idConta/certificado
Requer autorização para o escopo: gn.registration.read


Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.

"MIIKYQIBAzCCCicGCSqGSIb3DQEHAaCCChgEggoUMIIKEDCCBMcGCSqGSIb3DQEHAaCCBLgEggS0MIIEsDCCBKwGCyqGSIb3DQEMCgEDoIIEdDCCBHAGCiqGSIb3DQEJFgGgggRgBIIEXDCCBFgwggJAoAMCAQICEJ4WQNAm+z3pWRYsltA2KeAwDQYJKoZIhvcNAQELBQAwgbIxCzAJBgNVBAYTAkJSMRUwEwYDVQQIDAxNaW5hcyBHZXJhaXMxLDAqBgNVBAoMI0VmaSBTLkEuIC0gSW5zdGl0dWljYW8gZGUgUGFnYW1lbnRvMRcwFQYDVQQLDA5JbmZyYWVzdHJ1dHVyYTEgMB4GA1UEAwwXYXBpcy50ZXN0ZWVmaXBheS5jb20uYnIxIzAhBgkqhkiG9w0BCQEWFGluZnJhQHNlamFlZmkuY29tLmJyMB4XDTIzMDkxMjEzNTE1N1oXDTI2MDkxMjEzNTE1N1owHTEOMAwGA1UEAxMFMzA4MjYxCzAJBgNVBAYTAkJSMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvFqf7tNldp0nTEZyxDRTpINayIbD7SIsVuwKgJTFkgzKzSo/CcFGHlamRGWxxpqKoiFZ/dToxD5YQyKpLW+AHSwCMIpRlqyipsr67dXEiVimulpvvmCRpJcnC8MQLWvBOIuomh4Ig3185BxBLwIR79TV1hO7SzeDUvWBZBXbFnadEkXhHuFQV0lwsrFaY2/4K/c3bFkYiWVf3DHYuNeu7fZWXm1kAI6Bx5Tks5oBlVQl2za7X0LnTtoFgZI6/xS0MGbSosW7wk11uqJFSepmo/0HmAZCPlOX4zLz4y1Fs8uKRJpK2kFvP6IN23I5dDSP7yIbCiTayA..."

Exemplo de conversão Base64 para .p12​

O exemplo de código abaixo mostra como converter a string Base64 retornada pelo endpoint em um arquivo .p12.

const fs = require('fs');

var b64string = "";
var buf = Buffer.from(b64string, 'base64');

fs.writeFile('arquivo.p12', buf, (err) => {
  if (err) throw err;
console.log('O arquivo foi criado!');
})

Solicitar abertura de conta simplificada​

Neste passo, você pode solicitar a abertura de uma conta simplificada para integração. Basta fornecer os dados do cliente final. Se os dados estiverem corretos, o cliente final recebe notificação via SMS ou WhatsApp para autorizar a integração à sua conta Efí.

Criação de conta/aplicação

Se o cliente final já tiver uma conta na Efí, ele terá duas opções:

  • Criar uma aplicação na conta atual, onde você terá acesso às credenciais e poderá definir os escopos, com excessão dos escopos pix.send, gn.pix.send.read, gn.qrcodes.pay, gn.qrcodes.read, gn.barcode.read, gn.barcode.pay.write e gn.barcode.pay.read;
  • Criar uma conta secundária para o cliente final com as configurações/acessos definidos em sua requisição.

Negação da abertura de conta

Caso o seu cliente recuse o processo de abertura de conta, será necessário esperar 2 dias corridos até iniciar um novo processo.


Modalidade das contas

Se a conta gerada para o cliente for pessoa física, sem CNPJ vinculado, ela será alocada na modalidade Efí Pro. Em casos em que a conta criada tem um CNPJ vinculado, ela será automaticamente classificada como Efí empresas.


POST /v1/conta-simplificada
Requer autorização para o escopo: gn.registration.write


Requisição

{
  "clienteFinal": {
    "cpf": "12345678900",
    "nomeCompleto": "Nome Exemplo",
    "dataNascimento": "01/08/2000",
    "nomeMae": "Exemplo de nome da mãe",
    "celular": "31987654321",
    "email": "[email protected]",
    "endereco": {
      "cep": "35400000",
      "estado": "MG",
      "cidade": "Ouro Preto",
      "bairro": "Bairro exemplo",
      "logradouro": "Exemplo do nome da rua",
      "numero": "777",
      "complemento": "apto 101"
    }
  },
  "meioDeNotificacao": [
    "sms",
    "whatsapp"
  ],
  "escoposIntegrados": [
    "cob.write",
    "cob.read",
    "pix.write",
    "pix.read",
    "webhook.write",
    "webhook.read",
    "payloadlocation.write",
    "payloadlocation.read",
    "gn.pix.send.read",
    "gn.pix.evp.write",
    "gn.pix.evp.read",
    "gn.balance.read",
    "gn.settings.write",
    "gn.settings.read"
  ],
  "cupom": "NOVOCUPOM123"
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "contaSimplificada": {
    "identificador": "92ccd29b-54c9-49fc-b8e8-717a3b373c5e"
  }
}

Recuperar credenciais de uma conta simplificada​

Recupera as credenciais Client_Id e Client_Secret para integrar à uma conta simplificada.

GET /v1/conta-simplificada/:idContaSimplificada/credenciais
Requer autorização para o escopo: gn.registration.read


Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
"clientId": "92ccd29b-54c9-49fc-b8e8-717a3b373c5e",
"clientSecret": "b2e9dcca-c46d-4b9b-89d2-c625949bea40",
"conta": {
  "numero": "10000",
  "digito": "1",
  "payeeCode": "6edo0034843gfr5trtPtgt343"
},
"escopos": [
  "cob.write",
  "webhook.read"
],
"ativo": true
}

Criar certificado de uma conta simplificada​

Cria o certificado para integrar à uma conta simplificada.

Conversão da String Base64 para .p12

O output retornado por este endpoint está codificado em base64. O integrador deverá converter a string para um buffer e, em seguida, salvar o conteúdo em um arquivo no formato .p12.


POST /v1/conta-simplificada/:idContaSimplificada/certificado
Requer autorização para o escopo: gn.registration.read


Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.

"MIIKYQIBAzCCCicGCSqGSIb3DQEHAaCCChgEggoUMIIKEDCCBMcGCSqGSIb3DQEHAaCCBLgEggS0MIIEsDCCBKwGCyqGSIb3DQEMCgEDoIIEdDCCBHAGCiqGSIb3DQEJFgGgggRgBIIEXDCCBFgwggJAoAMCAQICEJ4WQNAm+z3pWRYsltA2KeAwDQYJKoZIhvcNAQELBQAwgbIxCzAJBgNVBAYTAkJSMRUwEwYDVQQIDAxNaW5hcyBHZXJhaXMxLDAqBgNVBAoMI0VmaSBTLkEuIC0gSW5zdGl0dWljYW8gZGUgUGFnYW1lbnRvMRcwFQYDVQQLDA5JbmZyYWVzdHJ1dHVyYTEgMB4GA1UEAwwXYXBpcy50ZXN0ZWVmaXBheS5jb20uYnIxIzAhBgkqhkiG9w0BCQEWFGluZnJhQHNlamFlZmkuY29tLmJyMB4XDTIzMDkxMjEzNTE1N1oXDTI2MDkxMjEzNTE1N1owHTEOMAwGA1UEAxMFMzA4MjYxCzAJBgNVBAYTAkJSMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvFqf7tNldp0nTEZyxDRTpINayIbD7SIsVuwKgJTFkgzKzSo/CcFGHlamRGWxxpqKoiFZ/dToxD5YQyKpLW+AHSwCMIpRlqyipsr67dXEiVimulpvvmCRpJcnC8MQLWvBOIuomh4Ig3185BxBLwIR79TV1hO7SzeDUvWBZBXbFnadEkXhHuFQV0lwsrFaY2/4K/c3bFkYiWVf3DHYuNeu7fZWXm1kAI6Bx5Tks5oBlVQl2za7X0LnTtoFgZI6/xS0MGbSosW7wk11uqJFSepmo/0HmAZCPlOX4zLz4y1Fs8uKRJpK2kFvP6IN23I5dDSP7yIbCiTayA..."

Exemplo de conversão Base64 para .p12​

O exemplo de código abaixo mostra como converter a string Base64 retornada pelo endpoint em um arquivo .p12.

const fs = require('fs');

var b64string = "";
var buf = Buffer.from(b64string, 'base64');

fs.writeFile('arquivo.p12', buf, (err) => {
  if (err) throw err;
console.log('O arquivo foi criado!');
})

Última atualização em