liftpay-checkout v0.1.4

LiftPay Checkout

O Checkout LiftPay é uma forma simples de receber pagamentos de Cartão de crédito direto no seu site por meio de uma interface amigável exibida para o seu cliente.

Exemplo React

Adicionando a biblioteca ao seu projeto

Usando yarn:

yarn add liftpay-checkout

Usando npm:

npm i liftpay-checkout

Usando a biblioteca

1. Importe a biblioteca no seu projeto

   import LiftPayCheckout from 'liftpay-checkout';

2. Adicione o CSS

   Via JavaScript:

   import 'liftpay-checkout/dist/styles.css';

   Via HTML:

   <link rel="stylesheet" href="https://unpkg.com/liftpay-checkout@0.1.4/dist/styles.css">

3. Crie uma ordem de pagamento

   const publicKey = "INSERT_PUBLIC_KEY_HERE";
   
   const order = {
     amount: 1200,
   };
   
   const [err, res] = await LiftPayCheckout.createPaymentOrder(publicKey, order);

4. Exiba o formulário de checkout na sua página

   await LiftPayCheckout.openCheckoutForm({ 
     formSelector: '#checkout-form', 
     onSuccess: (data) => { console.log(data); }, 
     onError: (error) => { console.log(error); }
   });

Referência da API

createPaymentOrder(publicKey: string, order: Order): Promise<ResponseType<{ success: boolean }>>

Cria uma ordem de pagamento. Essa função recebe os seguintes parâmetros:

• publicKey : Chave pública utilizada para autenticação.
• order: Objeto contendo os detalhes da ordem de pagamento.

Essa função retorna uma promesa que será resolvida em um array com a assinatura [error, response]. Onde a primeira posição do array contém um erro (ou nulo em caso de sucesso) e a segunda posição contém um objeto com o campo success igual a true (ou nulo em caso de erro).

openCheckoutForm({ formSelector, onSuccess, onError }: FormConfig): Promise<void>

Exibe o formulário de pagamento na tela. Essa função recebe um objeto com os seguintes campos:

• formSelector: Classe ou Id do elemento HTML onde o formulário deverá ser inserido.
• onSuccess: Callback invocado quando o pagamento é completado com sucesso, recebe um objeto contendo os dados da pagamento como parâmetro.
• onError: Callback invocado em caso de erro, recebe o erro como parâmetro.

Retorna uma Promesa que será resolvida quando o formulário estiver pronto para ser interagido na tela.