ebanx-ts
v1.3.5
Published
Remake of Ebanx NodeJs library. (Added support to TS)
Downloads
39
Maintainers
Readme
EBANX:
EBANX is the market leader in e-commerce payment solutions for International Merchants selling online to Brazil. This module enables you to integrate EBANX with Typescript compatibility.
Installation
npm
npm i ebanx-ts --save
Usage
// Require the module
import ebanxTs from "ebanx-ts";
// Construct with mandatory parameters integrationKey, testMode and httpMode.
const eb = new ebanxTs("1231000", true, true);
You can change the following settings:
*integrationKey: your integration key. It will be different in test and production modes.
*testMode: enable or disable the test mode. The default value is _true_.
To create a new API request, just call one of the following functions
on the ebanx object and supply it with the request parameters:
* eb.cancel()
* eb.capture()
* eb.direct()
* eb.documentBalance()
* eb.exchange()
* eb.print()
* eb.query()
* eb.refund()
* eb.refundOrCancel()
* eb.request()
* eb.token()
* eb.zipcode()
You can check your settings by accessing the settings module:
* eb.settings
* eb.settings.integrationKey
* eb.settings.testMode
And change the settings by the following methods:
* eb.setKey()
* eb.setTestMode()
* eb.setHttp()
Examples:
import ebanxTs, { models } from "ebanx-ts";
const eb = new ebanxTs("integration_key", true, true);
const direct: models.Direct = {
payment: {
name: "Juan Garcia",
email: "[email protected]",
address: "Oyono",
street_number: "882",
city: "Hermosillo",
state: "SO",
zipcode: "48822",
country: "mx",
phone_number: "0405777687",
payment_type_code: "visa",
merchant_payment_code: "949284c1474",
currency_code: "MXN",
instalments: 1,
amount_total: 100,
creditcard: {
card_number: "4111111111111111",
card_name: "Juan Garcia",
card_due_date: "12/2021",
card_cvv: "123"
}
}
};
/* METHOD 01 */
const payment = async () => {
const data = await eb.direct(direct);
console.log(data);
};
/* METHOD 02 */
eb.direct(direct)
.then((res: any) => console.log(res))
.catch((err: any) => console.log(err));
Changelog
- 1.3.3: Address fields is not mandatory for payment.
- 1.3.2: Creditcard parameter is now optional.
- 1.3.1: Fixed operation request parameter.
- 1.3.0: Refactored client class and added minor changes into interface.
- 1.2.4: Added optional security parameters into direct payment interface.
- 1.2.3: Added optional auto_capture into credit card interface.
- 1.2.2: Fix export interfaces.
- 1.2.1: Added CardBin operation.
- 1.2.0: Interfaces are now exported as models. (mandatory usage)
- 1.1.2: Code refactored.
- 1.1.1: Added FxToken, GetBankList, SetCVV operations and interfaces for every operation.
- 1.1.0: Added querystring for GET methods.
- 1.0.3: Asynchronous methods.
- 1.0.2: Added Axios (Removed deprecated request).
- 1.0.0: Released.