ebanx/lib-js

Lib JS V1.5

Lib JS makes it easy to collect payments in Brazil, Mexico, Chile, Colombia, Peru, using local currencies and payment methods in an easy and secure way. If you need help please reach us at .

Find more information in our Dev Academy.

Start using EBANX Lib JS

Pre-requisites

• EBANX Merchant Credentials;
• HTTPS Website: EBANX Checkout JS Only works on HTTPS;
• Fingerprint providers registered on Merchant Configs (EBMNG)

How to use EBANX Lib Js

1. Include Lib-Js in your webpage

<script type="text/javascript" src="https://js.ebanx.com/assets/songbird/songbird-<dev|prod>.js"></script><!-- use dev or prod according to your needs -->
<script type="text/javascript" src="https://js.ebanx.com/ebanx-libjs-latest.min.js"></script>

2. Initialize EBANX Lib Js with your Merchant's Configurations

EBANX.config.setMode('sandbox'); // Set mode. production/test
EBANX.config.setPublishableKey('put your key here'); // Set your Publishable key. To identify your site to EBANX API you must start by providing your [publishable key](https://developers.ebanx.com/merchant-area/merchant-options).
EBANX.config.setCountry('br'); // Set your checkout country (Alpha-2) (see: https://en.wikipedia.org/wiki/ISO_3166-1).

3. EBANX Lib Js will retrieve the fingerprint list from providers registered under Merchant's account

4. Create a Token callback method to manage the Tokenization response

EBANX.config.setMode('test');
EBANX.config.setPublishableKey('YOUR KEY HERE');
EBANX.config.setCountry('br');

var createTokenCallback = function(ebanxResponse) {
  if (ebanxResponse.data.hasOwnProperty('status')) {
      document.getElementById('status').textContent = 'Success, the token is: ' + ebanxResponse.data.token;
  } else {
      var errorMessage = ebanxResponse.error.err.status_message || ebanxResponse.error.err.message;
      document.getElementById('status').textContent = 'Error ' + errorMessage;
  }
}

5. Tokenize the customer's card with

// CUSTOMER CLICKS THE BUTTON
function createToken() {
  EBANX.card.createToken({
    card_number: 4111111111111111,
    card_name: 'Teste',
    card_due_date: '02/2019',
    card_cvv: '123'
  }, createTokenCallback);
}
createToken();

6. Perform a 3DS authentication with

const orderInformation = {
    "amountDetails": {
        "totalAmount": "10.04",
        "currency": "BRL"
    },
    "billTo": {
        "address1": "Rua Estanislau Szarek",
        "administrativeArea": "PR",
        "country": "BR",
        "email": "1584023172@exemplo.com.br",
        "homePhone": "41999999999",
        "locality": "Curitiba",
        "postalCode": "81315380",
        "mobilePhone": "41999999999"
    }
};

// success with challenge
const cardNumber = "4000000000001091";

// success without challenge
//const cardNumber = "4000000000001000";

// failt with challenge
//const cardNumber = "4000000000001109";

const paymentInformation = {
    "card": {
        "number": cardNumber,
        "expirationMonth": "12",
        "expirationYear": "34",
        "holderName": "JOAO DA SILVA"
    }
};

const personalIdentification = {
    "id": "97370192024",
    "type": "CPF"
};

const options = {
  orderInformation,
  paymentInformation,
  personalIdentification,
};

const shouldAuthenticate = await EBANX.threedsecure.checkIfShouldAuthenticate(options);

if (shouldAuthenticate) {
  const result = await EBANX.threedsecure.run(options);
}

Architecture

This library is composed by 8 main modules

Card

• The main interface for Card Tokenization

Device Fingerprint

• Retrieves the providers from Pay API

Errors

• Translates tokenization errors to PT or ES

HTTP

• Manages the HTTP client

Tokenize

• Manages the token resource status and tokenization request callbacks

Utils

• Provides resources for API Addressess and available countries

Validation

• Validates API Key, countries and card data

Threedsecure

• 3DS authentication