Documentação completa

Outras Informações

Notificações

O cel_cash faz o envio de notificações por e-mail gerenciáveis em diversos eventos e datas de envio. (Por exemplo: Ao cadastrar uma cobrança, 5 dias antes do vencimento da transação, etc.) Caso não queira que o cel_cash faça o envio das notificações, você pode desativá-las dentro do sistema. Também é possível ativar o envio de notificações por SMS ou WhatsApp.

Módulos

A utilização de alguns conteúdos presentes na documentação exigem a ativação dos módulos no sistema, e só irão funcionar após instalar o módulo dentro do sistema.
São eles:

  • Conciliação bancária.
  • Pré-autorização.
  • Desconto condicional.
  • Usar integration ID.
  • NFS-e.
  • Campos personalizados.
Os módulos podem ser instalados através da Loja de Módulos dentro do sistema.

Antifraude

bPara reduzir o número de fraudes nas suas transações, o cel_cash está integrado com dois sistemas de antifraude: o da Konduto e o da ClearSale.


Para que estes dois sistemas de antifraude comprovem a autenticidade da transação, deverá ser implementado um código JAVASCRIPT na área de código onde está localizado o  fluxo de compra do usuário (dentro do body, logo abaixo da tag  <body>). 


Você pode COPIAR E COLAR o código Javascript da integração que você contratou.


ATENÇÃO!!! O código que VOCÊ IRÁ COPIAR E COLAR será SOMENTE o código DO SISTEMA ANTIFRAUDE CONTRATADO. 


Konduto


1. Konduto > Código geral
A Konduto solicita que você COPIE E COLE o código JavaScript abaixo com o PUBLIC_KEY que a Konduto fornecerá.


var __kdt = __kdt || [];

__kdt.push({"public_key": "PUBLIC_KEY_KONDUTO"}); // A chave pública identifica a sua loja  

	(function() {   

		var kdt = document.createElement('script');   

		kdt.id = 'kdtjs'; kdt.type = 'text/javascript';   

		kdt.async = true;    kdt.src = 'https://i.k-analytix.com/k.js';   

		var s = document.getElementsByTagName('body')[0];   

		s.parentNode.insertBefore(kdt, s);

  	 })();

Este código, deve ser inserido em TODAS as páginas do seu ecommerce.


2. Konduto > SessionID
Além do código acima, você deve enviar via API, a informação sessionId dentro do nó antifraud na API. Para isso, você deve recuperar o sessionid na sua página de checkout, utilizando o código JS abaixo:


window.onload = function() {

            var period = 300;

            var limit = 20 * 1e3;

            var nTry = 0;

            var intervalID = setInterval(function() {

                var clear = limit / period <= ++nTry;

                if ((typeof(Konduto) !== "undefined") &&

                    (typeof(Konduto.getVisitorID) !== "undefined")) {

                    visitorID = window.Konduto.getVisitorID(); //esta é a variável que possui o valor do sessionId que deve ser enviado via api



                    //Exemplo de como criar um input automaticamente dentro do seu formulário com o valor do sessionId recuperado

                    var element = document.createElement("input");

                    element.type = "hidden";

                    element.name = "sessionId"; //Name do input criado automaticamente

                    element.value = visitorID; //Value do input criado automaticamente

                    document.getElementById("idDoSeuFormulario").appendChild(element); //Preencha este valor com o id do seu formulário

                    //Fim do exemplo de como criar o input automaticamente, caso necessário, este bloco pode ser removido



                    clear = true;

                }

                if (clear) {

                    clearInterval(intervalID);

                }

            }, period);

        };

3. Konduto > Tags
Para aumentar ainda mais a eficiência do antifraude, adicione as meta tags abaixo no seu site:


<!-- Todas as páginas do checkout --> 

<meta name="kdt:page" content="checkout">



<!-- Detalhe de produto --> 

<meta name="kdt:page" content="product"> 

<meta name="kdt:product" content="sku=123, name=Camiseta Verde"> 



<!-- Página de 'Esqueci minha senha' --> 

<meta name="kdt:page" content="password-reset">

CLEARSALE


A ClearSale solicita que você COPIE E COLE O CÓDIGO ABAIXO, preenchendo o SessionId do cliente durante o processo de compra.


O SessionID é um identificador único, gerado pelo seu site/sistema, que acompanha o cliente durante o processo de compra no site.


(function (a, b, c, d, e, f, g) {

   (function (a, b, c, d, e, f, g) {

   a['CsdpObject'] = e;

   a[e] = a[e] || function () {

      (a[e].q = a[e].q || []).push(arguments)

   }, a[e].l = 1 * new Date();

   f = b.createElement(c),

      g = b.getElementsByTagName(c)[0];

   f.async = 1;

   f.src = d;

   g.parentNode.insertBefore(f, g)

})(window, document, 'script', '//device.clearsale.com.br/p/fp.js', 'csdp');

csdp('app', 'GalaxPay');

csdp('sessionid', 'SESSION_ID_DO_CLIENTE');


Campos obrigatórios: Para que o sistema de ANTIFRAUDE CONTRATADO rode é preciso que o código tenha os envios dos campos CPF/CNPJ  E TELEFONE do usuário obrigatórios. Caso não seja enviado algum campo obrigatório o nó de antifraude não deve ser enviado no PAYLOAD da chamada da API, pois caso o nó seja enviado sem os campos obrigatórios a transação não será processada no sistema de antifraude contratado e o sistema retornará uma mensagem de ERRO. 


 

Subcontas

1. Autenticação


a. Na autenticação, para utilizar os endpoints de subcontas, serão necessários enviar os scopes company.write e company.read.


b. A autenticação na conta principal irá conseguir manipular os seguintes endpoints:


i. Criação de subcontas, ii. Listar subcontas, iii. Alteração de subcontas, iv. Inativação de subcontas.


c. Assim que criada uma subconta, será necessário autenticar utilizando as credenciais dela para manipular os seguintes endpoints:


i. Obtendo documentos necessários de envio para validação da Subconta.


ii. Envio de documentos para a Subconta.


2. Criação de subcontas


a. Para a criação de contas PF ou PJ possui alguns campos específicos:


b. Em caso de conta PJ, o campo typeCompany possui as opções abaixo:



  • ltda = LTDA

  • eireli = Eireli

  • association = Associações/Condomínios

  • individualEntrepreneur = Empresário individual

  • mei = MEI

  • sa = S/A

  • slu = SLU


3. Listar subcontas


a. A listagem de subcontas irá retornar todas as contas ativas ou não ativas em sua conta principal.


b. A listagem até então traz todas as contas e todas suas informações.


c. É possível buscar por documentos ou galaxPayIds específicos.


4. Alteração de subcontas - A alteração de subcontas permite alterar apenas os campos de endereços.


5. Inativação de Subconta


a. Este endpoint irá inativar a subconta, não sendo possível o cadastro de clientes, contratos/vendas e planos para esta conta.


b. Após inativação, irá constar no histórico de ações da conta principal o IP, Data/Hora e a conta que foi inativada.


6. Obtendo documentos necessários de envio para validação da Subconta


a. Este endpoint deverá ser utilizado autenticado na subconta, ele irá retornar as informações necessárias para o envio de informações sobre a empresa.


b. Além dos campos, este endpoint irá fornecer quais são os arquivos que deverão ser enviados para aquela empresa.


c. Em casos de documentos pessoais, o endpoint irá retornar um nó de CNH e RG. Porém, é necessário apenas o envio das informações de um dos nós.


Exemplo: Caso envie todos os documentos relacionados à CNH, não será necessário o envio dos documentos do RG. O contrário também acontece.


d. O campo type = “Tipo de associado” possui as opções abaixo, que são: 


i. partner = Sócio , ii. attorney = Procurador , iii. personinvolved = Pessoa envolvida


7. Envio de documentos para subconta - Este endpoint será utilizado para enviar os campos e arquivos que o endpoint “Obtendo documentos necessários de envio para validação da subconta” informou que seria necessário.


8. Webhooks


a. Após a análise da conta pela equipe de compliance da empresa, o status da verificação da conta irá mudar, sendo empty, denied ou approved. Sendo assim, será enviado o evento company.verifyDocuments.


i. O status empty significa que os documentos ainda não foram enviados para análise.


ii. O status denied significa que os documentos não estão válidos por um ou mais motivos.


b. Estes motivos irão retornar no nó Verification->Reasons 


iii. O status approved significa que os documentos comprovam a veracidade das informações e foram aprovados para utilizar o cel_cash.