Status Check

When integrate with this API, gain access to a comprehensive set of data related to a customer’s recurring billing. This includes detailed subscription information such as plan type, billing frequency, status, start and end dates and a full transaction history, encompassing each payment attempt, success or failure status, timestamps. By combining these two datasets, the API provides a holistic view of the customer’s payment lifecycle, enabling you to track, analyze, and manage recurring payments with greater accuracy and transparency.

POST

https://kraken.airpay.co.in/airpay/order/verify_subscription.php

Header

Parameter	Type Value	Description	Value Like
Content-Type required	String	The Content-Type header specifies the media type of the request or response body, allowing the receiver to correctly interpret the data. For XML data, use application/xml.	application/json

Request Body

Parameter	Type Value	Description	Value Like
merchant_id required	Number	Merchant Identification Number.	11111
subscription_id optional	Number	Either the airpay Subscription ID (subscription_id) or the Order ID (orderId) is required to use this API.	10234982
orderId optional	Number	Either the airpay Subscription ID (subscription_id) or the Order ID (orderId) is required to use this API.	1012
pgno optional	Number	pageno for getting recurring data, default is zero.	0

Success 200

Parameter	Type Value	Description	Value Like
status_code required	Numeric	200 – Request is valid with correct details. 400 – Request is invalid; merchants must recheck request data and reinitiate.	200
error_code required	Numeric	success, fail and refunded	00
status required	Text	fail,success	success
message required	Text	success, fail	Success
data required	array	Json response	[]
SUBSCRIPTION_STATUS required	Text	After initiate the subscription status check request and receive a response, you need to check the ‘SUBSCRIPTION_STATUS’ parameter for the latest mandate status. The possible values are: SUBSCRIBED, UNSUBSCRIBED, COMPLETED, or PAUSED.	SUBSCRIBED

Payload Creation Request Example

$merchant_id   = <merchant_id>;
$username      = <username>;
$password      = <password>;

$encryptionkey     = md5($username . "~:~" . $password);

$data = array();
$data['subscriptionId']     = $subscriptionId;
$data['orderId']            = $orderId;
$data['pgno']               = $pgno;

$encdata       = encrypt(json_encode($data), $encryptionkey);

$checksum       = checksum($data);

$payload    = ['merchant_id'=>$merchant_id,
    'encdata' => $encdata,
    'checksum' => $checksum
    ];

Subscribed Response

   HTTP/1.1 200 OK
[
   [status_code] => 200
   [error_code] => 00
   [status] => success
   [message] => Success
   [data] => Array
       (
          [SUBSCRIPTION_ID] => 10229184
          [SUBSCRIPTION_CYCLE] => 10
          [SUBSCRIPTION_DATE] => 20-04-2025
          [END_DATE] => 12-04-2035
          [NEXT_TRAN_DATE] => 12-04-2026
          [LAST_TRAN_DATE] => NA
          [SUBSCRIPTION_AMOUNT] => 16716
          [SUBSCRIPTION_MAXAMOUNT] => 25100.00
          [SUBSCRIPTION_FREQUENCY] => 1
          [SUBSCRIPTION_PERIOD] => annually
          [CUSTOM_VAR] => NA
          [TRANSACTIONTYPE] => enach
          [AMOUNT] => 1.00
          [SUBSCRIPTION_STATUS] => SUBSCRIBED
          [DOWNPAYMENNT_HISTORY] => Array
              (
                  [AIRPAY_ID] => 889601295
                  [TRANSACTION_TYPE] => enach
                  [TRANSACTION_DATE] => 21-04-2025
                  [TRANSACTION_AMOUNT] => 1.00
                  [TRANSACTION_STATUS] => SUCCESS
                  [TRANSACTION_RESPONSE] => SUCCESS
              )
       )
   ]

Unsubscribed Response

   HTTP/1.1 200 OK
[
   [status_code] => 200
   [error_code] => 00
   [status] => success
   [message] => Success
   [data] => Array
       (
          [SUBSCRIPTION_ID] => 10226708
          [SUBSCRIPTION_CYCLE] => 10
          [SUBSCRIPTION_DATE] => 06-04-2025
          [END_DATE] => 19-04-2034
          [NEXT_TRAN_DATE] => NA
          [LAST_TRAN_DATE] => 19-04-2025
          [SUBSCRIPTION_AMOUNT] => 14517
          [SUBSCRIPTION_MAXAMOUNT] => 14517.00
          [SUBSCRIPTION_FREQUENCY] => 1
          [SUBSCRIPTION_PERIOD] => annually
          [CUSTOM_VAR] => NA
          [TRANSACTIONTYPE] => enach
          [AMOUNT] => 1.00
          [SUBSCRIPTION_STATUS] => UNSUBSCRIBED
          [UNSUBSCRIBED_DATE] => 28-04-2025
          [DOWNPAYMENNT_HISTORY] => Array
              (
                  [AIRPAY_ID] => 860705450
                  [TRANSACTION_TYPE] => enach
                  [TRANSACTION_DATE] => 07-04-2025
                  [TRANSACTION_AMOUNT] => 1.00
                  [TRANSACTION_STATUS] => SUCCESS
                  [TRANSACTION_RESPONSE] => SUCCESS
              )
       )
   ]

Completed Response

   HTTP/1.1 200 OK
[
   [status_code] => 200
   [error_code] => 00
   [status] => success
   [message] => Success
   [data] => Array
       (
          [SUBSCRIPTION_ID] => 10025112
          [SUBSCRIPTION_CYCLE] => 2
          [SUBSCRIPTION_DATE] => 21-12-2021
          [END_DATE] => 21-06-2022
          [NEXT_TRAN_DATE] => NA
          [LAST_TRAN_DATE] => 13-06-2022
          [SUBSCRIPTION_AMOUNT] => 2954
          [SUBSCRIPTION_MAXAMOUNT] => 2954.00
          [SUBSCRIPTION_FREQUENCY] => 3
          [SUBSCRIPTION_PERIOD] => monthly
          [CUSTOM_VAR] => NA
          [TRANSACTIONTYPE] => enach
          [AMOUNT] => 1.00
          [SUBSCRIPTION_STATUS] => COMPLETED
          [UNSUBSCRIBED_DATE] => 21-06-2022
          [DOWNPAYMENNT_HISTORY] => Array
              (
              )
           [TRANSACTION_COUNT] => 2
           [TRANSACTION_HISTORY] => Array
              (
                  [0] => Array
                      (
                           [AIRPAY_ID] => 74199891
                           [TRANSACTION_TYPE] => enach
                           [TRANSACTION_DATE] => 13-06-2022
                           [TRANSACTION_AMOUNT] => 2954.00
                           [TRANSACTION_STATUS] => SUCCESS
                           [TRANSACTION_RESPONSE] => 0
                       )
                  [1] => Array
                      (
                           [AIRPAY_ID] => 69136610
                           [TRANSACTION_TYPE] => enach
                           [TRANSACTION_DATE] => 13-03-2022
                           [TRANSACTION_AMOUNT] => 2954.00
                           [TRANSACTION_STATUS] => SUCCESS
                           [TRANSACTION_RESPONSE] => 0
                      )
       )
   ]

Paused Response

   HTTP/1.1 200 OK
[
   [status_code] => 200
   [error_code] => 00
   [status] => success
   [message] => Success
   [data] => Array
       (
          [SUBSCRIPTION_ID] => 10107807
          [SUBSCRIPTION_CYCLE] => 99
          [SUBSCRIPTION_DATE] => 10-05-2023
          [END_DATE] => 10-06-2122
          [NEXT_TRAN_DATE] => 10-06-2024
          [LAST_TRAN_DATE] => NA
          [SUBSCRIPTION_AMOUNT] => 21240
          [SUBSCRIPTION_MAXAMOUNT] => 21240.00
          [SUBSCRIPTION_FREQUENCY] => 1
          [SUBSCRIPTION_PERIOD] => annually
          [CUSTOM_VAR] => NA
          [TRANSACTIONTYPE] => enach
          [AMOUNT] => 1.00
          [SUBSCRIPTION_STATUS] => PAUSED
          [PAUSE_DATE] => 26-09-2024
          [PAUSE_DATE] => 26-09-2024
          [DOWNPAYMENNT_HISTORY] => Array
              (
                  [AIRPAY_ID] => 198377474
                  [TRANSACTION_TYPE] => enach
                  [TRANSACTION_DATE] => 11-05-2023
                  [TRANSACTION_AMOUNT] => 1.00
                  [TRANSACTION_STATUS] => FAILED
                  [TRANSACTION_RESPONSE] => Invalid UMRN or Inactive Mandate
              )
       )
   ]

Error Response

[
       [status_code] => 400
       [error_code] => 878
       [status] => fail
       [message] => subscriptionid not valid
   ]