dotlines-io/epw

This package can be used for OnDemand Payment integration with Ghoori Platform.

dev-master 2021-09-27 08:35 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• dotlines-io/core: ^1.0
• dotlines-io/ghoori: ^1.0
• vlucas/phpdotenv: ^5.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.17
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest
• spatie/ray: ^1.10
• vimeo/psalm: ^4.3

MIT

• SadiaKhan

• dotlines-io
• ghoori-ondemand
• dotlines

README

This composer package can be used for EPW payment integration

Installation

You can install the package via composer:

composer require dotlines-io/epw

Usage

/**
 * ******************************************************
 * ******************* Charge Request *******************
 * ******************************************************
 */
$tran_id = 'rtreg'; //must be unique for each request
$success_url = 'success_url'; //URL to which the customer will be returned when the payment is made successfully.
$fail_url = 'fail_url'; //URL to which the customer will be returned when the payment is made. But the Payment not Accepted by bank or card have insufficient balance etc
$cancel_url = 'cancel_url'; //URL to which the customer will be returned if the payment process is cancelled. If this field is not filled, the gateway window will simply close automatically upon clicking the cancellation button, so the customer will be returned to the last page on the Merchant's website where the customer has been before.

$ipn_url = ''; //Optional URL which easypayway will push the transaction details. Its required to confirm both party payment information updated to both party
$opt_a = ''; //Optional Field for Merchant Record
$opt_b = ''; //Optional Field for Merchant Record
$opt_c = ''; //Optional Field for Merchant Record
$opt_d = ''; //Optional Field for Merchant Record

// payment details
$amount = 39; // The total amount payable. Please note that you should skip the trailing zeroes in case the amount is a natural number
$payment_type = 'VISA'; //Optional Payment process card type that customer want to pay with
$currency = 'BDT'; //3­letter code of the currency of the amount according to ISO 4217 (see Annex I for accepted currencies)
$amount_vat = ''; //Optional
$amount_vatRatio = ''; //Optional
$amount_tax = ''; //Optional
$amount_taxRatio = ''; //Optional
$amount_processingfee = ''; //Optional
$amount_processingfee_ratio = ''; //Optional
$desc = 'T­Shirt'; //Merchant may specify a detailed calculation for the total amount payable. Please note that easypayway does check the validity of these data ­ they are only displayed in the ’More information’ section in the Merchant Panel of the gateway.

// Customer Details
$cus_name = 'Mr. ABc'; //Customer Full Name
$cus_email = '[e-mail]'; //Email address of the customer who is making the payment.
$cus_add1 = 'Dhaka'; //cus_add1
$cus_add2 = ''; //Optional Customer’s address (e.g. town) 
$cus_city = 'Dhaka'; //Customer’s city
$cus_state = 'Dhaka'; //Customer’s state or region. 
$cus_postcode = '1206'; //Customer’s postal code/ZIP Code. Only alphanumeric values are accepted (no punctuation marks etc.)
$cus_country = 'Bangladesh'; //Customer’s country
$cus_phone = '01738084575'; //Customer’s phone number. Only numeric values are accepted
$cus_fax = ''; //Optional

// Shipping Details (If Ship to Same Address of Customer then No need to Fill Up)
$ship_name = ''; //Optional
$ship_add1 = ''; //Optional
$ship_add2 = ''; //Optional
$ship_city = ''; //Optional
$ship_state = ''; //Optional
$ship_postcode = ''; //Optional
$ship_country = ''; //Optional

$chargeRequest = \Dotlines\EPW\ChargeRequest::getInstance($tran_id, $success_url, $fail_url, $cancel_url, $amount, $currency, $desc, $cus_name, $cus_email, $cus_add1, $cus_city, $cus_state, $cus_postcode, $cus_country, $cus_phone, $ipn_url, $opt_a, $opt_b, $opt_c, $opt_d, $payment_type, $amount_vat, $amount_vatRatio, $amount_tax, $amount_taxRatio, $amount_processingfee, $amount_processingfee_ratio, $cus_add2, $cus_fax, $ship_name, $ship_add1, $ship_add2, $ship_city, $ship_state, $ship_postcode, $ship_country);
echo json_encode($chargeRequest->send()) . '<br/>';

/**
 * Success Charge Request Response looks like below.
 * You must redirect the user to the following url for payment.
 *["https:\/\/sandbox.easypayway.com\/payment\/paynow.php?track=EPW1621853905452832"]
 */

/**
 * ******************************************************
 * ******************* Status Request *******************
 * ******************************************************
 */
$statusUrl = 'https://<SERVER_URL>/api/v2.0/status';
$spTransID = '';
$statusRequest = \Dotlines\EPW\StatusRequest::getInstance($request_id​);
echo json_encode($statusRequest->send()) . '<br/>';

/**
 * Status Request Response looks like below:
 * {
 *  "processingStatus": "CHARGED",
 *  "status": "DONE",
 *  "amount": "10.00",
 *  "errorCode": "00",
 *  "errorMessage": "Operation Successful",
 *  "bKashTransID": "6JS7L72YMV",
 *  "reference": "reference not provided"
 * }
 * Fail response only contains errorCode & errorMessage
 */