NAV
bash javascript php

Introduction

Welcome to the Vapulus third-party API reference.
This document instructs third-party applications in how to access our API in order to make and schedule transactions on behalf of users.
Use our API to get the most out of Vapulus.

Available Operations

  1. Add Card
    Allows the third-party app to add card and returns IDs for card and user for subsequent requests.

  2. Resend code
    Use it to get another OTP, in case you forget it or lost it.

  3. Validate OTP
    After adding card, user receives OTP via SMS. The OTP must be validated before operations with the card can proceed.
    After make payment, user receives OTP via SMS. The OTP must be validated before processing transaction.

  4. Make Payment
    Make transactions using User and Card IDs.

  5. Schedule Payment
    Schedule payments for this card for a designated amount, time period, or frequency.

  6. Card Info
    Get truncated card number and expiry date for the specified card.

  7. Transactions List
    Get all transactions.

  8. Transaction Info
    Get all information of a successfull transaction.

  9. User Info
    Get user’s card list and task list.

  10. Schedule Info
    Get specific task info, card info, and task status.

  11. Task Info
    Get Scheduled Task information.

Sample Code

We have included sample code in NODE.js and PHP!. For testing, you can use CURL.

You can view code examples in the dark area on the right side of this window. Use the tabs on the top right to switch programming languages.

Authentication

Vapulus requires authentication before allowing API access. You can register a new merchant account though our merchant portal to begin using our API.

Generating Secure Hash

In order to generate your hash secret:

  1. Order all sent parameters from A-Z except AppId and Password
  2. Concatenate parameters as URL query parameters, e.g. param1=param1Value&param2=param2Value
  3. Hash the concated string using SHA-256 HMAC with your hash secret. You can get your hash secret from your merchant account.

Example

// https://repl.it/@islamvapulus/Integration
function generateHash(hashSecret,postData) {
    //sort input param
    var orderedData = {};
    Object.keys(postData).sort().forEach(function(key) {
            orderedData[key] = postData[key];
    });

    //format uri encoding of param Object
    var message = '';
    for (var i in orderedData) {
            message += '&' + i + '=' + orderedData[i];
    }
    message = message.substr(1);

    //generate the secure hash
    var cr = require('crypto');
    var Buffer = require('buffer').Buffer;
    var privateKey = new Buffer(hashSecret, 'hex', 'ascii');

    var hash = cr
                .createHmac('sha256', privateKey)
                .update(message)
                .digest('hex');

    return hash;
}

//send params without apiId and password
var postData ={
    cardNum : '5123456789012346',
    cardExp : 2105,
    cardCVC : 123,
    holderName :'John Doe',
    mobileNumber :'20100000000000'
};
//your hash secret from app you create on business.vapulus.com
var hashSecret='C0DF9A7B3819968807A9D4E48D0E65C6';

// this value of secureHash should be with the request
var mySecureHash = generateHash(hashSecret,postData);
//output 
//6975f8f502e5972722a6d8760cc558e7867f36a312a5d336c4ba983dcfb81691
//https://repl.it/@islamvapulus/Integration-php
function generateHash($hashSecret,$postData) {
    ksort($postData);

    $message="";
    $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);

    return hash_hmac('sha256', $message, $secret);
}

$postData = array(
    "cardNum" =>  "5123456789012346",
    "cardExp" =>  2105,
    "cardCVC" =>  123,
    "holderName" => "John Doe",
    "mobileNumber" => "20100000000000"
);

$hashSecret= 'C0DF9A7B3819968807A9D4E48D0E65C6';

$secureHash = generateHash($hashSecret,$postData);
//output
//6975f8f502e5972722a6d8760cc558e7867f36a312a5d336c4ba983dcfb81691

If your requested parameters are as follows:

Param Name Example Value
cardNum 5123456789012346
cardExp 2105
cardCVC 123
holderName John Doe
mobileNumber 20100000000000

After order and concat string will read:
cardCVC=123&cardExp=2105&cardNum=5123456789012346&holderName=John Doe&mobileNumber=20100000000000

If the hash secret is: C0DF9A7B3819968807A9D4E48D0E65C6

The secure hash value is:
6975f8f502e5972722a6d8760cc558e7867f36a312a5d336c4ba983dcfb81691

Using NPM package to generate secure hash

var vapulusHash = require('vapulus-hashing-pkg');

var myRequestParams = {
    cardNum : '5123456789012346',
    cardExp : 2105,
    cardCVC : 123,
    holderName :'John Doe',
    mobileNumber :'20100000000000'
};
var hashSecret='C0DF9A7B3819968807A9D4E48D0E65C6';

var secureHash = vapulusHash.generateHash(hashSecret,myRequestParams);
//output
//6975f8f502e5972722a6d8760cc558e7867f36a312a5d336c4ba983dcfb81691

If you wish to use our NPM package to generate your secure hash string, follow these steps:

  1. Install NPM package npm install vapulus-hashing-pkg –save
  2. The package is now installed in your project. You can now use it as shown on the right hand side of the screen.

Third-party API list

_baseUrl: https://api.vapulus.com:1338/

Available operations:

  1. Add Card
    Allows the third-party app to add card and returns IDs for card and user for subsequent requests.

  2. Resend code
    Use it to get another OTP, in case you forget it or lost it.

  3. Validate OTP
    After adding card, user receives OTP via SMS. The OTP must be validated before operations with the card can proceed.

  4. Make Payment
    Make transactions using User and Card IDs.

  5. Schedule Payment
    Schedule payments for this card for a designated amount, time period, or frequency.

  6. Card Info
    Get truncated card number and expiry date for the specified card.

  7. Transactions List
    Get all transactions.

  8. Transaction Info
    Get all information of a successfull transaction.

  9. User Info
    Get user’s card list and task list.

  10. Schedule Info
    Get specific Schedule info.

  11. Task Info
    Get Scheduled Task information.

Add card

curl -X POST "https://api.vapulus.com:1338/app/addCard" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d cardNum=XXX \
  -d cardExp=XXX \
  -d cardCVC=XXX \
  -d holderName=XXX \
  -d mobileNumber=XXX \
  -d email=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');


var postData = {
    cardNum : 'XXXXXXXXXXXXXXXX',
    cardExp : '2105',
    cardCVC : '123',
    holderName :'John Doe',
    mobileNumber :'XXXXXXXXXXX',
    email :'XXXX@XXXX.XXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/addCard',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'cardNum' =>  'XXXXXXXXXXXXXXXX',
    'cardExp' =>  2105,
    'cardCVC' =>  123,
    'holderName' => 'John Doe',
    'mobileNumber' => 'XXXXXXXXXXX',
    'email' => 'XXXX@XXXX.XXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/addCard';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
    "statusCode": 200,
    "message": "Success Message",
    "data": {
        "requiredOTP": true,
        "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
}

_baseUrl + app/addCard

Allows the third-party app to add card and returns IDs for card and user for subsequent requests.

These are the params you will need:

Params Description restriction
cardNum 16-digit card number required
cardExp expiry date of the card, YYMM required
cardCVC CVC number on back of card required
holderName cardholder name required
mobileNumber mobile number of card owner with country code required
email email of card owner required

Resend code

curl -X POST "https://api.vapulus.com:1338/app/resendCode" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX \
  -d mobileNumber=XXX \
  -d transactionId=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');

var postData = {
    userId: 'XXXXXXXX',
    cardId: 'XXXXXXXX',
    mobileNumber: 'XXXXXXXX',
    transactionId: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/resendCode',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' =>  'XXXXXXXX',
    'mobileNumber' =>  'XXXXXXXX',
    'transactionId' =>  'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/resendCode';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

// response for mobile number
{
    "statusCode": 200,
    "message": "Success Message",
    "data": {
        "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
}

// response for transaction
{
    "statusCode": 200,
    "message": "Success Message",
    "data": {
        "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "transactionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
}

_baseUrl + app/resendCode

Use it to get another OTP, in case you forget it or lost it.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID of card added to the system required
mobileNumber mobile number of card owner with country code optional
transactionId ID number of the successful transaction optional

Please be aware of the following:


Validate OTP

curl -X POST "https://api.vapulus.com:1338/app/validateOTP" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX \
  -d transactionId=XXX \
  -d validationCode=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');

var postData = {
    userId: 'XXXXXXXX',
    cardId: 'XXXXXXXX',
    transactionId: 'XXXXXXXX',
    validationCode: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/validateOTP',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' => 'XXXXXXXX',
    'transactionId' => 'XXXXXXXX',
    'validationCode' => 'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/validateOTP';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

// the response for new user
{
    "statusCode": 200,
    "message": "Success Message",
    "data": {
        "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "status": "successful"
    }
}

// the response for transaction
{
    "stautsCode": 200,
    "message": "Success Message",
    "data": {
        "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "transactionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "status": "accepted"
    }
}

_baseUrl + app/validateOTP

After adding card or receiving a transactrion, user receives OTP via SMS. The OTP must be validated before operations with the card can proceed.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID number of card added to system required
transactionId ID number of the successful transaction optional
validationCode validation code required

Make payment

curl -X POST "https://api.vapulus.com:1338/app/makePayment" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX \
  -d amount=XXX 
required params are:
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');


var postData = {
  userId: 'XXXXXXXX',
  cardId: 'XXXXXXXX',
amount: 'XXXXX.XX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/makePayment',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' =>  'XXXXXXXX',
'amount' => 'XXXXX.XX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/makePayment';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
  "msg" : "response msg",
  "statusCode": 200,
  "data": {
    "transactionId": 1,
    "status": "pending/approved"
  }
}

_baseUrl + app/makePayment

Make transactions using User and Card IDs.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID number of card added to system required
amount amount requested in the transaction required

Schedule payment

curl -X POST "https://api.vapulus.com:1338/app/schedulePayment" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX \
  -d scheduledPeriod = XXX \
  -d amount=XXX \
  -d fromDate=XXX \
  -d toDate=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');


var postData = {
  userId: 'XXXXXXXX',
  cardId: 'XXXXXXXX',
  scheduledPeriodType: 'XXXXX' [week, month, quarter, half, or year],
  scheduledPeriodValue: 'XXXXX',
  amount: 'XXXXXX.XX',
  fromDate: 'XXXXXX',
  numberOfPayment: 'XXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/schedulePayment',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' =>  'XXXXXXXX',
    'amount' => 'XXXXX.XX',
    'scheduledPeriodType' => 'XXXXX' [week, month, quarter, half, or year],
    'scheduledPeriodValue' => 'XXXXX',
    'amount' => 'XXXXXX.XX',
    'fromDate' => 'XXXXXX',
    'numberOfPayment' => 'XXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/schedulePayment';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
    "statusCode": 200,
    "message": "Success Message",
    "data": {
        "scheduleId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "appId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "amount": "1000",
        "fromDate": "yyyy-MM-ddTHH:mm:ssZ",
        "numberOfPayment": "1",
        "scheduledPeriodType": "week",
        "scheduledPeriodValue": "4",
        "createdAt": "yyyy-MM-ddTHH:mm:ssZ",
        "updatedAt": "yyyy-MM-ddTHH:mm:ssZ",
        "tasks":[
                 //array of task ids'
             ]
    }
}

_baseUrl + app/schedulePayment

Schedule payments for this card for a designated amount, time period, or frequency.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID number of card added to system required
scheduledPeriodType it could be on of the following:
  • scheduledPeriodType: ‘week’
  • scheduledPeriodType: ‘month’
  • scheduledPeriodType: ‘quarter’
  • scheduledPeriodType: ‘half’
  • scheduledPeriodType: ‘year’
required
scheduledPeriodValue it could be on of the following:
  • if scheduledPeriodType: ‘week’ value should be: 1 - 7
  • if scheduledPeriodType: ‘month’ value should be: 1 - 30
  • if scheduledPeriodType: ‘quarter’ value should be: true
  • if scheduledPeriodType: ‘half’ value should be: true
  • if scheduledPeriodType: ‘year’ value should be: ddMM .ex: 0105
required
amount amount requested in the transaction required
fromDate the start date of the period required
numberOfPayment how many times the system will charge according to the scheduledPeriodType required

User info

curl -X POST "https://api.vapulus.com:1338/app/userInfo" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');

var postData = {
userId: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/userInfo',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/userInfo';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
   "stautsCode": 200,
   "message": "Success Message",
   "data": {
       "cards": [
           { "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" }
        ],
       "tasks": [
           { "taskId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" },
           { "taskId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" }
        ],
       "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
   }
}

_baseUrl + app/userInfo

Get user’s card list and task list.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required

Card info

curl -X POST "https://api.vapulus.com:1338/app/cardInfo" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');


var postData = {
  userId: 'XXXXXXXX',
  cardId: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/cardInfo',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' =>  'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/cardInfo';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
   "stautsCode": 200,
   "message": "Success Message",
   "data": {
       "cardNum": "************2346",
       "cardExp": "2105",
       "status": "approved"
   }
}

_baseUrl + app/cardInfo

Get truncated card number and expiry date for the specified card.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID number of card added to system required

Transactions list

curl -X POST "https://api.vapulus.com:1338/app/transactions/list" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d status=XXX \
  -d sorting=XXX \
  -d fromDate=XXX \
  -d toDate=XXX \
  -d pageNum=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');

var postData = {
    userId: 'XXXXXXXX',
    status: 'XXXXXXXX',
    sorting: 'XXXXXXXX',
    fromDate: 'XXXXXXXX',
    toDate: 'XXXXXXXX',
    pageNum: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/transactions/list',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'status' => 'XXXXXXXX',
    'fromDate' => 'XXXXXXXX',
    'toDate' => 'XXXXXXXX',
    'sorting' => 'XXXXXXXX',
    'pageNum' => 'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/transactions/list';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

// the response
{
    "statusCode": 200,
    "message": "Success Message",
    "data": {
        "count": 19,
        "transaction": [
            {
                "transactionId": "cfd2478b-b945-42e4-a1be-16eca8e5fd88",
                "fromId": "884ed6e3-0e36-407b-83c0-aa9abb20b682",
                "toId": "2a510161-381c-4ae7-88ba-fea9e119abe5",
                "amount": 2020,
                "status": "1",
                "currencyIso": "EGP",
                "from": {},
                "to": {}
            }
]
}

_baseUrl + app/transactions/list

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
status status of the transactions optional
fromDate starting date optional
toDate end date optional
sorting the way the data is ordered optional
pageNum which page of transactions list optional

Transaction info

curl -X POST "https://api.vapulus.com:1338/app/transactionInfo" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d transactionId=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');


var postData = {
  transactionId: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/transactionInfo',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
        console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'transactionId' => 'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/transactionInfo';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
  "msg" : "response msg",
  "statusCode": 200,
  "data": {
    "transactionId": XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,
    "fromId": XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,
    "toId": XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,
    "amount": XXXXX,
    "currencyIso": XXX,
    "mobileNumber": XXXXXXXXXXX,
    "status": 1 [0 for accepted, 1 for pending, 2 for rejected, and 3 for canceled],
    "transactionType": "request",
    "transactionCode": "5623626",
    "createdAt": "2018-04-05T06:59:33.000Z",
    "updatedAt": "2018-04-05T06:59:33.000Z"
  }
}

_baseUrl + app/transactionInfo

Get all information of a successfull transaction.

These are the params you will need:

Params Description restriction
transactionId ID of successful transaction required

Schedule info

curl -X POST "https://api.vapulus.com:1338/app/scheduleInfo" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX \
  -d scheduleId=XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');

var postData = {
  userId: 'XXXXXXXX',
  cardId: 'XXXXXXXX',
  scheduleId: 'XXXXXXXX'
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/scheduleInfo',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' =>  'XXXXXXXX',
    'scheduleId' =>  'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/scheduleInfo';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
   "stautsCode": 200,
   "message": "Success Message",
   "data": {
       "scheduleId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
       "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
       "cardId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
       "appId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
       "amount": "1000",
       "scheduledPeriodType": "month",
       "scheduledPeriodValue": "12",
       "fromDate": "yyyy-MM-ddTHH:mm:ssZ",
       "numberOfPayment": "2",
       "createdAt": "yyyy-MM-ddTHH:mm:ssZ",
       "updatedAt": "yyyy-MM-ddTHH:mm:ssZ",
       "tasks":[
                //array of task ids'
            ]
   }
}

_baseUrl + app/scheduleInfo

Get specific task info, card info, and task status.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID of user card on our system required
scheduleId ID of Schedule added to the system required

Task info

curl -X POST "https://api.vapulus.com:1338/app/taskInfo" \
  -d appId=XXX \
  -d password=XXX \
  -d hashSecret=XXX \
  -d userId=XXX \
  -d cardId=XXX \
  -d taskId = XXX 
//https://repl.it/@islamvapulus/node-http-request-with-hashing
var vapulusHash = require('vapulus-hashing-pkg');
var request = require('request');


var postData = {
  userId: 'XXXXXXXX',
  cardId: 'XXXXXXXX',
  taskId: 'XXXXXXXX' 
};

var secureHash='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.hashSecret=vapulusHash.generateHash(secureHash,postData);

postData.appId='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
postData.password='XXXXXXXX';

var _option = {
  url: 'https://api.vapulus.com:1338/app/taskInfo',
  method: 'POST',
  // rejectUnauthorized: false,
  form:postData
};

request.post(_option,
  function (err, response, body) {
    if (err)
      console.log(err);
      else
          console.log(response.body);
  }
);
//https://repl.it/@islamvapulus/php-http-request-with-hashing
function generateHash($hashSecret,$postData) {
    ksort($postData);
        $message="";
        $appendAmp=0;
    foreach($postData as $key => $value) {
            if (strlen($value) > 0) {
                if ($appendAmp == 0) {
                    $message .= $key . '=' . $value;
                    $appendAmp = 1;
                } else {
                    $message .= '&' . $key . "=" . $value;
                }
            }
        }

    $secret = pack('H*', $hashSecret);
    return hash_hmac('sha256', $message, $secret);
}

function HTTPPost($url, array $params) {
        $query = http_build_query($params);
        $ch    = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HEADER, false);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $query);
        $response = curl_exec($ch);
        curl_close($ch);
        return $response;
    }

$postData = array(
    'userId' =>  'XXXXXXXX',
    'cardId' =>  'XXXXXXXX',
    'taskId' => 'XXXXXXXX'
);

$secureHash= 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['hashSecret'] = generateHash($secureHash,$postData);

$postData['appId']='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$postData['password']='XXXXXXXX';

$url ='https://api.vapulus.com:1338/app/taskInfo';

$output=HTTPPost($url,$postData);

print_r($output);

The above request will returns JSON structured like this:

{
   "statusCode": 200,
   "message": "Success Message",
   "data": {
       "id": "9a8976c4-ac0b-41ff-985c-6d3a12065755",
       "scheduleId": "594a6d48-f5a7-474b-9181-932ff9d0156c",
       "userId": "0060cd86-7285-4641-8738-b9fc8c8ac303",
       "cardId": "3a2f5fc8-ec6f-4f0b-813b-d6d575dc22d9",
       "appId": "5ff7d48d-8a2f-458f-ac16-4ca7a215a0d7",
       "transactionId": "7a7086dc-33ba-4b23-9d95-0428d6ee4ba9",
       "fromId": "e2c92ef3-bad3-42c3-9e6b-88c4e2f263ad",
       "toId": "0060cd86-7285-4641-8738-b9fc8c8ac303",
       "amount": "10",
       "done": true,
       "runAt": "2018-03-08T21:00:00.000Z",
       "createdAt": "2018-04-05T11:29:16.000Z",
       "updatedAt": "2018-04-05T11:31:09.000Z"
   }
}

_baseUrl + app/taskInfo

Get Scheduled Task information.

These are the params you will need:

Params Description restriction
userId ID of user registered on our system required
cardId ID number of card added to system required
taskId ID of task added to the system required

Test Data

you can use one of these test cards to test your requests. Just make sure that your test MID is selected as the default MID on the system.

Card Type PAN Expiry Date CVC
MasterCard 5123456789012346 May-2021 123
Visa 4987654321098769 May-2021 123

Response Code & Errors

You will receive a statusCode parameter with each response.

Code Meaning
200 OK Request, check data object for more information
201 invaild AppId or Password, check msg object for more information
202 app is not active, check msg object for more information
203 invalid secureHash, check msg object for more information