Developers

Suspending Contracts

Prerequistes

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.

• API Overview
• API Key and Merchant ID
• Subscription & Contract APIs

Overview

The suspendContracts API allows the caller to disable the contract template from being used. Suspended contracts can still be found using fetchContracts API, by passing the status as a parameter. In the case a subscription is attempted using this contract ID, payment will not be allowed.

Parameters

The suspendContract API takes the following parameters:

• merchant_id - The merchant ID that can be found within the merchant console. (Compulsory)
• apikey - The API Key associated with the merchant ID.
  This is used to authorise and identify the caller of the request. (Compulsory)
• contract_id - The contract ID that you wish to suspend. (Compulsory)
• ct_status - Must be set to "suspended". (Compulsory)

Example Request

Example suspendContract API call:

Responses

If the API call was successful, it will return a response in JSON format.

API response example:

{"response_code":200,"message":"OK","data":{"contract_id":"B249FD2EA2F18"}}

Test Code

Below is an example code that will work against a test section of the server. Although this is intended to simulate server behaviour, characteristics and responses are not always the same.

Please note that no transactions will be sent online and the server will not store any information from these requests. For more information on this, please see Testing Without An Account

<?php
/**
 * Function used to make POST requests to the server using SSL.
 * 
 * @param type $url The API URL that we want to send the request to.
 * @param type $data POST data that will be sent to the server.
 * @return false Returns the HTML response as a String. If an error has occured null will be returned. 
 */
function post_to_url($url, $data) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
    $html = curl_exec($ch);
    if (curl_errno($ch) !== 0) {
        curl_close($ch);
        return false;
    }
    curl_close($ch);
    return $html;
}

//The POST data that will be sent to the server.
$postData = array(
    'apikey' => 'ida8463534kawhdi347d39h078dt3383',
    'merchant_id' => '123E59334B8338',
    'contract_id' => 'B249FD2EA2F18',
    'ct_status' => 'suspended'
);

//Make the request to the server
$result = post_to_url("https://merchant.cybercompay.com/examples/suspendContract.php", $postData);

//If we have encountered an error display something back to the customer.
if ($result === false) {
    echo 'We have encountered an error!';
    exit;
}

//Print the results.
print_r(json_decode($result));