Developer
<?php
namespace App\Traits\PaymentGateway;
use Exception;
use Illuminate\Support\Str;
use App\Models\TemporaryData;
use Illuminate\Support\Facades\DB;
use App\Http\Helpers\PaymentGateway;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Http;
use App\Constants\PaymentGatewayConst;
use Illuminate\Http\Client\RequestException;
trait SslCommerz {
private $sslCommerz_gateway_credentials;
private $request_credentials;
private $sslCommerz_sandbox_api_base_url = "https://sandbox.sslcommerz.com/";
private $sslCommerz_production_api_base_url = "https://securepay.sslcommerz.com";
private $sslCommerz_api_v4 = "v4";
public function sslCommerzInit($output = null)
{
if(!$output) $output = $this->output;
$request_credentials = $this->getSslCommerzRequestCredentials($output);
try{
$payment_link = $this->createSslCommerzPaymentLink($output, $request_credentials);
}catch(Exception $e) {
throw new Exception($e);
}
return $payment_link;
}
public function createSslCommerzPaymentLink($output, $request_credentials)
{
$v4 = $this->sslCommerz_api_v4;
$endpoint = "gwprocess/$v4/api.php";
$endpoint = $request_credentials->base_url . $endpoint;
$temp_record_token = generate_unique_string('temporary_datas','identifier',60);
$redirection = $this->getRedirection();
$url_parameter = $this->getUrlParams();
$user = auth()->guard(get_auth_guard())->user();
$temp_data = $this->sslCommerzJunkInsert($temp_record_token); // create temporary information
$response = Http::asForm()->post($endpoint, [
'store_id' => $this->request_credentials->store_id,
'store_passwd' => $this->request_credentials->secret_key,
'total_amount' => $output['amount']->total_amount,
'currency' => $output['currency']->currency_code,
'tran_id' => $temp_record_token,
'success_url' => $this->setGatewayRoute($redirection['return_url'],PaymentGatewayConst::SSLCOMMERZ,$url_parameter),
'fail_url' => $this->setGatewayRoute($redirection['cancel_url'],PaymentGatewayConst::SSLCOMMERZ,$url_parameter),
'cancel_url' => $this->setGatewayRoute($redirection['cancel_url'],PaymentGatewayConst::SSLCOMMERZ,$url_parameter),
'ipn_url' => $this->setGatewayRoute($redirection['callback_url'],PaymentGatewayConst::SSLCOMMERZ,$url_parameter),
'cus_name' => $user->firstname ?? "",
'cus_email' => $user->email ?? "",
'cus_add1' => $user->address->address ?? "",
'cus_city' => $user->address->city ?? "",
'cus_country' => $user->address->country ?? "",
'cus_phone' => " ",
'shipping_method' => "No",
'product_name' => "Add Money",
'product_category' => " ",
'product_profile' => " ",
])->throw(function(Response $response, RequestException $exception) use ($temp_data) {
$temp_data->delete();
throw new Exception($exception->getMessage());
})->json();
$response_array = json_decode(json_encode($response), true);
if(isset($response_array['status']) && $response_array['status'] == "SUCCESS") {
$temp_data_contains = json_decode(json_encode($temp_data->data),true);
$temp_data_contains['response'] = $response_array;
$temp_data->update([
'data' => $temp_data_contains,
]);
if(request()->expectsJson()) {
$this->output['redirection_response'] = $response_array;
$this->output['redirect_links'] = [];
$this->output['redirect_url'] = $response_array['GatewayPageURL'];
return $this->get();
}
return redirect()->away($response_array['GatewayPageURL']);
}
throw new Exception($response_array['failedreason']);
}
public function sslCommerzJunkInsert($temp_token) {
$output = $this->output;
$data = [
'gateway' => $output['gateway']->id,
'currency' => $output['currency']->id,
'amount' => json_decode(json_encode($output['amount']),true),
'wallet_table' => $output['wallet']->getTable(),
'wallet_id' => $output['wallet']->id,
'creator_table' => auth()->guard(get_auth_guard())->user()->getTable(),
'creator_id' => auth()->guard(get_auth_guard())->user()->id,
'creator_guard' => get_auth_guard(),
];
return TemporaryData::create([
'type' => PaymentGatewayConst::SSLCOMMERZ,
'identifier' => $temp_token,
'data' => $data,
]);
}
public function getSslCommerzCredentials($output)
{
$gateway = $output['gateway'] ?? null;
if(!$gateway) throw new Exception("Payment gateway not available");
$store_id_sample = ['store id','store','public key','public', 'test public key', 'id'];
$secret_key_sample = ['secret','secret key','store password', 'password','secret id','store password (api/secret key)'];
$store_id = PaymentGateway::getValueFromGatewayCredentials($gateway,$store_id_sample);
$secret_key = PaymentGateway::getValueFromGatewayCredentials($gateway,$secret_key_sample);
$mode = $gateway->env;
$gateway_register_mode = [
PaymentGatewayConst::ENV_SANDBOX => PaymentGatewayConst::ENV_SANDBOX,
PaymentGatewayConst::ENV_PRODUCTION => PaymentGatewayConst::ENV_PRODUCTION,
];
if(array_key_exists($mode,$gateway_register_mode)) {
$mode = $gateway_register_mode[$mode];
}else {
$mode = PaymentGatewayConst::ENV_SANDBOX;
}
$credentials = (object) [
'store_id' => $store_id,
'secret_key' => $secret_key,
'mode' => $mode
];
$this->sslCommerz_gateway_credentials = $credentials;
return $credentials;
}
public function getSslCommerzRequestCredentials($output = null)
{
if(!$this->sslCommerz_gateway_credentials) $this->getSslCommerzCredentials($output);
$credentials = $this->sslCommerz_gateway_credentials;
if(!$output) $output = $this->output;
$request_credentials = [];
$request_credentials['store_id'] = $credentials->store_id;
$request_credentials['secret_key'] = $credentials->secret_key;
if($output['gateway']->env == PaymentGatewayConst::ENV_PRODUCTION) {
$request_credentials['base_url'] = $this->sslCommerz_production_api_base_url;
}else {
$request_credentials['base_url'] = $this->sslCommerz_sandbox_api_base_url;
}
$this->request_credentials = (object) $request_credentials;
return (object) $request_credentials;
}
public function isSslCommerz($gateway)
{
$search_keyword = ['sslcommerz','sslcommerz gateway','gateway sslcommerz','sslcommerz payment gateway'];
$gateway_name = $gateway->name;
$search_text = Str::lower($gateway_name);
$search_text = preg_replace("/[^A-Za-z0-9]/","",$search_text);
foreach($search_keyword as $keyword) {
$keyword = Str::lower($keyword);
$keyword = preg_replace("/[^A-Za-z0-9]/","",$keyword);
if($keyword == $search_text) {
return true;
break;
}
}
return false;
}
public function sslcommerzSuccess($output) {
$reference = $output['tempData']['identifier'];
$output['capture'] = $output['tempData']['data']->response ?? "";
$output['callback_ref'] = $reference;
$response_status = $output['capture']->status ?? "";
if(!$this->searchWithReferenceInTransaction($reference)) {
// need to insert new transaction in database
try{
$transaction_response = $this->createTransaction($output);
}catch(Exception $e) {
throw new Exception($e->getMessage());
}
return $transaction_response;
}
}
public function sslcommerzCallbackResponse($reference,$callback_data, $output = null) {
if(!$output) $output = $this->output;
$callback_status = $callback_data['status'] ?? "";
if(isset($output['transaction']) && $output['transaction'] != null && $output['transaction']->status != PaymentGatewayConst::STATUSSUCCESS) { // if transaction already created & status is not success
// Just update transaction status and update user wallet if needed
if($callback_status == "VALID") {
$transaction_details = json_decode(json_encode($output['transaction']->details),true) ?? [];
$transaction_details['gateway_response'] = $callback_data;
// update transaction status
DB::beginTransaction();
try{
DB::table($output['transaction']->getTable())->where('id',$output['transaction']->id)->update([
'status' => PaymentGatewayConst::STATUSSUCCESS,
'details' => json_encode($transaction_details),
'callback_ref' => $reference,
]);
$this->updateWalletBalance($output);
DB::commit();
}catch(Exception $e) {
DB::rollBack();
logger($e);
throw new Exception($e);
}
}
}else { // need to create transaction and update status if needed
$this->createTransaction($output);
}
logger("Transaction Created Successfully ::" . $callback_data['status']);
}
}
Developer
Initiates a new payment transaction.
| Parameter | Type | Details |
|---|---|---|
| amount | decimal | Your Amount , Must be rounded at 2 precision. |
| currency | string | Currency Code, Must be in Upper Case (Alpha-3 code) |
| success_url | string | Enter your return or success URL |
| cancel_url | string (optional) | Enter your cancel or failed URL |
Request Example (guzzle)
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', $base_url.'create-order', [
'headers' => [
'Authorization' => 'Bearer '. $authorizationToken,
'accept' => 'application/json',
'content-type' => 'application/json',
],
'form_params' => [
'amount' => '$amount',
'currency' => 'currency',
'success_url' => 'success_url',
'cancel_url' => 'cancel_url',
],
]);
echo $response->getBody();
**Response: SUCCESS (200 OK)**
{
"message": {
"success": [
"Order created successfully."
]
},
"data": {
"redirect_url":"https://example.com/login/OISADFDFSDFSF",
"order_details":{
"amount" : "10",
"fixed_charge" : 2,
"percent_charge" : 1,
"total_charge" : 3,
"total_payable" : 13,
"currency" : "USD",
"expiry_time": "2024-04-25T06:48:35.984285Z",
"success_url": "http://127.0.0.1/nfcpay/user/transaction/success",
"cancel_url": "http://127.0.0.1/nfcpay/user/transaction/cancel"
}
},
"type": "success"
}
**Response: ERROR (400 FAILED)**
{
"message": {
"error": [
"Invalid token."
]
},
"data": null,
"type": "error"
}