Franchise

Learn more about franchise APIs and their usage.

Guidelines

Below are some of the points you must be aware of while calling Payouts APIs:

  • All API requests and responses are in JSON format.

  • POST requests should include ContentType: application/json

  • All API response have status, message, and data.

  • Swipez uses API keys to allow access to the API. Once you have signed up at our merchant site, you will be able to see your AccessKey and SecretKey.

Quick Reference

URL

HTTP Verb

Functionality

/api/token

POST

To get auth token.

/api/v1/franchise/save

POST

To save franchise details.

/api/v1/franchise/update

POST

To update franchise details.

/api/v1/franchise/delete

POST

To delete franchise.

Authentication

Calling the Authentication APIs allows you to get and verify bearer tokens returned by Swipez. Swipez require these token for all further communication.

  • Swipez libraries automatically call the Authorize API and internally store the token.

  • Do not store the token in an insecure manner. Regenerating a new token does not invalidate the already generated token. Token generated from one IP address cannot be used from a different IP address.

  • Token generated is valid for 60 Min . Please ensure that you get a new token by calling the authorize API once the token has expired.

Rate limiting

The API is rate limited per user. You will receive a 429 HTTP status code if you exceed the rate limit. The rate limit is 30 requests per minute per user and is subject to change.

post
Get token

/api/token
This endpoint allows you to get API token.
Request
Response
Request
Form Data Parameters
access_key_id
required
string
Your access key.
secret_access_key
required
string
Your secret key.
Response
200: OK
{
"success": {
"token": "<GENERATED TOEKN>"
}
}
401: Unauthorized
{
"error": "Invalid Keys",
"status": 0
}

Sample code

CURL
PHP
CURL
curl --location --request POST '<BASE URL>/api/token' \
--form 'access_key_id="<GET ACCESS KEY ID FROM YOUR ACCOUNT>"' \
--form 'secret_access_key="<GET SECRET ACCESS KEY FROM YOUR ACCOUNT>"'
PHP
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '<BASE URL>/api/token',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('access_key_id' => '<GET ACCESS KEY ID FROM YOUR ACCOUNT>','secret_access_key' => '<GET SECRET ACCESS KEY FROM YOUR ACCOUNT>'),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

post
Save franchise

/api/v1/franchise/save
This endpoint allows you to add franchise.
Request
Response
Request
Headers
Authorization
required
string
Bearer auth token
Content-Type
required
string
application/json
Body Parameters
franchise_code
optional
string
Unique identifier
franchise_name
required
string
Name of franchise.
contact_person_name
required
string
Contact person name.
email_id
required
string
Email id of franchise.
mobile
required
string
10 digit mobile number of franchise
pan_number
optional
string
10 Char Pan number
aadhar_number
optional
string
12 digit Aadhar num
gst_number
optional
string
15 char GST number.
address
required
string
Franchise address.
city
optional
string
Franchise city.
state
optional
string
Franchise state.
zipcode
optional
string
Franchise zipcode
enable_online_settlement
required
number
If you want transfer franchise commission online. Values 1 for yes 0 for no.
commission_type
optional
string
Values: Percentage or Fixed
commission
optional
number
Commission value either amount or percentage
settlement_type
optional
string
"Auto" for automatic transfer commission amount. "Manual" for manual transfer.
bank_holder_name
optional
string
Bank account holder name
account_number
optional
string
Bank account number
bank_name
optional
string
Bank name
account_type
optional
string
Account type "Saving" or "Current"
ifsc
optional
string
IFSC code
enable_franchise_login
optional
string
To enable franchise login 1 for yes 0 for no.
login_email
optional
string
Franchise login email id
password
optional
string
Franchise login password
role_name
optional
string
Role name you can find in Setting->Roles menu on web dashboard
optional
string
Response
200: OK
{
"success":"Franchise saved successfully",
"status": "1",
"franchise_id": "8545"
}

Sample code

CURL
PHP
CURL
curl --location --request POST '<BASE URL>/api/v1/franchise/save' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"franchise_code": "5",
"franchise_name": "john Ppp",
"contact_person_name":"Paresh",
"email_id": "[email protected]",
"mobile": "9999999999",
"pan_number": "",
"aadhar_number": "",
"gst_number": "",
"address": "404, Ferry bell,Lodha medows",
"city": "Pune",
"state": "Maharashtra",
"zipcode": "411016",
"enable_online_settlement": "1",
"commission_type": "Percentage",
"commission": "50",
"settlement_type":"Auto",
"bank_holder_name": "Paresh",
"account_number": "00111122236",
"bank_name": "SBI",
"account_type": "Saving",
"ifsc": "HDFC0000001",
"enable_franchise_login":"1",
"login_email":"[email protected]",
"password":"password1",
"role_name":"Role 1"
}
'
PHP
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '<BASE URL>/api/v1/franchise/save',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"franchise_code": "5",
"franchise_name": "john Ppp",
"contact_person_name":"Paresh",
"email_id": "[email protected]",
"mobile": "9999999999",
"pan_number": "",
"aadhar_number": "",
"gst_number": "",
"address": "404, Ferry bell,Lodha medows",
"city": "Pune",
"state": "Maharashtra",
"zipcode": "411016",
"enable_online_settlement": "1",
"commission_type": "Percentage",
"commission": "50",
"settlement_type":"Auto",
"bank_holder_name": "Paresh",
"account_number": "00111122236",
"bank_name": "SBI",
"account_type": "Saving",
"ifsc": "HDFC0000001",
"enable_franchise_login":"1",
"login_email":"[email protected]",
"password":"password1",
"role_name":"Role 1"
}
',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer <TOKEN>',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

post
Update franchise

/api/v1/franchise/update
This endpoint allows you to update franchise.
Request
Response
Request
Headers
Authorization
required
string
Bearer auth token
Content-Type
required
string
application/json
Body Parameters
franchise_id
required
string
Franchise id
franchise_name
required
string
Name of franchise.
contact_person_name
required
string
Contact person name.
email_id
required
string
Email id of franchise.
mobile
required
string
10 digit mobile number of franchise
pan_number
optional
string
10 Char Pan number
aadhar_number
optional
string
12 digit Aadhar num
gst_number
optional
string
15 char GST number.
address
required
string
Franchise address.
city
optional
string
Franchise city.
state
optional
string
Franchise state.
zipcode
optional
string
Franchise zipcode
optional
string
Response
200: OK
{
"success":"Franchise saved successfully",
"status": "1",
"franchise_id": "8545"
}

Sample code

CURL
PHP
CURL
curl --location --request POST '<BASE URL>/api/v1/franchise/update' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"franchise_id": "5",
"franchise_name": "john Ppp",
"contact_person_name":"Paresh",
"email_id": "[email protected]",
"mobile": "9999999999",
"pan_number": "",
"aadhar_number": "",
"gst_number": "",
"address": "404, Ferry bell,Lodha medows",
"city": "Pune",
"state": "Maharashtra",
"zipcode": "411016"
}
'
PHP
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '<BASE URL>/api/v1/franchise/update',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"franchise_id": "5",
"franchise_name": "john Ppp",
"contact_person_name":"Paresh",
"email_id": "[email protected]",
"mobile": "9999999999",
"pan_number": "",
"aadhar_number": "",
"gst_number": "",
"address": "404, Ferry bell,Lodha medows",
"city": "Pune",
"state": "Maharashtra",
"zipcode": "411016"
}
',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer <TOKEN>',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

post
Delete franchise

/api/v1/franchise/delete
This endpoint allows you to delete franchise.
Request
Response
Request
Headers
Authorization
required
string
Bearer auth token
Content-Type
required
string
application/json
Body Parameters
franchise_id
required
integer
Franchise id
Response
200: OK
{
"success":"Franchise saved successfully",
"status": "1",
"franchise_id": "8545"
}

Sample code

CURL
PHP
CURL
curl --location --request POST '<BASE URL>/api/v1/franchise/delete' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--form 'franchise_id="39"'
PHP
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '<BASE URL>/api/v1/franchise/update',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('franchise_id' => '1'),
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer <TOKEN>',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;