@placetopay/pinpad-sdk

PinPad

A PIN pad or PIN entry device (PED) is an electronic device used in a debit, credit or smart card-based transaction to accept and encrypt the cardholder's personal identification number (PIN).

This API provides a PinPad SDK service with PinBlock generation encrypted according to ISO 9564, the data required for PinBlock generation are as follows:

• PIN: number digits by the cardholder 4-12 length, refer PIN to more information.

• PAN: The card number PAN to more information.

• Format: format to apply to the pin, can be 0, 1, 2 or 3 more info ISO 9564

Installation

 npm i @placetopay/pinpad-sdk

Usage

Init the PinPad JavaScript SDK

For the PinPad will be succesfully loaded, you must initialize the sdk as shown below:

  import PinPad from '@placetopay/pinpad-sdk'

  let pad = new PinPad({
      id: 'YOUR_CLIENT_ID',
      token: 'YOUR_API_TOKEN',
      format: 0, // may be 0,1,2 or 3
      locale: document.documentElement.lang // language to display
  })

Render the PinPad

For render the Pinpad, the PinPad JavaScript SDK provides a funtion render(div_id, PAN). the div_id property es the PinPad DOM element id defined earlier, the PAN property is the card number digited by user (required only formats by 0 and 3)

Render the PinPad as shown below:

  pad.render('my-PinPad-id', 'PAN')

Create Transaction

To create the Pinpad transaction, the PinPad JavaScript SDK provides a funtion createTransaction(). Return positions and transactionId, which will be necessary to send PIN.

create Transaction as shown below:

  pad.createTransaction().then(res => {
    const positions = res.data.positions
    const transactionId = res.data.transactionId
  })

Send PIN to encrypt

To send the PIN to encrypt, the PinPad JavaScript SDK provides a funtion sendPin(transactionId, data). Return Pinblock.

send PIN as shown below:

  let data = {
    format, // format to apply (required)
    pin,    // positions digits from user (required)
    pan,    // card number (required if format is 0 or 3)
  }
   
  pad.sendPin(transactionId, data).then(res => {
    const pinBlock = res.data.pinblock
  })