Library-paguelofacil-js NPM

PagueloFacil Javascript SDK

The PagueloFacil Node library provides convenient access to the PagueloFacil API from applications written in JavaScript/Typescript

You can read the full documentation of PagueloFacil.

Content

Installation

Usage Examples

Authorization
Reverse Authorization
Capture
Reverse Capture
Authorize and Capture

API Reference

Constructor
PaymentInformation
CardInformation
ReverseInformation
CaptureInformation
ServerResponse
HeaderStatus
Data
PaidLink

Running Tests

Installation

Install PagueloFacil with npm

npm i library-paguelofacil-js

Usage Examples

import  PagueloFacilSDK  from  'library-paguelofacil-js';
const  pagueloFacilSDK  =  new  PagueloFacilSDK({cclw, token, 'development'}); //change to 'produciton' for production environment

Payment Authorization

const  paymentInfo  =  {
    amount:  100,
    taxAmount:  0.0,
    email:  "correo@gmail.com",
    phone:  "59128732734",
    concept:  "concept",
    description:  "description",
    lang: 'ES'
}

const  cardInfo  =  {
    cardNumber:  "411111111111",
    expMonth:  "12",
    expYear:  "30",
    cvv:  "123",
    firstName:  "Jhoson",
    lastName:  "Gibson",
    cardType:  "MASTERCARD"  // or VISA
}
const  response  =  await pagueloFacilSDK.TrasanccionAutorization(paymentInfo, cardInfo);

Reverse Payment Authorization

const  reverseInfo  =  {
    amount:  100,
    description:  'description',
    codOper:  'SANDBOX_AUTH-XXXXXXXXX'
}
const  response  =  await pagueloFacilSDK.TrasanccionReverseAutorization(reverseInfo);

Capture Payment

const  paymentInfo  =  {
    amount:  100,
    taxAmount:  0.0,
    email:  "correo@gmail.com",
    phone:  "59128732734",
    concept:  "concept",
    description:  "description",
    lang: 'ES',
    codOper: "SANDBOX_AUTH-XXXXXXXXX"
}
const  response  =  await pagueloFacilSDK.TrasanccionCapture(paymentInfo);

Reverse Capture

const  reverseInfo  =  {
    amount:  100,
    description:  'description',
    codOper:  'SANDBOX_AUTH-XXXXXXXXX'
}
const  response  =  await pagueloFacilSDK.TrasanccionReverseCapture(reverseInfo);

Authorize and Capture Payment (preferred)

const  paymentInfo  =  {
    amount:  100,
    taxAmount:  0.0,
    email:  "correo@gmail.com",
    phone:  "59128732734",
    concept:  "concept",
    description:  "description",
    lang: 'ES'
} 

const  cardInfo  =  {
    cardNumber:  "411111111111",
    expMonth:  "12",
    expYear:  "30",
    cvv:  "123",
    firstName:  "Jhoson",
    lastName:  "Gibson",
    cardType:  "MASTERCARD"  // or VISA
}
const  response  =  await pagueloFacilSDK.TrasanccionAuthCapture(paymentInfo, cardInfo);

API Reference

Constructor

new PagueloFacilSDK({cclw, token, environment})

Parameter	Type	Description
`cclw`	`string`	Required. Your cclw key
`token`	`string`	Required. Your token key
`environment`	`development or production`	Optional. Type of environment

PaymentInformation

Parameter	Type	Description
`amount`	`number`	Required. Transaction amount
`taxAmount`	`number`	Required. Trax amount
`email`	`string`	Required. Client email
`phone`	`string`	Required. Client phone
`concept`	`string`	Required. Transaction concept
`description`	`string`	Required. Transaction description
`lang`	`string`	Optional. Language
`customFieldValues`	`Array<[string, string, string]>`	Optional. Optional fields (id, label, value)

CardInformation

Parameter	Type	Description
`cardNumber`	`string`	Required. Client card number
`expMonth`	`string`	Required. The expiration month
`expYear`	`string`	Optional. The expiration year
`cvv`	`string`	Optional. The cvv or cvc
`firstName`	`string`	Optional. The client first name
`lastName`	`string`	Optional. The client last name
`cardType`	`VISA or MASTERCARD`	Optional. The card type

ReverseInformation

Parameter	Type	Description
`codOper`	`string`	Required. codOper return by the transaction
`amount`	`number`	Required. Transaction amount
`description`	`string`	Required. Transaction description
`lang`	`string`	Optional. Language
`customFieldValues`	`Array<[string, string, string]>`	Optional. Optional fields (id, label, value)

CaptureInformation

Parameter	Type	Description
`amount`	`number`	Required. Transaction amount
`taxAmount`	`number`	Required. Trax amount
`email`	`string`	Required. Client email
`phone`	`string`	Required. Client phone
`concept`	`string`	Required. Transaction concept
`description`	`string`	Required. Transaction description
`lang`	`string`	Optional. Language
`customFieldValues`	`Array<[string, string, string]>`	Optional. Optional fields (id, label, value)
`codOper`	`string`	Required. codOper return by the transaction

ServerResponse

Parameter	Type	Description
`code`	`number`	code Transaction
`success`	`boolean`	Server response if is success or not
`message`	`string or null`	Server message
`data`	Data	Transaction data

Data

Parameter	Type	Description
`date`	`string`	Transaction date
`authStatus`	`string`	Server session status
`cardType`	`VISA or MASTERCARD`	Type of card for the transaction
`type`	`VISA or MASTERCARD`	Card provider for the transaction
`idtx`	`number`	Id identifier for the transaction
`cardToken`	`string`	Token generated by the transaction
`totalPay`	`string`	Total amount of the transaction
`binInfo`	`Object`	Information of card provider
`name`	`string`	Card name
`displayNum`	`string`	Last fourth number of the card
`operationType`	`string`	Type of operation
`returnUrl`	`string`	Callback URL
`requestPayAmount`	`number`	Amount to pay of the request
`email`	`string`	Client email
`codOper`	`string`	Operation code of the transaction
`status`	`boolean`	Show if the transaction was successfull or not
`messageSys`	`boolean`	Show the system message