Check Balance

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://onlineapi.skarla.com/exposed/wallet/get_wallet_balance_online",
  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 => json_encode("params" => array());
curl_setopt($curl,CURLOPT_HEADER, true);

curl_setopt($curl,CURLOPT_HTTPHEADER, array(
'Content-Type': 'application/json',
'Authorization': '***apikey****'
)
);
$response = curl_exec($curl);

curl_close($curl);
echo $response;
?>

curl  --header "Content-Type: application/json" --header "Authorization: ***apikey****" --location --request POST --data '
{
  "params:{" 
    }
  }
'\
'https://onlineapi.skarla.com/exposed/wallet/get_wallet_balance_online' \

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://onlineapi.skarla.com/exposed/wallet/get_wallet_balance_online',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': '***apikey****'
  },
  formData: {"params":{
    }
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

Response Example

{
    "ok": true,
    "message": "",
    "result": {
       "balance": "53174.868512898",
       "currency": "$"
    }
}

Operation that help the merchant to get his balance.

Check Balance URL

https://onlineapi.skarla.com/exposed/wallet/get_wallet_balance_online

Request Parameters

• No Parameters

Response

Property	Description
ok	true for success, false for failure
currency	balance currency
balance	merchant account balance

Orders List

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://onlineapi.skarla.com/exposed/order_list",
  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 => json_encode("params" => array(
    'name' => 'S00004',
    'id' => 0,
    'limit' => 20,
    'offset' => 0,
  )),

));
curl_setopt($curl,CURLOPT_HEADER, true);

curl_setopt($curl,CURLOPT_HTTPHEADER, array(
'Content-Type': 'application/json',
'Authorization': '***apikey****'
)
);
$response = curl_exec($curl);

curl_close($curl);
echo $response;
?>

curl --header "Content-Type: application/json" --header "Authorization: ***apikey****" --location --request POST --data ' \
  {
    "params":{ 
      "name":"S00004" ,
      "id":0 ,
      "limit":20 ,
      "offset":0 ,
      }
    }  
' \
'https://onlineapi.skarla.com/exposed/order_list'

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://onlineapi.skarla.com/exposed/order_list',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': '***apikey****'
  },
  formData: {"params":{
    'name': "S00004",
    'id': 0,
    'limit': 20,
    'offset': 0,
    }
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

Response Example

{
"ok": true,
"message": "",
"result": {
      "data": [
          {
              "id": 8,
              "name": "S00004",
              "date": "2023-06-08T11:17:54.000000Z",
          },
          ...,
          ...,
          ...
        ]
      }
}
  

Operation to get all orders for this merchant.

Request URL

https://onlineapi.skarla.com/exposed/order_list

Request Parameters

• name (optional): Search for order name
• id (optional): Filter to sepecific order id
• limit (default 20): represent page size
• offset (default 0): represent page offset

Response

Property	Description
ok	true for success, false for failure
data	array of objects, each object represents a order, and every order object has the following property
name	order name
id	order id
date	order date

Create Order (Pull Codes)

<?php

    $curl = curl_init();
    
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://onlineapi.skarla.com/exposed/pull_codes",
      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 => json_encode("params" => array(
        'product' => 150,
        'quantity' => 10,
        'email_id' => "test****@gmail.com",
      )),
    
    ));
    curl_setopt($curl,CURLOPT_HEADER, true);
    
    curl_setopt($curl,CURLOPT_HTTPHEADER, array(
    'Content-Type': 'application/json',
    'Authorization': '***apikey****'
    )
    );
    $response = curl_exec($curl);
    
    curl_close($curl);
    echo $response;
    ?>
    

curl --header "Content-Type: application/json" --header "Authorization: ***apikey****" --location --request POST --data ' \
      {
        "params":{ 
          "product":150 ,
          "quantity":10 ,
          "email_id":"test****@gmail.com" ,
          }
        }  
    ' \
    'https://onlineapi.skarla.com/exposed/pull_codes'
    

var request = require('request');
    var options = {
      'method': 'POST',
      'url': 'https://onlineapi.skarla.com/exposed/pull_codes',
      'headers': {
        'Content-Type': 'application/json',
        'Authorization': '***apikey****'
      },
      formData: {"params":{
        'product': 150,
        'quantity': 10,
        'email_id': "test****@gmail.com",
        }
      }
    };
    request(options, function (error, response) { 
      if (error) throw new Error(error);
      console.log(response.body);
    });
    

Response Example

{
    "ok": true,
    "message": "",
    "result": {
    "order": "S00193",
          "pulled_serials": [
              {
                  "serial_number": "fdb*****-*****-****-***-*******",
                  "serial_code": "7***********",
                  "product_id": 150,
                  "product_name": "ITUNES*****",
                  "SKU": "RT123e44****",
                  "expiry_date": "2025-06-08T00:00:00.000000Z",
                  "value": 2000,
                  "pin_code": 6***,
                  "is_prepaid": true,    
              },
        ...,
        ...,
        ...
      ]
    }
  }
      
    

Operation to create a new order for merchant account (Pull codes from a product invitaiton).

Request URL

https://onlineapi.skarla.com/exposed/pull_codes

Request Parameters

• product (required): Order product id
• quantity (required): quantity to be pulled (between 1 and 50,000)
• email_id (required if the product is prepaid): email

Response

Property	Description
ok	true for success, false for failure
pulled_serials	array of objects, each object represents a order, and every order object has the following property
serial_number	serial number of pulled code
serial_code	serial code of pulled code
product_id	pulled product id
product_name	pulled product name
SKU	pulled product SKU
expiry_date	Code Expiration Date
value	If Product Is Prepaid it represent the balance of prepaid code else 0
pin_code	If Product Is Prepaid it represent the pin code of prepaid code else null
is_prepaid	flag to check if the product is prepaid or not

check codes

<?php

    $curl = curl_init();
    
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://onlineapi.skarla.com/exposed/check_and_redeem_online",
      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 => json_encode("params" => array(
        'codes' => ["24*****-**-***-*****-******","89*****-**-***-*****-******"],
      )),
    
    ));
    curl_setopt($curl,CURLOPT_HEADER, true);
    
    curl_setopt($curl,CURLOPT_HTTPHEADER, array(
    'Content-Type': 'application/json',
    'Authorization': '***apikey****'
    )
    );
    $response = curl_exec($curl);
    
    curl_close($curl);
    echo $response;
    ?>
    

curl --header "Content-Type: application/json" --header "Authorization: ***apikey****" --location --request POST --data ' \
      {
        "params":{ 
          "codes":["24*****-**-***-*****-******","89*****-**-***-*****-******"] ,
          }
        }  
    ' \
    'https://onlineapi.skarla.com/exposed/check_and_redeem_online'
    

var request = require('request');
    var options = {
      'method': 'POST',
      'url': 'https://onlineapi.skarla.com/exposed/check_and_redeem_online',
      'headers': {
        'Content-Type': 'application/json',
        'Authorization': '***apikey****'
      },
      formData: {"params":{
        'codes': ["24*****-**-***-*****-******","89*****-**-***-*****-******"],
        }
      }
    };
    request(options, function (error, response) { 
      if (error) throw new Error(error);
      console.log(response.body);
    });
    

Response Example

{
    "ok": true,
    "message": "",
    "result": [
              {
                  "name": "fdb*****-*****-****-***-*******",
                  "image": "7***********",
                  "how_to_use": 150,
                  "how_to_use_ar": "ITUNES*****",
                  "check_count": "RT123e44****",
                  "last_check_time": "2025-06-08T00:00:00.000000Z",
                  "vendor": 2000,
                },
              ...,
              ...,
              ...
            ]
  }
      
    

Operation to create a new order for merchant account (Pull codes from a product invitaiton).

Request URL

https://onlineapi.skarla.com/exposed/check_and_redeem_online

Request Parameters

• codes (required): Array of string represent serial code or serial numbers of codes to be checked

Response

Property	Description
ok	true for success, false for failure
result	array of codes status as follow
name	product name of this code
image	product image url
how_to_use	How to use page url
how_to_use_ar	how to use page in arabic
check_count	how many time this code checked before
last_check_time	last time this code was checked
vendor	Product's Service Provider