Credenciamento na Subadquirência

Para a utilização das soluções de subadquirência da Celcoin através do BaaS é necessário realizar o credenciamento das contas do seu ecossistema. Essa etapa é necessária para garantirmos que as empresas que utilizaram os serviços estão de acordo com todas as exigências regulatórias necessárias para oferecer produtos de Sub.

🚧

Apenas clientes com contas abertas e ativas no BaaS podem ser credenciados na Sub.

Nesse artigo você irá aprender sobre:

  • Limitações e exceções
  • Credenciar uma conta do BaaS para utilizar soluções da sub
  • Configurar um webhook para receber as informações do credenciamento da conta do BaaS na Sub

Pré requisitos para implementação:

  • Possuir uma chave api da Celcoin, para mais informações acessar esse link
  • Ter familiaridade com apis Rest usando o protocolo OAuth 2.0.
  • Ter o produto/solução contratada, caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

Limitações e exceções:

Essa etapa apenas credencia as contas do BaaS a utilizar os produtos da Sub.

Você deve se integrar a cada produto de acordo com o modelo de negócios.

Solicitar Credenciamento de uma Conta BaaS na Sub Celcoin

Para solicitar o credenciamento das contas BaaS na Sub Celcoin é necessário realizar uma chamada na api Credenciar Sub utilizando o método POST, onde precisa ser preenchido algumas informações necessárias para realizarmos as validações. Os dados necessários estão no quadro "Parâmetros do Body"

Modelo de requisição:

curl -X 'POST' \
  'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation/12345/33662' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "softDescriptor": "Tech Solutions",
  "cnae": "62091",
  "businessDescriptor": "Tech Solutions",
  "websites": [
    "www.seusite.com.br"
  ],
  "monthlyIncome": 100000
}'

Parâmetros do Body:

CampoDescriçãoTipo
softDescriptorTexto que identifica a compra na fatura do cartão de crédito do clientestring
cnaeAtividade econômica de uma empresa ou profissional (caso a empresa possua mais de um CNAE, apenas o **principal **deve ser informado)string
businessDescriptorDescrição do negóciostring
websitesLista de páginas web da sua empresaarray of strings
monthlyIncomeFaturamento mensal da empresa que está sendo cadastradafloat
🚧

Para casos nos quais a venda é feita por meio de Marketplaces, ERP ou gestores de pagamentos, caso estes disponibilizem o site da venda final, seus sites devem ser informados para análise.

Modelo de retorno:

{
  "accreditationId": "82e694bf-ee03-4ba5-ac29-5cad7dd244a9",
  "softDescriptor": "Tech Solutions",
  "account": "362123",
  "status": "PROCESSING"
}

Note que essa api é síncrona, sendo assim, a Celcoin irá retornar para você o resultado final da solicitação de cadastro da empresa.

Tabela descritiva dos campos retornados

CampoDescriçãoTipo
accreditationIdID único da solicitação de credenciamentostring
softDescriptorTexto que identifica a compra na fatura do cartão de crédito do clientestring
accountConta do BaaS que foi solicitado o credenciamentostring
statusStatus do credenciamentostring

👍

Importante

Sandbox

No ambiente de sandbox, possuímos o seguinte comportamento:
Utilize o campo monthlyIncome para simular os cenários de aprovação e recusa de conta

  • Valores de monthlyIncome maiores que R$5000,00 retornarão conta aprovada para utilização da Sub Celcoin de acordo com o modelo descrito abaixo
  • Valores de monthlyIncome menores que R$5000,00 (ou igual) retornarão conta negada para utilização da Sub Celcoin de acordo com o modelo descrito abaixo

**OBS: Os demais campos respeitam as regras e validações descritos nessa documentação (tipo/tamanho)

Configurando webhook

Para conseguir receber da Celcoin o resultado do pedido de credenciamento para utilização dos produtos da sub é necessário realizar a configuração de um webhook.

O webhook é uma forma de receber informações assíncrona e geralmente são disparados gatilhos no formato JSON quando um evento acontece. Na prática, para a API de credenciamento será usado para receber informações sobre a sua conta do BaaS, se foi aprovada ou não para utilização da sub Celcoin.

A Celcoin possui um gerenciador de webhook, para configurar o produto, basta seguir os passos do artigo Cadastrar e Gerenciar Webhooks

Observação: Os demais webhooks da subadquirência seguem um formato de configuração própria, então atente-se, pois a forma de cadastro muda para os retornos dos dados transacionais.

Abaixo será exibido o modelo de retorno do webhook:

Modelos de Retorno Webhooks

Conta aprovada para utilização da Sub Celcoin

{
  "entity": "account-accreditation",
  "context": "BAASPAY",
  "replay": true,
  "body": {
    "entity": "",
    "createTimestamp": "2024-06-17T18:09:19.0406704",
    "status": "SUCCESS",
    "body": {
      "accreditationId": "663167f4fa5fb59547f01ca3",
      "name": "Celcoin",
      "cnae": "62091",
      "account": "45846",

      "document": "1111111111111111",
      "status": "APPROVED"
    },
    "error": null
  },
  "cliente": {
    "clienteId": 123
  }
}

Conta negada para utilização da Sub Celcoin

{
  "entity": "account-accreditation",
  "context": "BAASPAY",
  "replay": true,
  "body": {
    "entity": "",
    "createTimestamp": "2024-06-17T18:09:19.0406704",
    "status": "SUCCESS",
    "body": {
      "accreditationId": "663167f4fa5fb59547f01ca3",
      "name": "Celcoin",
      "cnae": "62091",
      "account": "45846",

      "document": "1111111111111111",
      "status": "REJECTED"
    },
    "error": {
      "errorCode": "CBE-ACT-005",
      "message": "O CNAE informado não é o principal."
    }
  },
  "cliente": {
    "clienteId": 123
  }
}

📘

Depois de configurado, ao realizar a chamada você receberá o resultado da solicitação de credenciamento da sua conta BaaS na Sub no webhook indicado acima