qris-mutasi
v2.0.0
Published
Qris Mutasi is a TypeScript library used to retrieve transaction data from the [Merchant QRIS Dashboard](https://merchant.qris.id/m/). This library uses [cheerio](https://github.com/cheeriojs/cheerio) to scrape data from the dashboard.
Downloads
2
Readme
Qris Mutasi
Qris Mutasi is a TypeScript library used to retrieve transaction data from the Merchant QRIS Dashboard. This library uses cheerio to scrape data from the dashboard.
Installation
Use the package manager npm to install Qris Mutasi.
npm install qris-mutasi
or using yarn
yarn add qris-mutasi
Usage
Importing the Library
import { Qris } from "qris-mutasi";
or commonjs
const { Qris } = require("qris-mutasi");
Creating a Qris Object
const qris = new Qris(email, password);
Retrieving Transaction Data
const data = await qris.mutasi(filter, from_date, to_date, limit);
Parameters
| Parameter | Type | Description | |-----------|---------------------------|---------------------------------------------------------------------------------------------------------------------------| | filter | string | null (optional) | Filter transactions by the given filter. | | from_date | string | null (optional) | The starting date to filter the transactions. The date format should be yyyy-mm-dd. If null, 7 days before the current date is used. | | to_date | string | null (optional) | The end date to filter the transactions. The date format should be yyyy-mm-dd. If null, the current date is used. | | limit | number (optional) | The maximum number of transactions to retrieve. Minimum is 10 and maximum is 300. Default is 20. |
Return Value
The function mutasi()
returns an array of objects representing the transaction data. Each object has the following properties:
| Property | Type | Description | |---------------------|-----------|---------------------------------------------------------------------------------------| | id | number | The ID of the transaction. | | timestamp | number | The timestamp of the transaction in milliseconds since epoch. | | tanggal | string | The date and time of the transaction in the format "yyyy-mm-dd hh:mm:ss". | | nominal | number | The nominal amount of the transaction. | | status | string | The status of the transaction. | | inv_id | number | The invoice ID of the transaction. | | tanggal_settlement | string | The date of the transaction settlement in the format "yyyy-mm-dd". | | asal_transaksi | string | The origin of the transaction. | | nama_costumer | string | The name of the customer. | | rrn | string | The reference number of the transaction. |
Example
import { Qris } from "qris-mutasi";
const email = "your_email";
const password = "your_password";
const filter = "10000";
const from_date = "2023-05-01";
const to_date = "2023-05-07";
const limit = 20;
const qris = new Qris(email, password);
const data = await qris.mutasi(filter, from_date, to_date, limit);
console.log(data);
Cookie Handling
Qris Mutasi handles cookies automatically for authentication purposes. When you log in, the cookie is stored in a file named after a hash of your email and password. This cookie is then used for subsequent requests to maintain the session.
Cookie Storage Location:
The cookie is stored in a file named ${hash(email + password)}_cookie.txt
. Ensure that your environment has the necessary permissions to read and write to this file.
License