English
Docs
AtendimentoAPI Status

Koin

A Koin é uma empresa de meios de pagamento que oferece a solução Boleto Parcelado. O Boleto Parcelado permite que os compradores realizem pagamentos em lojas virtuais usando a experiência do BNPL.

Integração com a Koin

A integração com a Koin consiste em três passos:

  1. Configuração do checkout;
  2. Obtenção das parcelas;
  3. Solicitação da autorização.

Cenários de teste

Confira os números de CPF disponíveis para os testes de solicitação, para que possa simular alguns tipos de retorno em ambiente sandbox:

CPFProviderReturnCodeProviderReturnMessage
354.574.310-10
731.143.850-01
054.920.250-15
555.030.660-30
486.269.590-60		200.3Aprovado automaticamente
898.914.640-24
451.625.980-03
420.003.140-07
192.236.580-71
983.579.360-32		304.1Reprovado automaticamente
546.723.960-02
133.588.530-71
943.303.990-40
121.190.460-18
585.587.770-12		312.23Análise Manual

Passo 1 - Configurando o checkout

A Koin necessita de algumas informações sobre o comprador para consultar as parcelas disponíveis e finalizar o pedido. Para isso, você deverá incluir em seu checkout os Termos e Condições da Koin e o script para obtenção do FraudID.

Termos e Condições Koin

A sua página de checkout precisa exibir ou oferecer acesso aos Termos e Condições da Koin para que o comprador fique ciente sobre como funciona essa política de crédito.

O link para o Termos de Condições da Koin é: https://www.koin.com.br/termos-e-condicoes/.

Você deve configurar o seu checkout de forma que a transação só possa prosseguir após o aceite dos termos.

Obtendo o FraudID

O FraudID é a identificação digital do dispositivo do comprador, e é composto por uma série de dados coletados na página de checkout. O FraudID deverá ser informado na requisição de autorização à API do Gateway de Pagamento no campo FingerprintId (passo 3). Cada requisição de autorização deverá conter um FraudID diferente.

A Koin usa as informações contidas no FraudID para analisar o comprador e oferecer a melhor condição de parcelamento.

Para gerar o FraudID, você deve inserir um script em JavaScript com a URL da Koin:

<html>		
  <head>
  <script type="text/javascript" src="https://resources.koin.com.br/scripts/koin.min.js">
  </script>
  	<script type="text/javascript">
  	   window.onload = function() {
  		GetKoinFraudID(function (guid) { 	
  		document.getElementById('fraudId').innerHTML = guid;});
  			}	
  	</script>
  </head>
    <body>
         FraudId: <span id="fraudId"></span>
    </body>
</html>

Passo 2 - Obtendo as parcelas

Para que você possa exibir a opção de parcelamento em seu checkout é necessário que a sua aplicação faça uma requisição à API de Consulta de Parcelas.

A resposta da requisição apresentará as opções de parcelamento, identificadas pelo campo Options.Id. Cada opção irá apresentar o número de parcelas disponíveis, o valor de cada parcela, a data de vencimento da primeira parcela e taxas.

Como o comprador vai visualizar as parcelas?
Uma opção é inserir em seu checkout um botão para exibição de parcelas, como "Consultar parcelas".

Caso qualquer um dos itens da requisição seja alterado pelo comprador será necessário realizar uma nova consulta.


Passo 3 - Solicitando autorização

Após o aceite dos Termos e Condições, da obtenção do FraudId e da consulta das opções de parcelamento, chegou a hora de submeter os dados da transação para a criação da transação em si e para a solicitação de autorização da Koin.

Para essa autorização, o Payment.Type será "BuyNowPayLater" e o Payment.Provider será "Koin".

Nessa etapa, você deverá enviar dois valores obtidos no passos anteriores:

  • Envie o valor do FraudID obtido no passo 1 no campo FingerprintId;
  • Envie o valor do OptionsId (obtido no passo 2) escolhido pelo comprador no campo InstallmentOptionId.

    Aplicando multas e descontos
    Você pode informar valores de sua escolha para multas e descontos em campos opcionais.

    Multas: envie o campo Payment.FineRate para multa sobre o valor da transação ou envie o campo Payment.FineAmount para multa sobre o valor total. Atenção: você deve enviar apenas um dos campos referentes à multa.
    Descontos:envie o campo Payment.DiscountRate para desconto sobre o valor da transação ou envie o campo Payment.DiscountAmount para desconto sobre o valor total. Atenção: você deve enviar apenas um dos campos referentes ao desconto.

Para submeter à autorização, envie a requisição da transação para a API do Gateway de Pagamento.

Updated 8 days ago