Faspay NPM | npm.io

Faspay Unofficial Node.js API

This library is designed to ease the process of integrating users apps with Faspay Payment Gateway service.

Original API docs: https://docs.faspay.co.id/

Installation

Install faspay using npm,

$ npm install faspay

or yarn

$ yarn add faspay

Example

import {
  FaspayDebit,
  FaspayConfig,
  CreateTransactionData,
  PaymentStatusCode,
  InstallmentTenor,
} from "faspay";

const config: FaspayConfig = {
  isProduction: false,
  merchantId: "00000",
  merchant: "Test Faspay Integration",
  userId: "bot000000",
  password: "",
  creditAccount: "faspay_trial",
  creditPassword: "",
};

const faspay = new FaspayDebit(config);

const main = async () => {
  // Get payment channel
  const payment = await faspay.getPaymentChannel();
  console.log("Payment channel:", payment.payment_channel);

  // Post data transaction (Virtual Account)
  const payload: CreateTransactionData = {
    billNo: Date.now().toString(),
    description: "Test faspay payment",
    paymentChannel: "800",
    customer: {
      no: "3d966130-ad7e-4482-83a9-36e4cd676393",
      name: "test customer",
      phone: "896959239123",
      email: "cust@mail.com",
    },
    billing: {
      // optional (required for OVO)
      name: "John Doe",
      address: "Jl Sabang 37",
      city: "Jakarta",
      region: "DKI Jakarta",
      state: "Indonesia",
      postCode: "10170",
      countryCode: "ID",
    },
    shipping: {
      // optional (required for OVO)
      name: "John Doe",
      address: "Jl Sabang 37",
      city: "Jakarta",
      region: "DKI Jakarta",
      state: "Indonesia",
      postCode: "10170",
      countryCode: "ID",
    },
    items: [
      {
        id: "29d42612-213c-4c8f-83f2-916e19b6932b",
        product: "Test Product",
        price: 100000,
        qty: 1,
        tenor: InstallmentTenor.FullPayment, // optional
      },
    ],
  };
  const transaction = await faspay.createTransaction(payload);
  console.log("Transaction:", transaction);

  // Check payment status
  const paymentStatus = await faspay.getPaymentStatus(
    transaction.trx_id,
    transaction.bill_no
  );

  switch (paymentStatus.payment_status_code) {
    case PaymentStatusCode.Unprocessed:
      console.log("Payment status: Not Processed");
      break;
    case PaymentStatusCode.Success:
      console.log("Payment status: Success");
      break;
    case PaymentStatusCode.Cancelled:
      console.log("Payment status: Cancelled");
      break;
    default:
      console.log("Payment status:", paymentStatus);
      break;
  }

  // Cancel transaction
  const cancel = await faspay.cancelTransaction(
    transaction.trx_id,
    transaction.bill_no,
    "cancel tx tests"
  );
  console.log("Cancel transaction:", cancel);
};

main();