https://github.com/afiqiqmal/rpclient

RaudhahPay Gateway PHP Library
https://github.com/afiqiqmal/rpclient

api api-client composer credit creditcard debit fpx hacktoberfest malaysia payment payment-gateway php raudhah raudhahpay wrapper

Last synced: 30 days ago
JSON representation

RaudhahPay Gateway PHP Library

• Host: GitHub
• URL: https://github.com/afiqiqmal/rpclient
• Owner: afiqiqmal
• Created: 2020-02-03T08:18:05.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T22:49:52.000Z (almost 2 years ago)
• Last Synced: 2024-09-13T04:15:03.773Z (about 2 months ago)
• Topics: api, api-client, composer, credit, creditcard, debit, fpx, hacktoberfest, malaysia, payment, payment-gateway, php, raudhah, raudhahpay, wrapper
• Language: PHP
• Homepage:
• Size: 50.8 KB
• Stars: 9
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Packagist](https://img.shields.io/packagist/dt/afiqiqmal/Rpclient.svg)](https://packagist.org/packages/afiqiqmal/Rpclient)

[![Packagist](https://img.shields.io/packagist/v/afiqiqmal/Rpclient.svg)](https://packagist.org/packages/afiqiqmal/Rpclient)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/paypalme/mhi9388?locale.x=en_US)

![alt text](https://banners.beyondco.de/RPClient.png?theme=dark&packageName=afiqiqmal%2Frpclient&pattern=cage&style=style_1&description=It+is+simple+wrapper+class+written+in+php+to+ease+use+of+RaudhahPay+Payment+Gateway&md=1&fontSize=100px&images=cash)

# Raudhah Pay Client Library using PHP Framework

It is simple wrapper class written in php to ease use of [RaudhahPay Payment Gateway](https://www.raudhahpay.com/) 

## Directory

* [Installation](#installation)

* [Usages](#usages)

## Installation

### Composer

```

composer require afiqiqmal/rpclient

```

Alternatively, you can specify as a dependency in your project's existing composer.json file

```

{

   "require": {

      "afiqiqmal/rpclient": "^1.2.0"

   }

}

```

## Usages

After installing, you need to require Composer's autoloader and add your code.

Setup config

```$xslt

$config = [

    'api_key' => getenv('RAUDHAH_API_KEY'),

    'signature_key' => getenv('RAUDHAH_X_SIGNATURE')

];

```

Or use Laravel config file name it as `raudhahpay.php` and leave `make()` blank

```

return [

    'api_key' => env('RAUDHAH_API_KEY'),

    'signature_key' => env('RAUDHAH_X_SIGNATURE', null),

    'is_sandbox' => env('RAUDHAH_SANDBOX', env('APP_ENV') != 'production'),

];

```

## Collection

### Create collection

```$xslt

RaudhahPay::make()

    ->collection()

    ->create("Collection Name");

```

### Get collections

```$xslt

RaudhahPay::make()

    ->collection()

    ->fetchList(); 

```

### Update collection name

```$xslt

RaudhahPay::make()

    ->collection()

    ->updateCollectionName("CollectionID", "New Name"); 

```

### Get collections by code

```$xslt

RaudhahPay::make()

    ->collection()

    ->fetchByCode("CollectionCode"); 

```

## Bills

### Create Bill

```$xslt

RaudhahPay::make()

    ->bill()

    ->makeBill("COLLECTION CODE")

    ->setCustomer("Amirul", "Amirul", "[email protected]", "60123456789", "Melaka")

    ->setReference("Testing")

    ->setProduct("Product 1", 10.30, 1)

    ->create();

```

## Products

### Create product

```$xslt

RaudhahPay::make()

    ->product()

    ->create(string|array $title/$arrays, string $code, string $description, $price);

```

### Get products

```$xslt

RaudhahPay::make()

    ->product()

    ->getList();

```

## Customer

### Create customer

```$xslt

RaudhahPay::make()

    ->customer()

    ->create(string|array $firstName/$arrays, string $lastName = null, string $phoneNumber = null, string $email = null);

```

### Get customers

```$xslt

RaudhahPay::make()

    ->customer()

    ->getList();

```

## DirectPay

### DirectPay Payee

```

$response = RaudhahPay::make()

    ->directPay()

    ->payee("COLLECTION CODE")

    ->getDirectPays();

```

### DirectPay Payeer

```

$response = RaudhahPay::make()

    ->directPay()

    ->payee("COLLECTION CODE")

    ->getTransactions($direct_pay_payer_code);

```

### Check checksum from Redirect/Webhook

```$xslt

RaudhahPay::make()->isCheckSumValid($payload); //boolean

```

## Source

[Raudhah Pay Docs](https://documenter.getpostman.com/view/9723080/SWE57zKG?version=latest)

## Todo

- Other Raudhah Pay features. Still under development

- Unit Test 

- Alter Readme

## License

Licensed under the [MIT license](http://opensource.org/licenses/MIT)