Cartão fidelidade

Integração com o CORE

A plataforma CORE possibilita que um sistema externo se conecte com a ferramenta para fazer a gestão de saldo e captura de meios de pagamento no estilo cartão fidelidade. Para integração da plataforma com seu ERP, será necessária a criação de um endpoint para comunicação. Durante vários fluxos da loja, essa URL será requisitada para verificar o saldo possuído por um cliente com sessão ativa no site.

O que são e onde utilizar o bônus de fidelidade:

O cartão fidelidade é uma funcionalidade para lojistas que permite a você uma forma de integrar o bônus exclusivo de clientes cadastrados entre o CORE e seu ERP. Dessa forma será possível ao cliente final acessar no carrinho e checkout a quantidade de “crédito” que possui.

O cartão fidelidade deverá ser utilizado em casos onde você possui alguma funcionalidade de fidelidade na loja. Por exemplo: bônus por compras anteriores ou alguma outra forma de gratificação por alguma ação do usuário, ou ainda, compra externa de valores na loja.

Como utilizar o bônus de fidelidade:

Para utilizar a fidelidade, será necessário cadastrar no CORE um meio de pagamento do tipo “Meio de pagamento com cartão fidelidade” e a criação de um endpoint externo para a comunicação do CORE com o serviço do lojista. Os passos abaixo assumem que você (lojista) já possui acesso ao menu administração do CORE.

Autenticação

A autenticação deverá ser com Basic Authentication (usuário e senha definidos na criação deste endpoint) e deverá aceitar um POST para < endpoint >/XXXX recebendo como parâmetro um content-type: application/json.

Create

Método POST para < endpoint >/create:

{
    "card_id": "LO-0000",
    "message": "Mensagem cartão fidelidade",
    "is_valid": true,
    "balance": "000",
    "email": "[email protected]",
    "document_number": "11111111111"
}

Campo

Tipo

Descrição

card_id

String

message

String

is_valid

Boolean

balance

String

Saldo

email

String

E-mail do Cliente

document_number

String

CPF do cliente

Balance

Buscar o valor disponível no cartão e exibir ao cliente:

{
    "document_number": "11111111111", /*CPF*/
}

Campo

Tipo

Descrição

document_number

string

CPF do cliente logado

Response

O endpoint retornará um objeto no formato json conforme abaixo, para que o CORE possa exibir os valores do cliente na loja:

{
    "balance": "20000.00",
}

Campo

Tipo

Descrição

balance

decimal

Valor disponível para o cliente logado

Capture

Ação para passar o valor que será capturado do cartão para transacionar na compra:

{
    "order_number": "123144123",
    "card": {
        "card_id": "some value",
        "document_number": "11111111111",
        "email": "some value"
    },
    "value": 160
}

Campo

Tipo

Descrição

order_number

String

Pedido da transação

card_id

String

document_number

String

CPF do cliente

email

String

E-mail do cliente

value

Integer

Valor para a ser descontado da transação a ser paga

Response
A API deverá devolver o identificador da transação.

{
    "transaction_id": "D53215DD-F2B2-436A-B1D2-84FE29F572EF"
}

Campo

Tipo

Descrição

transaction_id

String

Identificador da transação gerado pelo serviço externo.

StatementHtml

Retorna o extrato do cartão, em HTML, para ser exibido na área do cliente

{    
    "document_number": "11111111111",
}

Campo

Tipo

Descrição

document_number

String

CPF do cliente

Configuração básica no CORE

Este passo assume que o endpoint para comunicação externa já foi previamente criado.

Na administração do CORE, faça login. Após isso, acesse a tela de gerenciamento de meios de pagamento localizada em Configs -> Meios de pagamento, conforme imagem abaixo:

Você será redirecionado para uma tela com uma lista de todos os meios de pagamento cadastrados na plataforma, ativos ou não.

Para criar o novo meio de pagamento, clique na opção adicionar meio de pagamento localizada na parte superior esquerda da tela, conforme a imagem abaixo:

Na tela seguinte, você encontrará um campo chamado Fornecedor do Serviço, onde deverá informar o tipo de pagamento desejado para o cadastro. Neste caso, utilizaremos Pagamento com cartão fidelidade. Após isso, clique em próximo.

Após o passo anterior, devemos configurar algumas informações no meio de pagamento. O primeiro passo é dar um Nome a ele e defini-lo como Ativo (A opção padrão do CORE na criação de meios de pagamento já vem como ativo). Veja um exemplo na imagem abaixo:

Na imagem acima, é possível identificar quatro seções do cadastro de meios de pagamento:

• Dados gerais;
• Restrições;
• Integração;
• Personalizados.

O próximo passo para configuração do bônus de fidelidade está na seção Restrições, onde é possível selecionar produtos que serão ou não serão contemplados com esse meio de pagamento. Além disso, é possível escolher o que será contemplado no pagamento com o Loyalty, se não haverá restrição, podendo pagar o total da compra, ou se somente os produto, excluíndo o frete e/ou taxa de juro quando houver.

A maior parte das configurações estão contempladas na seção Integração. O campo Label de exibição é o título do meio de pagamento que será exibido para o cliente final e no admin, layer e painel do cliente quando utilizado para fechamento de pedidos. Neste ponto temos que informar o endpoint previamente criado para a integração. Preencha o campo Url do serviço externo com a Url correspondente e defina um período padrão de Timeout (definido em milissegundos e caso não seja inserido valor, ao salvar será atribuído automaticamente o valor 0 (zero)). Além disso, faz-se necessário a seleção do desejado comportamento do LoyaltyCard (por padrão o comportamento é desconto).
Desconto: usado para subtrair o valor do carrinho, sem levar em consideração o juro.
Meio de pagamento: aplica-se toda a regra no meio de pagamento, inclusive, faz débito do juro quando há.
Por fim, preencher com o Usuário e Senha para autenticação. Veja um exemplo abaixo:

Imagem traz melhor detalhamento da funcionalidade de cada comportamento.Imagem traz melhor detalhamento da funcionalidade de cada comportamento.

Imagem traz melhor detalhamento da funcionalidade de cada comportamento.

Após isso, basta clicar em Salvar ou Salvar e fechar.

Observação: Caso o contrato do canal esteja com meio de pagamento específicos, será necessário adicionar este meio de pagamento recém-criado nos contratos.

Após concluir e salvar a forma de pagamento, num processo futuro de edição, por motivo de segurança, a senha não é exibida. Caso queira alterá-la será necessário marcar checkbox Editar senha e inserir a nova senha.

Por fim clicar em Salvar ou Salvar e fechar. Caso seja marcado a checkbox e não seja inserido nenhum valor, não será possível salva. Vide imagem abaixo:

🚧

Lembre-se de que o meio de pagamento deve-se estar vinculado ao contrato para que possa aparecer no checkout do site.


Did this page help you?