Metadata-Version: 2.4
Name: FaspaySendmeSnap
Version: 1.2.2
Summary: SDK for Faspay Sendme Snap
Home-page: https://github.com/faspay-team/faspay-sendme-snap-python
Author: Juanietto Forry Kusuma
Author-email: juan <juanietto.kusuma@faspay.co.id>
Project-URL: Homepage, https://faspay.co.id/docs/index-sendme.html#faspay-sendme
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Dynamic: author
Dynamic: home-page

[![N|Solid](https://faspay.co.id/docs/sendme/images/sendMe-new.png)](https://faspay.co.id/docs/index-sendme.html#faspay-sendme) 
## Welcome To Faspay SendMe

This package provides Faspay SendMe Snap 1.0 support for the Python Language.

## Requirements

The following versions of Python are supported.

* Python 3 or latest

To use this package, it will be necessary to have a credential. These are referred to as 
* boi
* private key

in your root project, include config file "SendMeConfig.ini".
save your private key file in your project directory and set the path to your private key in "SendMeConfig.ini"
You can download file inside "tests" directory.

Please contact Administrator Faspay to create the required credentials.

## Installation
To install in your project use this command:
```sh
pip install FaspaySendmeSnap
```
Install Dependencies package
```sh
pip install requests
pip install pytz
pip install pycryptodomex
```

## Upgrade Latest Version
To upgrade use this command:
```sh
pip install --upgrade FaspaySendmeSnap
```

## Usage
### Register Flow
```python
from FaspaySendmeSnap import Api

response = Api.Services.accountInquiry(Api.Services, {
    "beneficiaryBankCode"   : "002",
    "beneficiaryAccountNo"  : "888801000157508",
    "partnerReferenceNo" 	: "2020102900000000000001",
    "additionalInfo"        : 
    {
        "sourceAccount" : "9920000082"
    },
})
```

the parameter refer to Faspay SendMe [Documentation](https://docs.faspay.co.id/getting-started/snap/snap-disbursement).

### Environment Production
To use environment production must be call this method like as :
```python
from FaspaySendmeSnap import Api

Api.Services.enableProd(Api.Services)
```

#### Available Methods

The `Faspay SendMe Snap` provide has the following [method]:

- 'accountInquiry()' is used to obtain the recipient's account information and to minimize the possibility of incorrect transfer destinations.
- 'transferInterbank()'  is used for transfers from the partner's account to the destination account that has been previously registered.
- 'transferStatus()' is used to check the status of transfers.
- 'balanceInquiry()' is used to check the balance of user accounts registered with Faspay SendMe. 
- 'historyList()' is used to check transaction logs/account mutations registered in Faspay SendMe.
- 'topupEmoney()' is used to transfer funds to e-wallets.
- 'emoneyStatus()' is used to check the status of top-up.
- 'vaInquiry()' is used to inquiry the Bill Payment transaction.
- 'vaPayment()' is used to Bill Payment transaction.
