0.0.1 • Published 3 years ago

@shoopiapp/paguelo-facil v0.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

Paguelo Facil Node.js Library

The PagueloFacil Node library provides convenient access to the PagueloFacil API from applications written in server-side JavaScript.

You can read the full documentation of PagueloFacil

Installation

Install PagueloFacil with npm

  npm install @shoopiapp/paguelo-facil

Usage/Examples

import PagueloFacil from '@shoopiapp/paguelo-facil';

const pagueloFacil = new PagueloFacil(<cclw>, <token>, 'development');
  • Authorization
    const paymentInfo = {
        amount: 1,
        taxAmount: 0.0,
        email: "email@mail.com",
        phone: "61234567",
        concept: "concept",
        description: "description",
    }

    const cardInfo = {
        cardNumber: "xxxxxxxxxxxxxxxx",
        expMonth: "1",
        expYear: "30",
        cvv: "123",
        firstName: "FirstName",
        lastName: "LastName",
        cardType: "MASTERCARD"
    }

    const response = await pagueloFacil.Authorization(paymentInfo, cardInfo);
  • Reverse Authorization
    const reverseInfo = {
        amount: 1,
        description: 'description',
        codOper: 'SANDBOX_AUTH-XXXXXXXXX'
    }

    const response = await pagueloFacil.ReverseAuthorization(reverseInfo);
  • Capture
    const paymentInfo = {
        amount: 1,
        taxAmount: 0.0,
        email: "email@mail.com",
        phone: "61234567",
        concept: "concept",
        description: "description",
    }

    const cardInfo = {
        cardNumber: "xxxxxxxxxxxxxxxx",
        expMonth: "1",
        expYear: "30",
        cvv: "123",
        firstName: "FirstName",
        lastName: "LastName",
        cardType: "MASTERCARD"
    }

    const response = await pagueloFacil.Capture(paymentInfo, cardInfo);
  • Reverse Capture
    const reverseInfo = {
        amount: 1,
        description: 'description',
        codOper: 'SANDBOX_AUTH-XXXXXXXXX'
    }

    const response = await pagueloFacil.ReverseCapture(reverseInfo);
  • Authorize and Capture
    const paymentInfo = {
        amount: 1,
        taxAmount: 0.0,
        email: "email@mail.com",
        phone: "61234567",
        concept: "concept",
        description: "description",
    }

    const cardInfo = {
        cardNumber: "xxxxxxxxxxxxxxxx",
        expMonth: "1",
        expYear: "30",
        cvv: "123",
        firstName: "FirstName",
        lastName: "LastName",
        cardType: "MASTERCARD"
    }

    const response = await pagueloFacil.AuthCapture(paymentInfo, cardInfo);
  • Recurrent
    const recurrentInfo = {
        amount: 1,
        taxAmount: 0.0,
        email: 'email@mail.com',
        phone: '61234567',
        concept: 'concept',
        description: 'description',
        codOper: 'SANDBOX_AUTH-XXXXXXXXX'
    }

    const response = await pagueloFacil.Recurrent(recurrentInfo);

API Reference

Constructor

  new PagueloFacil(cclw, token, environment)
ParameterTypeDescription
cclwstringRequired. Your cclw key
tokenstringRequired. Your token key
environmentdevelopment or productionOptional. Type of environment

PaymentInformation

ParameterTypeDescription
amountnumberRequired. Transaction amount
taxAmountnumberRequired. Trax amount
emailstringRequired. Client email
phonestringRequired. Client phone
conceptstringRequired. Transaction concept
descriptionstringRequired. Transaction description
langstringOptional. Language
customFieldValuesArray<[string, string, string]>Optional. Optional fields (id, label, value)

CardInformation

ParameterTypeDescription
cardNumberstringRequired. Client card number
expMonthstringRequired. The expiration month
expYearstringOptional. The expiration year
cvvstringOptional. The cvv or cvc
firstNamestringOptional. The client first name
lastNamestringOptional. The client last name
cardTypeVISA or MASTERCARDOptional. The card type

ReverseInformation

ParameterTypeDescription
codOperstringRequired. codOper return by the transaction
amountnumberRequired. Transaction amount
descriptionstringRequired. Transaction description
langstringOptional. Language
customFieldValuesArray<[string, string, string]>Optional. Optional fields (id, label, value)

CaptureInformation

ParameterTypeDescription
amountnumberRequired. Transaction amount
taxAmountnumberRequired. Trax amount
emailstringRequired. Client email
phonestringRequired. Client phone
conceptstringRequired. Transaction concept
descriptionstringRequired. Transaction description
langstringOptional. Language
customFieldValuesArray<[string, string, string]>Optional. Optional fields (id, label, value)
codOperstringRequired. codOper return by the transaction

Running Tests

To run tests, run the following command

  npm run test

🚀 About US

We are Shoopi a Panamanian Marketplace for everyone.

0.0.1

3 years ago