# Credit Card API V3

• Only CAD transaction supported.
  

• There are two modes for credit card integration:
  Simple Purchase
  Recurring Purchase

# Sign generate and check

Sign algorithm

# Request and response format

All request and response are in JSON format. The response body is also in JSON format. It should not be treated as fixed or as a schema, new fields may be added as the API evolves, and the order of fields might change. Your applications must therefore be resilient to the reordering of fields within a JSON object.

# Sending request demo code

$arr = array(
    'mchOrderNo' => 'm12345',   //order id assigned by merchant
    'mchId' => 'your merchant id',
  	'currency' => 'CAD',
    'amount' => 100,   // in cents
    'loginName' => 'jack', //your login name
    'notifyUrl' => 'http://yourdomain.com/notifyme.php',
    'returnUrl' => 'http://yourdomain.com/returnhere.php',
    'subject' => "ipad pro",
    'body' => '64G,wifi,white',
    'channel' => 'PF_CC'
);
$Utility = new Utility();
$sort_array = $Utility->arg_sort($arr);   //sort the parameters
$arr['sign'] = $Utility->build_mysign($sort_array, $merchantKey, "MD5");   //generate sign and put it into the array
$param = json_encode($arr);    //generate json string to send
$resBody = $Utility->request($url, $param);//Submit to the gateway

$res = json_decode($resBody, true);
if ($res['retCode'] == 'SUCCESS') {
    header('Location: ' . $res['redirectUrl']);//Redirect to payment page
} else {
    echo $res['retMsg'];
}

# Simple purchase

User input card info and purchase once, users will be prompted to input card info each time when they purchase.

# Sequence

1, Call cc_purchase and redirect to redirectUrl to let user input credit card info;
2, After purchase, will redirect to returnUrl;
3, If the transaction is successful, IOTPay will notify to notifyUrl;

# Request URL for simple purchase

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_purchase

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

# Response

# NotifyUrl message(post request in json format)

# ReturnUrl parameters

# Direct Purchase

# Request URL for cc_directaddcard

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_directpurchase

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

As an IOTPAY client or partner using this method of integration, your solution must demonstrate compliance to the Payment Card Industry Data Security Standard (PCI DSS).

# Parameters

# Response

# retData contains transaction infomation:

# Recurring purchase

User input card info once, can purchase with the tokenized card multiple times.

# Sequence

1, Call cc_addcard and then redirect to retData.redirectUrl to let user input credit card info;
2, After addcard, will redirect to returnUrl with the following parameters:
If success: retCode=SUCCESS
If fail: retCode=FAIL&retMsg=xxxx
3, (optional) Call cc_querycard to get card info;
4, If cc_addcard is successful, call cc_purchasewithtoken to do a real purchase

# Request URL for cc_addcard

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_addcard

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

each cardId can bind only one credit card, if one user need to bind more cards, use different cardId

# Response

# ReturnUrl parameters

# Request URL for cc_directaddcard

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_directaddcard

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

As an IOTPAY client or partner using this method of integration, your solution must demonstrate compliance to the Payment Card Industry Data Security Standard (PCI DSS) .

# Parameters

# Response

# retData contains card infomation:

# Request URL for cc_querycard

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_querycard

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

# Response

# retData contains card infomation:

# Request URL for purchasewithtoken

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_purchasewithtoken

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

# Response

# retData contains order infomation:

# Purchase with wallet

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_purchasewithwallet

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# This API is for Apple Pay and Google Pay, contact us before integrating this API.

# Parameters

walletData must be base64encoded. For ApplePay, you must send the Apple payment token as received by the passkit. For Google Pay, you must send the payment token (paymentData.paymentMethodData.tokenizationData.token) as received by Google Pay API.

# Response

# retData contains order infomation:

# Refund a transaction

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_refund

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

# Response

# Void a transaction

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_void

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

# Response

# Query order

Endpoint: https://ccapi.iotpaycloud.com/v3/cc_query

Reqeust method:

• POST
• Content-Type: application/json;charset=UTF-8

# Parameters

use either payOrderId or mchOrderNo, use one of them

# Response

# SDKs and document

For iOS integration: iOS sdk
For Android integration: Android sdk
PHP and JS integration: Php sdk

# Demo and source code

Simple purchase: demo Recurring purchase: demo source code download