Overview
Documentation ( Version: 1.00 )
Updated: 24th June, 2024
General overview
Connect effortlessly through our system. Link apps and data sources, automate tasks, and enjoy smooth workflows with ease.Receive payments directly into your personal account using RoyelPay's payment automation software. No need to handle payments manually anymore.
Setup your panel
- For registration, click the link https://royelpay.net/signup
-
Complete the following process:
- Setup your Payment Gateways https://royelpay.net/merchant/gateway
- Buy a plan from https://royelpay.net/merchant/plan
- Add Brand Details https://royelpay.net/merchant/apikeygenerator
- Add Your Device https://royelpay.net/merchant/apikeygenerator
-
Setup your credentials:
- Your Secret Key
- Your Brand Key
Setup your Mobile App
- Click the link TO DOWNLOAD MOBILE APP
-
Complete the following process:
- Install the app with necessary permission https://royelpay.net/RoyelPayV1.0.apk
- Copy the secret key
- Get Back to mobile app and Enter secret key.
- Few Seconds Wait & Check Your Device Information from Userpanel
Payment Process
We have made Live environment to process payments.
Live Environment
All the transaction made using this environment are counted as real transaction, URL starts with https://royelpay.net/api/request/payment/create
Method:POST
Request Parameters
Param Name | Data Type | Description |
---|---|---|
cus_name
|
string (50) | Mandatory - This parameter will be returned only when the request successfully initiates |
cus_email
|
string (50) | Mandatory - This parameter will be returned only when the request successfully initiates |
cus_user_id
|
string (50) | Optional - his parameter will be returned only when the request successfully initiates |
currency
|
string (10) | Mandatory - This parameter will be returned only when the request successfully initiates |
is_test
|
string (2) | Mandatory - This parameter will be returned only when the request successfully initiates |
success_url
|
string (100) | Mandatory - This parameter will be returned only when the request successfully initiates |
cancel_url
|
string (100) | Mandatory - This parameter will be returned only when the request successfully initiates |
callback_url
|
string (100) | Optional - This parameter will be returned only when the request successfully initiates |
amount
|
string (50) | Mandatory - This parameter will be returned only when the request successfully initiates |
Request Headers
Param Name | Data Type | Description | |
---|---|---|---|
Content-Type
|
'Accept: application/json', | Mandatory | |
Accept
|
application/json | Mandatory | |
CURLOPT_COOKIEe
|
private_key
|
string (50) | Mandatory Your Secret KEY |
brand_key
|
string (50) | Mandatory Your Brand KEY |
Returned Parameters
In GET Request
Param Name | Data Type | Description |
---|---|---|
invoice_id
|
string (50) | Receive it by $_GET['invoice_id'] in your success url |
trxid
|
string (50) | Receive it by $_GET['trxid'] in your success url |
getway
|
string (50) | Receive it by $_GET['getway'] in your success url |
status
|
int (2) | Receive (0/1) by $_GET['status'] in your success url |
Create Payment Request
Security Check Points:
- Your Public IP must be registered at RoyelPay Live System
Payment Create code
<?php
$curl = curl_init();
$privateKey = 'kq05cefSxrvuHORkFm9DTwu7ftTopqbS1Zjgx4HcGsCw80wSxg';
$Brand_Key = 'HILBRFgR6F';
$data = array(
'cus_name' => 'demo',
'cus_email' => 'demo@gmail.com',
'cus_user_id' => '10',
'amount' => '10',
'currency' => 'BDT',
'is_test' => '0',
'success_url' => 'success.php',
'cancel_url' => 'cancel.php',
'callback_url' => 'callback_url.php',
);
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://royelpay.net/api/request/payment/create',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => json_encode($data),
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Content-Type: application/json',
),
CURLOPT_COOKIE => "private_key=$privateKey; brand_key=$Brand_Key",
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>