Authentication

Direct Integration Method requests use an "Authorization" header to pass a base64 encoded string containing the API user credentials.

Authentication Format

The string is formatted as follows:

For example, the HTTP header for above credentials string is:

The spelling of the header name is critical for correct authentication.

Transactions

Processes a transaction using either a card or previously added token.

URL Endpoint

https://www.merchantsuite.com/api/v2/txns/

2 Party Payment

Use this method for direct communication between your server and MerchantSuite. Note that if your system is passing credit card details, it will be directly in scope for PCI compliance.

URL

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a TxnReq (transaction request details) JSON object with the following properties.

POST https://www.merchantsuite.com/api/v2/txns/ HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 411
Expect: 100-continue
Connection: Keep-Alive

{
  "TxnReq" : {
    "Action" : "payment",
    "Amount" : 19900,
    "AmountOriginal" : 19800,
    "AmountSurcharge" : 100,
    "CardDetails" : {
      "CardHolderName" : "John Smith",
      "CardNumber" : "5123456789012346",
      "CVN" : "123",
      "ExpiryDate" : "0521"
    },
    "Currency" : "AUD",
    "Customer" : {
      "Address" : {
        "AddressLine1" : "123 Fake Street",
        "AddressLine2" : "",
        "AddressLine3" : "",
        "City" : "Melbourne",
        "CountryCode" : "AUS",
        "PostCode" : "3000",
        "State" : "VIC"
      },
      "ContactDetails" : {
        "EmailAddress" : "john.smith@email.com",
        "FaxNumber" : "",
        "HomePhoneNumber" : "",
        "MobilePhoneNumber" : "",
        "WorkPhoneNumber" : ""
      },
      "CustomerNumber" : "1234",
      "PersonalDetails" : {
        "DateOfBirth" : "",
        "FirstName" : "John",
        "LastName" : "Smith",
        "MiddleName" : "",
        "Salutation" : "Mr"
      },
      "DaysOnFile" : 23,
      "ExistingCustomer" : true
    },
    "InternalNote" : "test merchant ref",
    "Order" : {
      "BillingAddress" : {
        "Address" : {
          "AddressLine1" : "",
          "AddressLine2" : "",
          "AddressLine3" : "",
          "City" : "",
          "CountryCode" : "",
          "PostCode" : "",
          "State" : ""
        },
        "ContactDetails" : {
          "EmailAddress" : "",
          "FaxNumber" : "",
          "HomePhoneNumber" : "",
          "MobilePhoneNumber" : "",
          "WorkPhoneNumber" : ""
        },
        "PersonalDetails" : {
          "DateOfBirth" : "",
          "FirstName" : "",
          "LastName" : "",
          "MiddleName" : "",
          "Salutation" : ""
        }
      },
      "OrderItems" : [{
        "Comments" : "",
        "Description" : "",
        "GiftMessage" : "",
        "PartNumber" : "",
        "ProductCode" : "",
        "Quantity" : 1,
        "SKU" : "",
        "ShippingMethod" : "",
        "ShippingNumber" : "",
        "UnitPrice" : 100
      }, {
        "Comments" : "",
        "Description" : "",
        "GiftMessage" : "",
        "PartNumber" : "",
        "ProductCode" : "",
        "Quantity" : 1,
        "SKU" : "",
        "ShippingMethod" : "",
        "ShippingNumber" : "",
        "UnitPrice" : 100
      }],
      "ShippingAddress" : {
        "Address" : {
          "AddressLine1" : "",
          "AddressLine2" : "",
          "AddressLine3" : "",
          "City" : "",
          "CountryCode" : "",
          "PostCode" : "",
          "State" : ""
        },
        "ContactDetails" : {
          "EmailAddress" : "",
          "FaxNumber" : "",
          "HomePhoneNumber" : "",
          "MobilePhoneNumber" : "",
          "WorkPhoneNumber" : ""
        },
        "PersonalDetails" : {
          "DateOfBirth" : "",
          "FirstName" : "",
          "LastName" : "",
          "MiddleName" : "",
          "Salutation" : ""
        }
      },
      "ShippingMethod" :  "",
      "OrderRecipients" : [{
          "PersonalDetails" : {
            "DateOfBirth" : "",
            "FirstName" : "",
            "LastName" : "",
            "MiddleName" : "",
            "Salutation" : ""
          },
          "ContactDetails" : {
            "EmailAddress" : "",
            "FaxNumber" : "",
            "HomePhoneNumber" : "",
            "MobilePhoneNumber" : "",
            "WorkPhoneNumber" : ""
          },
          "Address" : {
            "AddressLine1" : "",
            "AddressLine2" : "",
            "AddressLine3" : "",
            "City" : "",
            "CountryCode" : "",
            "PostCode" : "",
            "State" : ""
          }
        },
		{
          "PersonalDetails" : {
            "DateOfBirth" : "",
            "FirstName" : "",
            "LastName" : "",
            "MiddleName" : "",
            "Salutation" : ""
          },
          "ContactDetails" : {
            "EmailAddress" : "",
            "FaxNumber" : "",
            "HomePhoneNumber" : "",
            "MobilePhoneNumber" : "",
            "WorkPhoneNumber" : ""
          },
          "Address" : {
            "AddressLine1" : "",
            "AddressLine2" : "",
            "AddressLine3" : "",
            "City" : "",
            "CountryCode" : "",
            "PostCode" : "",
            "State" : ""
          }
        }]
    },
    "OriginalTxnNumber" : null,
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "EmailAddress" : "user@test.com",
    "PaymentReason" : null,
    "TestMode" : false,
    "TokenisationMode" : 0,
    "StoreCard" : false,
    "SubType" : "single",
    "Type" : "internet",
    "FraudScreeningRequest" : {
      "PerformFraudScreening" : "true",
      "DeviceFingerprint" : "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
      }
    }
}

include ("./API/MerchantSuite.php");

MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456",MerchantSuite\Mode::Live);

$txn = new MerchantSuite\Transaction();
$cardDetails = new MerchantSuite\CardDetails();
$order = new MerchantSuite\Order();
$shippingAddress = new MerchantSuite\OrderAddress();
$billingAddress = new MerchantSuite\OrderAddress();
$address = new MerchantSuite\Address();
$customer = new MerchantSuite\Customer();
$personalDetails = new MerchantSuite\PersonalDetails();
$contactDetails = new MerchantSuite\ContactDetails();
$order_item_1 = new MerchantSuite\OrderItem();
$order_recipient_1 = new MerchantSuite\OrderRecipient();
$fraudScreening = new MerchantSuite\FraudScreeningRequest();

$txn->setAction(MerchantSuite\Actions::Payment);
$txn->setCredentials($credentials);
$txn->setAmount(20000);
$txn->setCurrency("AUD");
$txn->setInternalNote("Internal Note");
$txn->setReference1("My Customer Reference");
$txn->setReference2("Medium");
$txn->setReference3("Large");
$txn->setStoreCard(FALSE);
$txn->setSubType("single");
$txn->setType(MerchantSuite\TransactionType::Internet);

$cardDetails->setCardHolderName("MR C CARDHOLDER");
$cardDetails->setCardNumber("4444333322221111");
$cardDetails->setCVN("678");
$cardDetails->setExpiryDate("0521");

$txn->setCardDetails($cardDetails);

$address->setAddressLine1("123 Fake Street");
$address->setCity("Melbourne");
$address->setCountryCode("AUS");
$address->setPostCode("3000");
$address->setState("Vic");

$contactDetails->setEmailAddress("example@email.com");

$personalDetails->setDateOfBirth("1900-01-01");
$personalDetails->setFirstName("John");
$personalDetails->setLastName("Smith");
$personalDetails->setSalutation("Mr");

$billingAddress->setAddress($address);
$billingAddress->setContactDetails($contactDetails);
$billingAddress->setPersonalDetails($personalDetails);

$shippingAddress->setAddress($address);
$shippingAddress->setContactDetails($contactDetails);
$shippingAddress->setPersonalDetails($personalDetails);

$order_item_1->setDescription("an item");
$order_item_1->setQuantity(1);
$order_item_1->setUnitPrice(1000);

$orderItems = array($order_item_1);

$order_recipient_1->setAddress($address);
$order_recipient_1->setContactDetails($contactDetails);
$order_recipient_1->setPersonalDetails($personalDetails);

$orderRecipients = array($order_recipient_1);

$order->setBillingAddress($billingAddress);
$order->setOrderItems($orderItems);
$order->setOrderRecipients($orderRecipients);
$order->setShippingAddress($shippingAddress);
$order->setShippingMethod("boat");

$txn->setOrder($order);

$customer->setCustomerNumber("1234");
$customer->setAddress($address);
$customer->setExistingCustomer(false);
$customer->setContactDetails($contactDetails);
$customer->setPersonalDetails($personalDetails);
$customer->setCustomerNumber("1");
$customer->setDaysOnFile(1);

$txn->setCustomer($customer);

$fraudScreening->setPerformFraudScreening(true);
$fraudScreening->setDeviceFingerprint("0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");

$txn->setFraudScreeningRequest($fraudScreening);

$txn->setTokenisationMode(3);
$txn->setTimeout(93121);

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, TransactionRequest, Customer,\
    PersonalDetails, ContactDetails, Address, Order, OrderAddress, OrderItem,\
    OrderRecipient, FraudScreeningRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TransactionRequest(credentials)

request.base_url = "https://www.merchantsuite.com/api/v2"

request.card_details = CardDetails(
    card_holder_name = "MR C CARDHOLDER",
    expiry_date = "0521",
    card_number = "4444333322221111",
    cvn = "123")

request.customer = Customer()

request.customer.address = Address()
request.customer.address.address_line1 = "123 Fake Street"
request.customer.address.city = "Melbourne"
request.customer.address.country_code = "AUS"
request.customer.address.post_code = "3000"
request.customer.address.state = "VIC"

request.customer.contact_details = ContactDetails()
request.customer.contact_details.email_address = "example@email.com"
request.customer.contact_details.home_phone_number = "93123456"
request.customer.contact_details.mobile_phone_number = "0412345678"
request.customer.contact_details.work_phone_number = "0412345678"

request.customer.personal_details = PersonalDetails()
request.customer.personal_details.date_of_birth = "1900-01-01"
request.customer.personal_details.first_name = "John"
request.customer.personal_details.last_name = "Smith"
request.customer.personal_details.middle_name = "C"
request.customer.personal_details.salutation = "Mr"

request.customer.customer_number = "1234"
request.customer.existing_customer = False
request.customer.days_on_file = 0

request.order = Order()
request.order.billing_address = OrderAddress()
request.order.billing_address.address = Address()
request.order.billing_address.address.address_line1 = "123 Fake Street"
request.order.billing_address.address.city = "Melbourne"
request.order.billing_address.address.country_code = "AUS"
request.order.billing_address.address.post_code = "3000"
request.order.billing_address.address.state = "VIC"

request.order.billing_address.contact_details = ContactDetails()
request.order.billing_address.contact_details.email_address = "example@email.com"
request.order.billing_address.contact_details.home_phone_number = "93123456"
request.order.billing_address.contact_details.mobile_phone_number = "0412345678"
request.order.billing_address.contact_details.work_phone_number = "0412345678"

request.order.billing_address.personal_details = PersonalDetails()
request.order.billing_address.personal_details.date_of_birth = "1900-01-01"
request.order.billing_address.personal_details.first_name = "John"
request.order.billing_address.personal_details.last_name = "Smith"
request.order.billing_address.personal_details.middle_name = "C"
request.order.billing_address.personal_details.salutation = "Mr"

request.order.shipping_address = OrderAddress()
request.order.shipping_address.address = Address()
request.order.shipping_address.address.address_line1 = "123 Fake Street"
request.order.shipping_address.address.city = "Melbourne"
request.order.shipping_address.address.country_code = "AUS"
request.order.shipping_address.address.post_code = "3000"
request.order.shipping_address.address.state = "VIC"

request.order.shipping_address.contact_details = ContactDetails()
request.order.shipping_address.contact_details.email_address = "example@email.com"
request.order.shipping_address.contact_details.home_phone_number = "93123456"
request.order.shipping_address.contact_details.mobile_phone_number = "0412345678"
request.order.shipping_address.contact_details.work_phone_number = "0412345678"

request.order.shipping_address.personal_details = PersonalDetails()
request.order.shipping_address.personal_details.date_of_birth = "1900-01-01"
request.order.shipping_address.personal_details.first_name = "John"
request.order.shipping_address.personal_details.last_name = "Smith"
request.order.shipping_address.personal_details.middle_name = "C"
request.order.shipping_address.personal_details.salutation = "Mr"
request.order.shipping_method = "boat"

order_receipient_1 = OrderRecipient()
order_receipient_1.address = Address()
order_receipient_1.address.address_line1 = "123 Fake Street"
order_receipient_1.address.city = "Melbourne"
order_receipient_1.address.country_code = "AUS"
order_receipient_1.address.post_code = "3000"
order_receipient_1.address.state = "VIC"
order_receipient_1.contact_details = ContactDetails()
order_receipient_1.contact_details.email_address = "example@email.com"
order_receipient_1.contact_details.home_phone_number = "93123456"
order_receipient_1.contact_details.mobile_phone_number = "0412345678"
order_receipient_1.contact_details.work_phone_number = "0412345678"
order_receipient_1.personal_details = PersonalDetails()
order_receipient_1.personal_details.date_of_birth = "1900-01-01"
order_receipient_1.personal_details.first_name = "John"
order_receipient_1.personal_details.last_name = "Smith"
order_receipient_1.personal_details.middle_name = "C"
order_receipient_1.personal_details.salutation = "Mr"
request.order.order_recipients = [order_receipient_1.get_payload()]

order_item_1 = OrderItem()
order_item_1.comments = "Order item comment"
order_item_1.description = "Test Order Item 1"
order_item_1.gift_message = "Test gift message"
order_item_1.quantity = 1
order_item_1.unit_price = 1000
request.order.order_items = [order_item_1.get_payload()]

request.fraud_screening_request = FraudScreeningRequest()
request.fraud_screening_request.perform_fraud_screening = True
request.fraud_screening_request.device_fingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="

request.store_card = True
request.action = "payment"
request.amount = 200
request.currency = "AUD"
request.reference1 = "Ref One"
request.sub_type = "recurring"
request.type = "internet"
request.tokenisation_mode = 3
request.timeout = 90000

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TransactionRequest.new()

cc = MerchantSuite::CardDetails.new()
cc.card_holder_name = "MR C CARDHOLDER"
cc.card_number = "4444333322221111"
cc.expiry_date = "0521"
cc.cvn = "123"

ad = MerchantSuite::Address.new()
ad.address_line_1 = "123 Fake Street"
ad.city = "Melbourne"
ad.country_code = "AUS"
ad.post_code = "3000"
ad.state = "VIC"

cd = MerchantSuite::ContactDetails.new()
cd.email_address = "example@email.com"

pd = MerchantSuite::PersonalDetails.new()
pd.date_of_birth = "1900-01-01"
pd.first_name = "John"
pd.last_name = "Smith"
pd.salutation = "Mr"

ba = MerchantSuite::OrderAddress.new()
ba.address = ad;
ba.contact_details = cd
ba.personal_details = pd

sa = MerchantSuite::OrderAddress.new()
sa.address = ad;
sa.contact_details = cd
sa.personal_details = pd

or_item_1 = MerchantSuite::OrderItem.new()
or_item_1.description = "an item"
or_item_1.quantity = 1
or_item_1.unit_price = 1000

order_items = [or_item_1.payload()]

order_recipient_1 = MerchantSuite::OrderRecipient.new()
order_recipient_1.address = ad;
order_recipient_1.contact_details = cd
order_recipient_1.personal_details = pd

order_recipients = [order_recipient_1.payload()]

order = MerchantSuite::Order.new()
order.billing_address = ba
order.shipping_address = sa
order.order_items = order_items
order.shipping_method = "Boat"
order.order_recipients = order_recipients

fs = MerchantSuite::FraudScreeningRequest.new()

fs.perform_fraud_screening = true
fs.device_fingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="

cust = MerchantSuite::Customer.new()
cust.customer_number = "1234"
cust.address = ad
cust.existing_customer = false
cust.contact_details = cd
cust.personal_details = pd
cust.customer_number = "1"
cust.days_on_file = 1

req.base_url = "https://www.merchantsuite.com/api/v2"
req.reference1  = "Test Ref 1"
req.currency = "AUD"
req.action = "payment"
req.amount = 1000
req.type = "internet"
req.subtype = "single"
req.store_card = true
req.card_details = cc
req.credentials = cred
req.order = order
req.fraud_screening_request = fs
req.customer = cust
req.tokenisation_mode = 3
req.timeout = 90000

response = req.submit()

import com.MerchantSuite.api.*;
import java.math.BigDecimal;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
CreditCardDetails cc = new CreditCardDetails();
Sender s = new Sender();

cc.setCardNumber("4444333322221111");
cc.setExpiryDate("0521");
cc.setCVN("123");
cc.setCardHolderName("MR C CARDHOLDER");

TxnRequest txn = new TxnRequest(credentials);
TxnResp resp;

txn.setBaseUrl("https://www.merchantsuite.com/api/v2");
txn.setAction("payment");
txn.setAmount((long) 1000);
txn.setReference1("Test Ref 1");
txn.setType("internet");
txn.setTestMode(false);
txn.setSubType("single");
txn.setCurrency("AUD");
txn.setStoreCard(false);
txn.setAmountOriginal((long) 0);
txn.setAmountSurcharge((long) 0);
txn.setCardDetails(cc);
txn.setCredentials(credentials);
txn.setTokenisationMode(TokenisationMode.TOKENISE);

Address ad = new Address();
ad.setAddressLine1("123 Fake Street");
ad.setCity("Melbourne");
ad.setCountryCode("AUS");
ad.setPostCode("3000");
ad.setState("VIC");

ContactDetails cd = new ContactDetails();
cd.setEmailAddress("example@email.com");

PersonalDetails pd = new PersonalDetails();
pd.setDateOfBirth("1900-01-01");
pd.setFirstName("John");
pd.setLastName("Smith");
pd.setSalutation("Mr");

OrderAddress ba = new OrderAddress();
ba.setAddress(ad);
ba.setContactDetails(cd);
ba.setPersonalDetails(pd);

OrderAddress sa = new OrderAddress();
sa.setAddress(ad);
sa.setContactDetails(cd);
sa.setPersonalDetails(pd);

OrderItem or_item_1 = new OrderItem();
or_item_1.setDescription("an item");
or_item_1.setQuantity(new BigDecimal(1));
or_item_1.setUnitPrice((long)1000);

ArrayOfOrderItem order_items = new ArrayOfOrderItem();
order_items.getOrderItem().add(or_item_1);

OrderRecipient order_recipient_1 = new OrderRecipient();
order_recipient_1.setAddress(ad);
order_recipient_1.setContactDetails(cd);
order_recipient_1.setPersonalDetails(pd);

ArrayOfOrderRecipient order_recipients = new ArrayOfOrderRecipient();
order_recipients.getOrderRecipient().add(order_recipient_1);

Order or = new Order();
or.setBillingAddress(ba);
or.setShippingAddress(sa);
or.setOrderItems(order_items);
or.setOrderRecipients(order_recipients);
or.setShippingMethod("Boat");

txn.setOrder(or);

Customer cust = new Customer();
cust.setCustomerNumber("1234");
cust.setAddress(ad);
cust.setExistingCustomer(false);
cust.setContactDetails(cd);
cust.setPersonalDetails(pd);
cust.setDaysOnFile(1);

txn.setCustomer(cust);

FraudScreeningRequest fs = new FraudScreeningRequest();
fs.setPerformFraudScreening(true);
fs.setDeviceFingerprint("0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");

txn.setFraudScreeningRequest(fs);

resp = s.submit(txn);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $cc = MerchantSuite::CardDetails->new(
card_number => "4444333322221111",
expiry_date => "0521",
cvn => "123",
card_holder_name => "MR C CARDHOLDER"
);

my $address = MerchantSuite::Address->new(
address_line_1 =>"123 Fake Stree",
address_line_2 => "",
address_line_3 => "",
city => "Melbourne",
country_code => "AUS",
post_code => "1234",
state => "VIC");

my $contact_details = MerchantSuite::ContactDetails->new(
email_address => 'example@email.com',
fax_number => "0123456789",
home_phone_number => "0123456789",
mobile_phone_number => "0123456789",
work_phone_number=> "0123456789");

my $personal_details = MerchantSuite::PersonalDetails->new(
date_of_birth => "1900-01-01",
first_name => "John",
last_name => "Smith",
middle_name => "",
salutation => "Mr");

my $customer = MerchantSuite::Customer->new(
address => $address,
contact_details => $contact_details,
customer_number => "1234",
personal_details => $personal_details,
days_on_file => 1);

my $shipping_address = MerchantSuite::OrderAddress->new(
address => $address,
contact_details => $contact_details,
personal_details => $personal_details);

my $billing_address = MerchantSuite::OrderAddress->new(address => $address,
contact_details => $contact_details,
personal_details =>$ personal_details);

my $item = MerchantSuite::OrderItem->new(
description => "An item of some description",
part_number  => "1",
quantity => "4",
shipping_number => "1234",
unit_price => 1099);

my @itemArray = ($item);

my $order = MerchantSuite::Order->new(
shipping_address => $shipping_address,
billing_address => $billing_address);

@{$order->{order_items}} = @itemArray;

my $fraud_screening = MerchantSuite::FraudScreeningRequest->new(
perform_fraud_screening => 1,
device_fingerprint => "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");

my $req;

$req = MerchantSuite::TransactionRequest->new(
action => "payment",
amount => 2000,
currency => "AUD",
credentials => $cred,
card_details => $cc,
order => $order,
customer => $customer,
reference1 => "Perl Test 1",
type => "internet",
sub_type => "single",
internal_note => "Perl Internal Note 1",
tokenisation_mode => 3,
fraud_screening_request => $fraud_screening
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var txnClient = ClientFactory.
GetClientInstance<TxnClient>(new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new ProcessTxnReq()
{
 TxnReq = new TxnRequest()
 {
	Action = "payment",
	Amount = 1000,
	AmountOriginal = 0,
	AmountSurcharge = 0,
	CardDetails = new CreditCardDetails()
	{
		CardNumber = "4444333322221111",
		ExpiryDate = "0521",
		CVN = "123",
		CardHolderName = "MR C CARDHOLDER"
	},
	Currency = "AUD",
	InternalNote = "test merchant ref",
	OriginalTxnNumber = null,
	Reference1 = "Reference 1",
	Reference2 = "Reference 2",
	Reference3 = "Reference 3",
	PaymentReason = null,
	StoreCard = false,
	SubType = "single",
	Type = "internet",
	TokenisationMode = 3,
	TestMode = false,
	EmailAddress = "customer@email.address"
 }
};

var response = txnClient.ProcessTxn(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var cc = new api.CardDetails({
CardNumber: "4444333322221111",
ExpiryDate : "0521",
CardHolderName : "MR C CARDHOLDER",
CVN : "123"});


var ad = new api.Address({
    AddressLine1 : "123 Fake Street",
    AddressLine2 : "",
    AddressLine3 : "",
    City : "Melbourne",
    CountryCode : "AUS",
    PostCode : "3000",
    State : "VIC"
});

var cd = new api.ContactDetails({
    EmailAddress : "john.smith@email.com"
});

var pd = new api.PersonalDetails({
    DateOfBirth : "",
    FirstName : "John",
    LastName : "Smith",
    MiddleName : "",
    Salutation : "Mr"
});

var cust = new api.Customer({
    Address: ad,
    ContactDetails: cd,
    CustomerNumber: "1234",
    PersonalDetails: pd
});

var ba = new api.OrderAddress({
    Address: ad,
    ContactDetails: cd,
    PersonalDetails: pd
});

var sa = new api.OrderAddress({
    Address: ad,
    ContactDetails: cd,
    PersonalDetails: pd
});

var order_item = new api.OrderItem({
    Description : "An Item",
    Quantity : 1,
    UnitPrice : 100
});

var order_items = [order_item];

var order_recipient = new api.OrderRecipient({
    Address: ad,
    ContactDetails: cd,
    PersonalDetails: pd
});

var order_recipients = [order_recipient];

var order = new api.Order({
    BillingAddress: ba,
    OrderItems: order_items,
    ShippingAddress: sa,
    ShippingMethod: "Boat",
    OrderRecipients: order_recipients
});
var fs = new api.FraudScreeningRequest({
    PerformFraudScreening: true,
    DeviceFingerprint: "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
});

var req = new api.TxnRequest({
Action : "payment",
Amount: 2100,
CardDetails : cc,
Reference1: "NodeJS Test Transaction 1",
Currency: "AUD",
Order: order,
Customer: cust,
FraudScreeningRequest: fs,
Type: "internet",
SubType: "single",
StoreCard : true});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Configure the ApiConfig.java file to input your API user and Merchant credentials
import main.java.com.merchantsuite.android.api.ApiManager;

String paymentAction = "payment";
float txnAmount = 25.50f;
String crn1 = "A CRN";
String crn2 = "A CRN";
String crn3 = "A CRN";
String paymentCurrency = "AUD";
String cardHolderName = "MR C Cardholder";
String cardNumber = "5123456789012346";
String expiryDate = "9900";

String response = ApiManager.processTransactionWithAction(paymentAction,
                    txnAmount, crn1, crn2, crn3,
                    paymentCurrency, cardHolderName, cardNumber,
                    expiryDate);

//Configure the MerchantSuiteApiConfig.h file to input your API user and Merchant credentials
#import <Foundation/Foundation.h>
#import <bPointSDK/bPointSDK.h>

NSString* paymentType = @"payment";
GCFLoat txnAmmount = 25.50f;
NSString* crn1 = @"A CRN";
NSString* crn2 = @"A CRN";
NSString* crn3 = @"A CRN";
NSString* cardNumber = @"5123456789012346";
NSString* expiryDate = @"9900";
NSString* cardHolderName = @"MR C Cardholder";
NSString* currency = @"AUD";

[[MerchantSuiteTransaction sharedMerchantSuiteTransaction] processTransactionWithAction:paymentType invoiceAmount:txnAmmount invoiceNumber:crn1 invoiceDueDate:crn2 invoiceOrderNumber:crn3 currency:currency cardHolderName:cardHolderName cardToken:cardNumber cardExpiryDate:expiryDate UsingDelegate:self];

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 884
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=wlliqq4uutv42xh0hfu134xy; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:15:15 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "TxnResp" : {
    "Action" : "payment",
    "Amount" : 19900,
    "AmountOriginal" : 19800,
    "AmountSurcharge" : 100,
    "Authentication3DSResponse" : null,
    "AuthoriseID" : "372626",
    "BankAccountDetails" : null,
    "BankResponseCode" : "00",
    "CVNResult" : {
      "CVNResultCode" : "Unsupported"
    },
    "CardDetails" : {
      "CardHolderName" : "John Smith",
      "ExpiryDate" : "0521",
      "MaskedCardNumber" : "512345...346"
    },
    "CardType" : "MC",
    "Currency" : "AUD",
    "InternalNote" : "test merchant ref",
    "Is3DS" : false,
    "IsCVNPresent" : true,
    "MembershipID" : "MS123456",
    "OriginalTxnNumber" : null,
    "ProcessedDateTime" : "2014-12-12T12:15:19.6370000",
    "RRN" : "434612372626",
    "ReceiptNumber" : "49316411177",
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "ResponseCode" : "0",
    "ResponseText" : "Approved",
    "PaymentReason" : null,
    "SettlementDate" : "20141212",
    "Source" : "api",
    "StoreCard" : false,
    "IsTestTxn" : false,
    "SubType" : "single",
    "TxnNumber" : "1177",
    "Token" : null,
    "Type" : "internet",
    "FraudScreeningResponse" : {
        "ReDResponse" : {
            "FRAUD_REC_ID" : "123412341234SAX20150101100000000",
            "FRAUD_RSP_CD" : "0100",
            "FRAUD_STAT_CD" : "ACCEPT",
            "ORD_ID" : "12341234",
            "REQ_ID" : "123412341234",
            "STAT_CD" : "PENDING"
        },
        "ResponseCode" : "",
        "ResponseMessage" : "",
        "TxnRejected" : false
    }
  }
}

2 Party Transaction Result

Retrieves details of a previously processed transaction.

URL

URL Parameters

txnNumber - transaction number of a previously processed transaction

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your GET request.

Authorization

base64 encoded API user credentials

Response Headers

Content-Type

application/json; charset=utf-8

GET https://www.merchantsuite.com/api/v2/txns/1178 HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Host: www.merchantsuite.com

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456",MerchantSuite\Mode::Live);

$txnRet = new MerchantSuite\TransactionRetrieval("1178");

$txnRet->setCredentials($credentials);


$response = $txnRet->submit();

from MerchantSuite.Requests import Credentials, TransactionResultRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TransactionResultRequest(credentials, "1178")
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TransactionResultRequest.new("1178")

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TxnFetchRequest txn = new TxnFetchRequest(credentials, "1178");
TxnResp resp;

txn.setBaseUrl("https://www.merchantsuite.com/api/v2");

resp = s.submit(txn);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TransactionFetchRequest->new(
txn_number => "1178",
credentials => $cred
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var txnClient = ClientFactory.
GetClientInstance<TxnClient>(new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var response = txnClient.RetrieveTxn("1178");

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.TxnFetch("0001");

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 882
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:20:55 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "TxnResp" : {
    "Action" : "payment",
    "Amount" : 19900,
    "AmountOriginal" : 19800,
    "AmountSurcharge" : 100,
    "Authentication3DSResponse" : null,
    "AuthoriseID" : "380662",
    "BankAccountDetails" : null,
    "BankResponseCode" : "00",
    "CVNResult" : {
      "CVNResultCode" : "Unsupported"
    },
    "CardDetails" : {
      "CardHolderName" : "John Smith",
      "ExpiryDate" : "0521",
      "MaskedCardNumber" : "512345...346"
    },
    "CardType" : "MC",
    "Currency" : null,
    "InternalNote" : "test merchant ref",
    "Is3DS" : false,
    "IsCVNPresent" : true,
    "MembershipID" : "MS123456",
    "OriginalTxnNumber" : null,
    "ProcessedDateTime" : "2014-12-12T12:21:00.8300000",
    "RRN" : "434612380662",
    "ReceiptNumber" : "49316511178",
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "ResponseCode" : "0",
    "ResponseText" : "Approved",
    "PaymentReason" : "",
    "SettlementDate" : "20141212",
    "Source" : "api",
    "StoreCard" : false,
    "IsTestTxn" : false,
    "SubType" : "single",
    "TxnNumber" : "1178",
    "Token" : null,
    "Type" : "internet"
  }
}

2 Party Search Transactions

Performs a search on previously processed transactions.

URL

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a SearchInput JSON object with following properties.

POST https://www.merchantsuite.com/api/v2/txns/search HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 449
Expect: 100-continue
Connection: Keep-Alive

{
  "SearchInput" : {
    "Action" : null,
    "Amount" : 0,
    "AuthoriseID" : null,
    "BankResponseCode" : null,
    "CardType" : null,
    "Currency" : null,
    "ExpiryDate" : null,
    "FromDate" : "2014-12-11T12:23:53.3897895+11:00",
    "InternalNote" : null,
    "MaskedCardNumber" : null,
    "RRN" : null,
    "ReceiptNumber" : null,
    "Reference1" : null,
    "Reference2" : null,
    "Reference3" : null,
    "ResponseCode" : null,
    "PaymentReason" : null,
    "SettlementDate" : null,
    "Source" : null,
    "ToDate" : "2014-12-12T12:23:53.3897895+11:00",
    "TxnNumber" : null
  }
}

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$txnSearch = new MerchantSuite\TransactionSearch();

$txnSearch->setCredentials($credentials);

$txnSearch->setReference1("Reference 1");

$txnSearch->setFromDate('2015-01-09 00:00:00');
$txnSearch->setToDate('2015-01-15 00:00:00');

$response = $txnSearch->submit();

from MerchantSuite.Requests import Credentials, TransactionSearchRequest

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TransactionSearchRequest(credentials)
request.base_url = "https://www.merchantsuite.com/api/v2"

request.action = "payment"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TransactionSearchRequest.new()

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred

req.masked_card_number = "444433...111"

response = req.submit()

import com.MerchantSuite.api.*;
import java.util.ArrayList;
import java.util.List;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TxnSearchRequest search = new TxnSearchRequest(credentials);
TransactionSearchResponse resp;

search.setBaseUrl("https://www.merchantsuite.com/api/v2");
search.setMaskedCardNumber("444433...111");

resp = s.submit(search);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TransactionSearchRequest->new(
masked_card_number => "444433...111",
currency => "AUD",
credentials => $cred,
settlement_date => "20150205",
amount => 1000
);


$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var txnClient = ClientFactory.
GetClientInstance<TxnClient>(new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new SearchTxnsReq()
{
	SearchInput = new SearchTxnsInput()
	{
		MaskedCardNumber = "444433...111"
	}
};

var response = txnClient.SearchTxns(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.TxnSearch({
Action : "payment",
Amount : 2157});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 1689
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=nguhp2vlyqra1iz0se3h1zmo; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:23:49 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "TxnRespList" : [{
    "Action" : "payment",
    "Amount" : 19900,
    "AmountOriginal" : 19900,
    "AmountSurcharge" : 0,
    "Authentication3DSResponse" : null,
    "AuthoriseID" : "372626",
    "BankAccountDetails" : null,
    "BankResponseCode" : "00",
    "CVNResult" : {
      "CVNResultCode" : "Unsupported"
    },
    "CardDetails" : {
      "CardHolderName" : null,
      "ExpiryDate" : "0521",
      "MaskedCardNumber" : "512345...346"
    },
    "CardType" : "MC",
    "Currency" : null,
    "InternalNote" : "test merchant ref",
    "Is3DS" : false,
    "IsCVNPresent" : true,
    "MembershipID" : "MS123456",
    "OriginalTxnNumber" : null,
    "ProcessedDateTime" : "2014-12-12T12:15:19.6370000",
    "RRN" : "434612372626",
    "ReceiptNumber" : "49316411177",
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "ResponseCode" : "0",
    "ResponseText" : "Approved",
    "PaymentReason" : null,
    "SettlementDate" : "20141212",
    "Source" : "api",
    "StoreCard" : false,
    "IsTestTxn" : false,
    "SubType" : "single",
    "TxnNumber" : "1177",
    "Token" : null,
    "Type" : "internet"
  },..., {
    "Action" : "payment",
    "Amount" : 19900,
    "AmountOriginal" : 19900,
    "AmountSurcharge" : 0,
    "Authentication3DSResponse" : null,
    "AuthoriseID" : "380662",
    "BankAccountDetails" : null,
    "BankResponseCode" : "00",
    "CVNResult" : {
      "CVNResultCode" : "Unsupported"
    },
    "CardDetails" : {
      "CardHolderName" : null,
      "ExpiryDate" : "0521",
      "MaskedCardNumber" : "512345...346"
    },
    "CardType" : "MC",
    "Currency" : null,
    "InternalNote" : "test merchant ref",
    "Is3DS" : false,
    "IsCVNPresent" : true,
    "MembershipID" : "MS123456",
    "OriginalTxnNumber" : null,
    "ProcessedDateTime" : "2014-12-12T12:21:00.8300000",
    "RRN" : "434612380662",
    "ReceiptNumber" : "49316511178",
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "ResponseCode" : "0",
    "ResponseText" : "Approved",
    "PaymentReason" : null,
    "SettlementDate" : "20141212",
    "Source" : "api",
    "StoreCard" : false,
    "IsTestTxn" : false,
    "SubType" : "single",
    "TxnNumber" : "1177",
    "Token" : null,
    "Type" : "internet"
  }]
}

AuthKey

Creates a one-time AuthKey to be used with "Process Transaction" operation when using Browser integration method.

URL

Request Headers

This is a browser integration method. You will be required to supply following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request includes the following parameters.

POST https://www.merchantsuite.com/api/v2/txns/processtxnauthkey HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 292
Expect: 100-continue
Connection: Keep-Alive

{
  "HppParameters" : {
    "TokeniseTxnCheckBoxDefaultValue" : true,
    "HidePaymentReason" : false,
    "HideReference1" : false,
    "HideReference2" : false,
    "HideReference3" : false,
    "ReturnBarLabel" : "Return Bar Label",
    "ReturnBarUrl" : "http://yourmerchantwebsite.com/ReturnBarUrl"
  },
  "ProcessTxnData" : {
    "Action" : "payment",
    "Amount" : 0,
    "Currency" : "AUD",
    "Customer" : {
      "Address" : {
        "AddressLine1" : "123 Fake Street",
        "AddressLine2" : "",
        "AddressLine3" : "",
        "City" : "Melbourne",
        "CountryCode" : "AUS",
        "PostCode" : "3000",
        "State" : "VIC"
      },
      "ContactDetails" : {
        "EmailAddress" : "john.smith@email.com",
        "FaxNumber" : "",
        "HomePhoneNumber" : "",
        "MobilePhoneNumber" : "",
        "WorkPhoneNumber" : ""
      },
      "CustomerNumber" : "1234",
      "PersonalDetails" : {
        "DateOfBirth" : "",
        "FirstName" : "John",
        "LastName" : "Smith",
        "MiddleName" : "",
        "Salutation" : "Mr"
      }
    },
    "InternalNote" : "test merchant ref",
    "Order" : {
      "BillingAddress" : {
        "Address" : {
          "AddressLine1" : "",
          "AddressLine2" : "",
          "AddressLine3" : "",
          "City" : "",
          "CountryCode" : "",
          "PostCode" : "",
          "State" : ""
        },
        "ContactDetails" : {
          "EmailAddress" : "",
          "FaxNumber" : "",
          "HomePhoneNumber" : "",
          "MobilePhoneNumber" : "",
          "WorkPhoneNumber" : ""
        },
        "PersonalDetails" : {
          "DateOfBirth" : "",
          "FirstName" : "",
          "LastName" : "",
          "MiddleName" : "",
          "Salutation" : ""
        }
      },
      "OrderItems" : [{
        "Comments" : "",
        "Description" : "",
        "GiftMessage" : "",
        "PartNumber" : "",
        "ProductCode" : "",
        "Quantity" : 1,
        "SKU" : "",
        "ShippingMethod" : "",
        "ShippingNumber" : "",
        "UnitPrice" : 100
      }, {
        "Comments" : "",
        "Description" : "",
        "GiftMessage" : "",
        "PartNumber" : "",
        "ProductCode" : "",
        "Quantity" : 1,
        "SKU" : "",
        "ShippingMethod" : "",
        "ShippingNumber" : "",
        "UnitPrice" : 100
      }],
      "ShippingAddress" : {
        "Address" : {
          "AddressLine1" : "",
          "AddressLine2" : "",
          "AddressLine3" : "",
          "City" : "",
          "CountryCode" : "",
          "PostCode" : "",
          "State" : ""
        },
        "ContactDetails" : {
          "EmailAddress" : "",
          "FaxNumber" : "",
          "HomePhoneNumber" : "",
          "MobilePhoneNumber" : "",
          "WorkPhoneNumber" : ""
        },
        "PersonalDetails" : {
          "DateOfBirth" : "",
          "FirstName" : "",
          "LastName" : "",
          "MiddleName" : "",
          "Salutation" : ""
        }
      },
      Bypass3DS : false
    },
    "Reference1" : "test Reference1",
    "Reference2" : "test Reference2",
    "Reference3" : "test Reference3",
    "PaymentReason" : null,
    "TokenisationMode" : 3,
    "TestMode" : false,
    "SubType" : "single",
    "Type" : "internet",
    "FraudScreeningRequest" : {
      "PerformFraudScreening" : "true",
      "DeviceFingerprint" : "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=",
      "CustomerIPAddress" : "10.1.1.1",
      "TxnSourceWebsiteURL" : "www.txn-source.com",
      "CustomFields" : [{"CustomField" : "A custom field"}]
    },
    "EmailAddress" : null,
    "AmexExpressCheckout" : false,
    "TokenData" : {
      "Token" : "5999999789012346",
      "ExpiryDate" : "0521",
      "UpdateTokenExpiryDate" : false
    }
  },
  "RedirectionUrl" : "http://yourmerchantwebsite.com/txnreceipt",
  "WebHookUrl" : null,
  "IframeParameters" : {
    "CSS" : ".control-label{color:blue;}",
    "ShowSubmitButton": true
  }
}

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");

$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$hppParameters = new MerchantSuite\HppTxnFlowParameters();
$hppParameters->setTokeniseTxnCheckBoxDefaultValue(false);
$hppParameters->setHidePaymentReason(false);
$hppParameters->setHideReference1(false);
$hppParameters->setHideReference2(false);
$hppParameters->setHideReference3(false);
$hppParameters->setReturnBarLabel("Return Bar Label");
$hppParameters->setReturnBarUrl("http://yourmerchantwebsite.com/ReturnBarUrl");

$iframeParameters = new MerchantSuite\IframeParameters();
$iframeParameters->setCSS(".control-label{color:blue;}");
$iframeParameters->setShowSubmitButton(true);

$tokenData = new MerchantSuite\TokenData();
$tokenData->setToken("5999999789012346");
$tokenData->setExpiryDate("0521");
$tokenData->setUpdateTokenExpiryDate(false);

$customField = new MerchantSuite\CustomField();
$customField->setCustomField("A custom field");

$customFieldArray = array();
$customFieldArray[] = $customField;

$fraudScreeningRequest = new MerchantSuite\FraudScreeningRequest();
$fraudScreeningRequest->setPerformFraudScreening(true);
$fraudScreeningRequest->setDeviceFingerprint("0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");
$fraudScreeningRequest->setCustomerIPAddress("10.1.1.1");
$fraudScreeningRequest->setTxnSourceWebsiteURL("www.txn-source.com");
$fraudScreeningRequest->setCustomFields($customFieldArray);

$txn = new MerchantSuite\AuthKeyTransaction();
$txn->setAction(MerchantSuite\Actions::Payment);
$txn->setCredentials($credentials);
$txn->setAmount(20000);
$txn->setCurrency("AUD");
$txn->setInternalNote("Authkey Request");
$txn->setReference1("Authkey Reference 1");
$txn->setReference2("Authkey Reference 2");
$txn->setReference3("Authkey Reference 3");
$txn->setRedirectionURL("http://yourmerchantwebsite.com/tokenreceipt");
$txn->setTokenisationMode(3);
$txn->setHppParameters($hppParameters);
$txn->setAmexExpressCheckout(false);
$txn->setIframeParameters($iframeParameters);
$txn->setTokenData($tokenData);
$txn->setFraudScreeningRequest($fraudScreeningRequest);
$txn->setBypass3DS(false);

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, TransactionAuthKeyRequest,\
HppTxnFlowParameters, IframeParameters, FraudScreeningRequest, CustomField
from MerchantSuite.Utils import TokenData

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

hpp_parameters = HppTxnFlowParameters()
hpp_parameters.tokenise_txn_check_box_default_value = True
hpp_parameters.hide_payment_reason = False
hpp_parameters.hide_reference1 = False
hpp_parameters.hide_reference2 = False
hpp_parameters.hide_reference3 = False
hpp_parameters.return_bar_label = "Return Bar Label"
hpp_parameters.return_bar_url = "http://yourmerchantwebsite.com/ReturnBarUrl"

token_data = TokenData()
token_data.token = "5999999789012346"
token_data.expiry_date = "0521"
token_data.update_token_expiry_date = False

iframe_parameters = IframeParameters()
iframe_parameters.css = ".control-label{color:blue;}"
iframe_parameters.show_submit_button = True

custom_field = CustomField()
custom_field.custom_field = "A custom field"

fraud_screening_request = FraudScreeningRequest()
fraud_screening_request.perform_fraud_screening = True
fraud_screening_request.device_fingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
fraud_screening_request.customer_ip_address = "10.1.1.1"
fraud_screening_request.txn_source_website_url = "www.txn-source.com"
fraud_screening_request.custom_fields = [custom_field]

request = TransactionAuthKeyRequest(credentials)
request.base_url = "https://www.merchantsuite.com/api/v2"
request.hpp_parameters = hpp_parameters
request.token_data = token_data
request.action = "payment"
request.amount = 200
request.currency = "AUD"
request.reference1 = "Ref One"
request.redirection_url = "http://yourmerchantwebsite.com/tokenreceipt"
request.tokenisation_mode = 3
request.amex_express_checkout = False
request.iframe_parameters = iframe_parameters
request.fraud_screening_request = fraud_screening_request
request.bypass_3_ds = False

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

hpp = MerchantSuite::HppTxnFlowParameters.new
hpp.tokenise_txn_check_box_default_value = true
hpp.hide_payment_reason = false
hpp.hide_reference1 = false
hpp.hide_reference2 = false
hpp.hide_reference3 = false
hpp.return_bar_label = "Return Bar Label"
hpp.return_bar_url = "http://yourmerchantwebsite.com/ReturnBarUrl"

token_data = MerchantSuite::TokenData.new
token_data.token = "5999999789012346"
token_data.expiry_date = "0521"
token_data.update_token_expiry_date = false

iframe_parameters = MerchantSuite::IframeParameters.new
iframe_parameters.css = ".control-label{color:blue;}"
iframe_parameters.show_submit_button = true

custom_field = MerchantSuite::CustomField.new
custom_field.custom_field = "A custom field"

fraud_screening_request = MerchantSuite::FraudScreeningRequest.new
fraud_screening_request.perform_fraud_screening = true
fraud_screening_request.device_fingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
fraud_screening_request.customer_ip_address = "10.1.1.1"
fraud_screening_request.txn_source_website_url = "www.txn-source.com"
fraud_screening_request.custom_fields = [custom_field]

req = MerchantSuite::TransactionAuthKeyRequest.new
req.base_url = "https://www.merchantsuite.com/api/v2"
req.action = "payment"
req.amount = 200
req.reference1 = "Authkey Test 1"
req.internal_note = "Reference for merhcant"
req.redirection_url = "http://yourmerchantwebsite.com"
req.currency = "AUD"
req.tokenisation_mode = 3
req.credentials = cred
req.hpp_parameters = hpp
req.amex_express_checkout = false
req.iframe_parameters = iframe_parameters
req.token_data = token_data
req.fraud_screening_request = fraud_screening_request
req.bypass_3_ds = false

response = req.submit()

import com.MerchantSuite.api.*;
import java.util.ArrayList;
import java.util.List;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

HppParameters hppParameters = new HppParameters();
hppParameters.setTokeniseTxnCheckBoxDefaultValue(true);
hppParameters.setHidePaymentReason(true);
hppParameters.setHideReference1(true);
hppParameters.setHideReference2(true);
hppParameters.setHideReference3(true);
hppParameters.setReturnBarLabel("Return Bar Label");
hppParameters.setReturnBarUrl("http://yourmerchantwebsite.com/ReturnBarUrl");

IframeParameters iframeParameters = new IframeParameters();
iframeParameters.setCSS(".control-label{color:blue;}");
iframeParameters.setShowSubmitButton(true);

TokenData tokenData = new TokenData();
tokenData.setToken("5999999789012346");
tokenData.setExpiryDate("0521");
tokenData.setUpdateTokenExpiryDate(false);

CustomField customField = new CustomField();
customField.setCustomField("A custom field");

List<CustomField> customFieldArray = new ArrayList<CustomField>();
customFieldArray.add(customField);

FraudScreeningRequest fraudScreeningRequest = new FraudScreeningRequest();
fraudScreeningRequest.setPerformFraudScreening(true);
fraudScreeningRequest.setDeviceFingerprint("0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");
fraudScreeningRequest.setCustomerIPAddress("10.1.1.1");
fraudScreeningRequest.setTxnSourceWebsiteURL("www.txn-source.com");
fraudScreeningRequest.setCustomFields(customFieldArray);

ProcessTxnData txn = new ProcessTxnData();
txn.setAmount((long) 100);
txn.setReference1("Java AuthKey Reference 1");
txn.setAction("payment");
txn.setCurrency("AUD");
txn.setTestMode(false);
txn.setTokenisationMode(TokenisationMode.TOKENISE);
txn.setAmexExpressCheckout(false);
txn.setTokenData(tokenData);
txn.setBypass3DS(false);
txn.setFraudScreeningRequest(fraudScreeningRequest);

TxnAuthKeyRequest req = new TxnAuthKeyRequest(credentials);
req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setProcessTxnData(txn);
req.setRedirectionUrl("http://www.mywebsite.com");
req.setWebHookUrl("http://www.mywebsite.com");
req.setHppParameters(hppParameters);
req.setIframeParameters(iframeParameters);

AuthKeyResponse resp;
resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
    username => 'APIUserName',
    password => 'Passw0rd',
    membership_id => "MS123456"
);

my $req;

my $hppParameters = MerchantSuite::HppTxnFlowParameters->new(
    tokenise_txn_check_box_default_value => 1,
    hide_payment_reason => 0,
    hide_reference1 => 0,
    hide_reference2 => 0,
    hide_reference3 => 0,
    return_bar_label => "Return Bar Label",
    return_bar_url => "http://yourmerchantwebsite.com/ReturnBarUrl"

);

my $tokenData = MerchantSuite::TokenData->new(
    token => "5999999789012346",
    expiry_date => "0521",
    update_token_expiry_date => 0
);

my $iframeParameters = MerchantSuite::IframeParameters->new(
    css => ".control-label{color:blue;}",
    show_submit_button => 1
);

my $customField = MerchantSuite::CustomField->new( custom_field => "A custom field");
my @customFieldArray = ($customField);

my $fraudScreeningRequest = MerchantSuite::FraudScreeningRequest->new(
    perform_fraud_screening => 1,
    device_fingerprint => "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=",
    customer_ip_address => "10.1.1.1",
    txn_source_website_url => "www.txn-source.com",
);
@{$fraudScreeningRequest->{custom_fields}} = @customFieldArray;

$req = MerchantSuite::TransactionAuthKeyRequest->new(
    action => "payment",
    redirection_url => "http://yourmerchantwebsite.com",
    reference1 => "This is a reference",
    amount => 12345,
    credentials => $cred,
    tokenisation_mode => 3,
    hpp_parameters => $hppParameters,
    amex_express_checkout => 0,
    iframe_parameters => $iframeParameters,
    token_data => $tokenData,
    fraud_screening_request => $fraudScreeningRequest,
    bypass_3_ds => 0
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var txnClient = ClientFactory.
GetClientInstance<TxnClient>(new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new CreateProcessTxnAuthKeyReq
{
    WebHookUrl = null,
    RedirectionUrl = "http://yourmerchantwebsite.com/txnreceipt",
    ProcessTxnData = new ProcessTxnData
        {
            TestMode = false,
            Action = "payment",
            PaymentReason = null,
            InternalNote = "test merchant ref",
            Reference1 = "test Reference1",
            Reference2 = "test Reference2",
            Reference3 = "test Reference3",
            Currency = "AUD",
            Amount = 0,
            AmountOriginal = 0,
            AmountSurcharge = 0,
            TokenisationMode = 0,
            AmexExpressCheckout = false,
            TokenData = new TokenDetails
                {
                    Token = "5999999789012346",
                    ExpiryDate = "0521",
                    UpdateTokenExpiryDate = false
                },
            Customer = new Customer
                {
                    ContactDetails = new ContactDetails
                        {
                            EmailAddress = "email@address.com"
                        }
                },
            FraudScreeningRequest = new FraudScreeningRequest
                {
                    PerformFraudScreening = true,
                    FraudScreeningDeviceFingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=",
                    CustomerIPAddress = "10.1.1.1",
                    SourceWebsiteURL = "www.txn-source.com",
                    CustomFields = new [] { new CustomField{CustomFieldMember = "A custom field"} }
                },
            Bypass3DS = false
        },
    HppParameters = new HppTxnFlowParameters
        {
            TokeniseTxnCheckBoxDefaultValue = true,
            HidePaymentReason = false,
            HideReference1 = false,
            HideReference2 = false,
            HideReference3 = false,
            ReturnBarLabel = "Return Bar Label",
            ReturnBarUrl = "http://yourmerchantwebsite.com/ReturnBarUrl"
        },
    IframeParameters = new IframeFlowParameters
        {
            CSS = ".control-label{color:blue;}",
            ShowSubmitButton = true
        }
};

var response = txnClient.CreateProcessTxnAuthKey(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var hppParameters = new api.HppTxnFlowParameters({
    TokeniseTxnCheckBoxDefaultValue : true,
    HidePaymentReason : false,
    HideReference1 : false,
    HideReference2 : false,
    HideReference3 : false,
    ReturnBarLabel : "Return Bar Label",
    ReturnBarUrl : "http://yourmerchantwebsite.com/ReturnBarUrl"
});

var tokenData = new api.TokenData({
    Token : "5999999789012346",
    ExpiryDate : "0521",
    UpdateTokenExpiryDate : false
});

var customField = new api.CustomField({CustomField :"A custom field"});

var fraudScreeningRequest = new api.FraudScreeningRequest({
    PerformFraudScreening : true,
    DeviceFingerprint : "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=",
    CustomerIPAddress : "10.1.1.1",
    TxnSourceWebsiteURL : "www.txn-source.com",
    CustomFields : [customField]
});

var iframeParameters = new api.IframeParameters({
    CSS : ".control-label{color:blue;}",
    ShowSubmitButton : true
});

var req = new api.TxnAuthKey({
    Action: "payment",
    Amount : 2100,
    Reference1: "NodeJS AuthKey Test 1",
    TestMode : false,
    Currency: "AUD",
    RedirectionUrl : "http://yourmerchantwebsite.com/",
    HppParameters : hppParameters,
    AmexExpressCheckout : false,
    IframeParameters : iframeParameters,
    TokenData : tokenData,
    FraudScreeningRequest : fraudScreeningRequest,
    Bypass3DS : false
});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
    Username : "APIUserName",
    Password: "Passw0rd",
    MembershipID : "MS123456"
});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Configure the ApiConfig.java file to input your API user and Merchant credentials
import main.java.com.merchantsuite.android.api.ApiManager;

String paymentAction = "payment";
float txnAmount = 25.50f;
String crn1 = "A CRN";
String crn2 = "A CRN";
String crn3 = "A CRN";
String paymentCurrency = "AUD"

String response = ApiManager.createAnAuthKeyToProcessTransactionWithAction(paymentAction,txnAmount, crn1, crn2, crn3, paymentCurrency);

//Configure the MerchantSuiteApiConfig.h file to input your API user and Merchant credentials
#import <Foundation/Foundation.h>
#import <bPointSDK/bPointSDK.h>

NSString* paymentType = @"payment";
GCFLoat txnAmmount = 25.50f;
NSString* crn1 = @"A CRN";
NSString* currency = @"AUD";

[[MerchantSuiteTransaction sharedMerchantSuiteTransaction] createUrlToProcessTransactionWithAction:paymentType invoiceAmount:txnAmmount invoiceNumber:crn1 currency:currency UsingDelegate:self];

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 108
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=5g35ug3awdd5pifyctnrveol; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:07 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "AuthKey" : "df998fea-f309-4e6e-9629-7149799dc028"
}

Webform

Processes a transaction.

Note: This request is made directly from the cardholder's browser. The browser will also automatically handle the response and redirect the cardholder to merchant's redirection URL and optionally perform a server-to-server callback (see section WebHooks). Should neither of these be received, a Search Transactions call (see 2 Party Search Transactions) should be made to determine the transaction outcome.

URL

Request Headers

This is a browser integration method. You will be required to supply following HTTP headers with your POST request.

Content-Type

application/x-www-form-urlencoded charset=utf-8

Response Headers

Location

merchant's redirection URL, API response appended to query string

Request

Request is a Form with following properties.

POST https://www.merchantsuite.com/api/v2/txns/webform/process HTTP/1.1
Content-Type: application/x-www-form-urlencoded charset=utf-8
Host: www.merchantsuite.com
Content-Length: 276
Expect: 100-continue

&PaymentReason=&InternalNote=test+merchant+ref&Reference1=test+reference1&Reference2=test+reference2&Reference3=test+reference3&Amount=199.00&CardNumber=5123456789012346&ExpiryDateMonth=05&ExpiryDateYear=17&CVN=123&CardHolderName=John+Smith&StoreCard=0&AuthKey=df998fea-f309-4e6e-9629-7149799dc028

Response Location

Merchant's redirection URL, API response appended to query string

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: http://yourmerchantwebsite.com/txnreceipt?ResponseCode=0&ResponseText=Success&ResultKey=13cfa799-8278-4872-a705-7ed49d516c0b
Set-Cookie: ASP.NET_SessionId=3cddgyr1zk3zl4oiwciqdvzd; path=/; secure; HttpOnly
p3p: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:09 GMT
Content-Length: 0

JavaScript - Simple

The API JavaScript makes it easy to process card payments without having sensitive data pass through your servers.

Including api.js

Add this script tag to your page (preferably at the bottom) to get started with the JavaScript API.

<script src="https://www.merchantsuite.com/api/merchantsuite/api.js?v=2" type="text/javascript"></script>

Setting up payment form

This is all you need to start processing payments with MerchantSuite. The MerchantSuite JavaScript library will process the payment and redirect the browser to the "RedirectionUrl" supplied when the AuthKey was created (Refer AuthKey). At the end of the redirection, invoke the "Retrieve Payment Result" call (Refer Transaction Result) from your web server to retrieve the payment result and render the payment receipt to your customers.

The three parameters in the sample code are compulsory. There are several optional parameters, which you can pass to the "SetupPayment" method to further customise the payment form as required. Please find below information about the parameters which you can pass to the "SetupPayment" method.

merchantsuite.SetupPayment({
  AppendToElementId: "pay-form-location",
  AuthKey: $("#AuthKey").val(),
  DefaultErrorUrl: "https://www.yourdomain.com/handleerror"
});

JavaScript - Advanced

"SetupPayment" as explained above is the simple approach to begin processing payments using the API. For more control over the user experience, please follow the custom payment method as described below.

Process payment

Invoke the process payment method as explained below when you are ready to process the payment e.g. a button click. "ProcessPayment" is an asynchronous call - it returns immediately and invokes the "CallbackFunction" when it receives a response from the server.

merchantsuite.ProcessPayment({
    AuthKey: $("#AuthKey").val(),
    PaymentReason: $("#PaymentReason").val(),
    Reference1: $("#Reference1").val(),
    Reference2: $("#Reference2").val(),
    Reference3: $("#Reference3").val(),
    InternalNote: $("#InternalNote").val(),
    EmailAddress: $("#EmailAddress").val(),
    Amount: $("#Amount").val(),
    AmountOriginal: $("#AmountOriginal").val(),
    AmountSurcharge: $("#AmountSurcharge").val(),
    Currency: $("#Currency").val(),
    CardNumber: $("#CardNumber").val(),
    CVN: $("#CVN").val(),
    ExpiryMonth: $("#ExpMonth").val(),
    ExpiryYear: $("#ExpYear").val(),
    CardHolderName: $("#CardHolderName").val(),
    StoreCard: $("#StoreCard").prop("checked"),
    CallbackFunction: ProcessPaymentCallBack
    Type: $("#Type").val()
});

The "CallbackFunction" is a JavaScript function you provide to handle the response from the API. It does the following:

1. If the payment information returned an error, display it on the page; or
2. If an error was not returned, then submit the result back to your server to call the "Retrieve Transaction Result" (Refer AuthKey) and render the receipt. If you are integrating for a shopping cart then this would be the time to check out the cart. Note: It is recommended that you do not submit the card details to your server, and only submit the result of the call back to your server.

function ProcessPaymentCallBack(result) {
 var errors = new Array();

 if (result.AjaxResponseType == 0) {
 //AJAX call was successful
  if (result.ApiResponseCode == 0) {
   //API returned success.
   //Refer to (API Response Codes) for API Response codes.
   //Submit result.ResultKey to your server for further
   //processing (Refer Transaction Result)
  }
  else if (result.ApiResponseCode == 300) {
   if (result.RedirectionUrl != null && result.RedirectionUrl.length > 0)
    window.location.href = result.RedirectionUrl;
   else
    errors = result.Errors;
  }
  else {
   errors = result.Errors;
  }
 }
 else if(result.AjaxResponseType == 1) {
  //Error with AJAX call
  errors = result.Errors;
 }
 else if(result.AjaxResponseType == 2) {
  //AJAX call timed out
  errors = result.Errors;
 }

 //Show errors on the page
 if (errors.length > 0) {
  var ul = $("<ul></ul>");

  $.each(errors, function (i, r) {
   ul.append("<li>" + r.Message + "</li>");
  });

  $(".validation-summary").append(ul).show();
 }
}

Result Object

The result object is described as below.

3 Party Redirect

Note: The payment page presented to the cardholder comes directly from MerchantSuite.

To process a transaction using this method, the cardholder's browser must be directed to the appropriate URL using either a hyperlink or HTTP 302 redirect. In both cases, two values are required to be included:

• merchantAlias, By default this is the same as your MerchantSuite Membership ID (for example, MS123456)
• authKey - Obtained via AuthKey call

Hyperlink example

Render a link on your page similar to the following - this will direct the cardholder to the Hosted Payment Page

<a href="https://www.merchantsuite.com/pay/{MerchantAlias}?in_pay_token={authKey}">Proceed to payment</a>

Redirect example

Send the following HTTP 302 Redirect to the cardholder's browser - this will direct the cardholder to the Hosted Payment Page

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: https://www.merchantsuite.com/pay/{MerchantAlias}?in_pay_token={authKey} 

Response

An API response will be appended to the query string of the redirection URL specified in the authkey request.

China UnionPay transactions will always have a response code of "P". You will need to poll MerchantSuite using the 2 Party Search Transaction method to obtain the result. China UnionPay only returns a response for approved transactions. If the transaction is not completed and approved within 2 hours then a response code of "x" - "description" will be returned.

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: http://yourmerchantwebsite.com/txnreceipt?ResponseCode=0&ResponseText=Success&ResultKey=13cfa799-8278-4872-a705-7ed49d516c0b
Set-Cookie: ASP.NET_SessionId=3cddgyr1zk3zl4oiwciqdvzd; path=/; secure; HttpOnly
p3p: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:09 GMT
Content-Length: 0

3 Party Iframe

There are two available methods.

• Submit button inside iframe (multi page / button mode)
• Submit button outside iframe (single page / button mode)

Submit button inside example

If IframeParameters.ShowSubmitButton is set to true in create AuthKey request (see AuthKey) then the iframe payment page will operate in the multi-page / button mode. In this mode the "Process Iframe Payment" method (See submit button outside example) does not need to be invoked. Instead, the ProcessTxnData.Amount and ProcessTxnData.Crn1 parameters need to be submitted in the create AuthKey call.

<iframe src="https://www.merchantsuite.com/api/v2/txns/iframe/{authKey}" frameborder="0"></iframe>

Clicking the "Submit" button inside iframe will process the payment and will redirect the iframe to the RedirectionUrl specified in the AuthKey request.

http://yourmerchantwebsite.com/txnreceipt?ResponseCode=0&ResponseText=Success&ResultKey=13cfa799-8278-4872-a705-7ed49d516c0b

Request

The Process Iframe Payment request is a TxnReq (transaction request details) JSON object with the following properties.

Submit button outside example

If IframeParameters.ShowSubmitButton is either not set (default) or set to false in create AuthKey call (see AuthKey) then the iframe payment page will operate in the single page / button mode. In this mode as the consumer enters their details into the card fields (card number, expiry date and cvn), it will get stored on the AuthKey session. The Process Iframe Payment (https://www.merchantsuite.com/api/v2/txns/processiframetxn/{authKey}) function will need to be invoked to process the payment, this can be either an ajax call or a server to server call.

Server to server example

POST https://www.merchantsuite.com/api/v2/txns/processiframetxn/{authKey} HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 292
Expect: 100-continue
Connection: Keep-Alive

{
  "TxnReq" : {
    "Amount" : "101.00",
    "AmountOriginal" : "100.00",
    "AmountSurcharge" : "1.00",
    "Currency" : "AUD",
    "InternalNote" : "test merchant reference",
    "Reference1" : "Transaction Reference 1",
    "Reference2" : "Transaction Reference 2",
    "Reference3" : "Transaction Reference 3",
    "PaymentReason" : "00Example00",
    "StoreCard" : false,
    "EmailAddress" : "user@test.com",
    "CardDetails" : {
        "CardHolderName" : "John Smith",
        "ExpiryDateMonth" : "07",
        "ExpiryDateYear" : "20"
    },
    "FraudScreeningDeviceFingerprint" : "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
  }
}

include ("./API/MerchantSuite.php");

MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");

$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$cardDetails = new MerchantSuite\AuthKeyCardDetails();
$cardDetails->setCardHolderName("John Smith");
$cardDetails->setExpiryDateMonth("07");
$cardDetails->setExpiryDateYear("20");

$txnWithAuth = new MerchantSuite\TransactionWithAuthKey();
$txnWithAuth->setAmount("101.00");
$txnWithAuth->setAmountOriginal("100.00");
$txnWithAuth->setAmountSurcharge("1.00");
$txnWithAuth->setCardDetails($cardDetails);
$txnWithAuth->setCurrency("AUD");
$txnWithAuth->setReference1("Transaction Reference 1");
$txnWithAuth->setReference2("Transaction Reference 2");
$txnWithAuth->setReference3("Transaction Reference 3");
$txnWithAuth->setEmailAddress("user@test.com");
$txnWithAuth->setStoreCard(false);
$txnWithAuth->setPaymentReason("00Example00");
$txnWithAuth->setInternalNote("test merchant reference");
$txnWithAuth->setFraudScreeningDeviceFingerprint("0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");

$processIframeTxn = new MerchantSuite\ProcessIframeTxn("df998fea-f309-4e6e-9629-7149799dc028");
$processIframeTxn->setCredentials($credentials);
$processIframeTxn->setProcessTransactionWithAuthKey($txnWithAuth);

$response = $processIframeTxn->submit();

from MerchantSuite.Requests import Credentials, TransactionWithAuthKeyRequest,\
ProcessIframeTxnRequest

from MerchantSuite.Utils import AuthKeyCardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

card_details = AuthKeyCardDetails()
card_details.card_holder_name = "a name"
card_details.expiry_date_month = "07"
card_details.expiry_date_year = "20"

txn_with_auth = TransactionWithAuthKeyRequest()
txn_with_auth.reference1 = "Transaction Reference 1"
txn_with_auth.reference2 = "Transaction Reference 2"
txn_with_auth.reference3 = "Transaction Reference 3"
txn_with_auth.amount = "101.00"
txn_with_auth.amount_original = "100.00"
txn_with_auth.amount_surcharge = "1.00"
txn_with_auth.currency = "AUD"
txn_with_auth.internal_note = "test merchant reference"
txn_with_auth.payment_reason = "00Example00"
txn_with_auth.store_card = False
txn_with_auth.card_details = card_details
txn_with_auth.email_address = "user@test.com"
txn_with_auth.fraud_screening_device_fingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="

request = ProcessIframeTxnRequest(credentials,"df998fea-f309-4e6e-9629-7149799dc028")
request.base_url = "https://www.merchantsuite.com/api/v2"
request.process_transaction_with_auth_key_request = txn_with_auth

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

card_details = MerchantSuite::AuthKeyCardDetails.new()
card_details.card_holder_name = "a name"
card_details.expiry_date_month = "07"
card_details.expiry_date_year = "20"

txn_with_auth = MerchantSuite::TransactionWithAuthKeyRequest.new()
txn_with_auth.amount = "101.00"
txn_with_auth.amount_original = "100.00"
txn_with_auth.amount_surcharge = "1.00"
txn_with_auth.card_details = card_details
txn_with_auth.currency = "AUD"
txn_with_auth.email_address = "user@test.com"
txn_with_auth.internal_note = "test merchant reference"
txn_with_auth.payment_reason = "00Example00"
txn_with_auth.store_card = false
txn_with_auth.fraud_screening_device_fingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="

req = MerchantSuite::ProcessIframeTxnRequest.new("df998fea-f309-4e6e-9629-7149799dc028")
req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred
req.proess_transaction_with_auth_key_request = txn_with_auth

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

CreditCardDetailsWith2PartExpiryDate cardDetails = new CreditCardDetailsWith2PartExpiryDate();
cardDetails.setCardHolderName("a name");
cardDetails.setExpiryDateMonth("07");
cardDetails.setExpiryDateYear("20");

TxnRequestWithAuthKey txnWithAuth = new TxnRequestWithAuthKey();
txnWithAuth.setAmount("101.00");
txnWithAuth.setAmountOriginal("100.00");
txnWithAuth.setAmountSurcharge("1.00");
txnWithAuth.setCurrency("AUD");
txnWithAuth.setReference1("Transaction Reference 1");
txnWithAuth.setReference2("Transaction Reference 2");
txnWithAuth.setReference3("Transaction Reference 3");
txnWithAuth.setCardDetails(cardDetails);
txnWithAuth.setPaymentReason("00Example00");
txnWithAuth.setInternalNote("test merchant reference");
txnWithAuth.setEmailAddress("user@test.com");
txnWithAuth.setStoreCard(false);
txnWithAuth.setFraudScreeningDeviceFingerprint("0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=");

ProcessTxnWithAuthKeyReq processTxnAuthReq = new ProcessTxnWithAuthKeyReq();
processTxnAuthReq.setTxnReq(txnWithAuth);

ProcessIframeTxnRequest req = new ProcessIframeTxnRequest(credentials,"df998fea-f309-4e6e-9629-7149799dc028");
req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setProcessTxnWithAuthKeyReq(processTxnAuthReq);

ProcessTxnWithAuthKeyResp resp;
resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
    username => 'APIUserName',
    password => 'Passw0rd',
    membership_id => "MS123456"
);

my $authCardDetails = MerchantSuite::AuthKeyCardDetails->new(
    card_holder_name => "A name",
    expiry_date_month => "07",
    expiry_date_year => "20"
);

my $authkeytxnreq = MerchantSuite::TransactionRequestWithAuthKey->new(
    auth_card_details => $authCardDetails,
    amount => "101.00",
    amount_original => "100.00",
    amount_surcharge => "1.00",
    currency => "AUD",
    reference1 => "Transaction Reference 1",
    reference2 => "Transaction Reference 2",
    reference3 => "Transaction Reference 3",
    internal_note => "test merchant reference",
    payment_reason => "00Example00",
    store_card => 0,
    email_address => "user@test.com",
    fraud_screening_device_fignerprint => "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
);

my $processtTxnWithAuthReq = MerchantSuite::ProcessTxnWithAuthKeyRequest->new(
    txn_request_with_auth_key => $authkeytxnreq
);

my $req = MerchantSuite::ProcessIframeTxnRequest->new(
    credentials => $cred
    process_txn_with_auth_key_request => $processtTxnWithAuthReq,
    auth_key => "df998fea-f309-4e6e-9629-7149799dc028"
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var txnClient = ClientFactory.
GetClientInstance<TxnClient>(new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new ProcessTxnWithAuthKeyReq
{
    TxnReq = new TxnRequestWithAuthKey
    {
        Amount = "101.00",
        AmountOriginal = "100.00",
        AmountSurcharge = "1.00",
        PaymentReason = "00Example00",
        CardDetails = new CreditCardDetailsWith2PartExpiryDate
        {
            CardHolderName = "A name",
            ExpiryDateMonth = "07",
            ExpiryDateYear = "20"
        },
        Reference1 = "Transaction Reference 1",
        Reference2 = "Transaction Reference 2",
        Reference3 = "Transaction Reference 3",
        Currency = "AUD",
        EmailAddress = "user@test.com",
        FraudScreeningDeviceFingerprint = "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk=",
        InternalNote = "test merchant reference",
        StoreCard = false
    }
};

var response = txnClient.ProcessIframeTxn("df998fea-f309-4e6e-9629-7149799dc028",apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var cardDetails = new api.AuthKeyCardDetails({
    CardHolderName : "A name",
    CardExpiryMonth : "07",
    CardExpiryYear : "20"
});

var txnWithAuth = new api.TxnRequestWithAuthKey({
    Amount : "101.00",
    AmountOriginal : "100.00",
    AmountSurcharge : "1.00",
    CardDetails : cardDetails,
    Currency : "AUD",
    EmailAddress : "user@test.com",
    InternalNote : "test merchant reference",
    Reference1 : "Transaction Reference 1",
    Reference2 : "Transaction Reference 2",
    Reference3 : "Transaction Reference 3",
    PaymentReason : "00Example00",
    StoreCard : false,
    FraudScreeningDeviceFingerprint : "0400l1oURA1kJHkN<1900 characters removed>+ZKFOkdULYCXsUu0Oxk="
});

var processTxnAuthReq = new api.ProcessTxnWithAuthKeyReq({
    TxnRequestWithAuthKey : txnWithAuth
});

var req = new api.ProcessIframeTxn("df998fea-f309-4e6e-9629-7149799dc028",{
    ProcessTxnWithAuthKeyReq : processTxnAuthReq
});

var creds = req.credentials({
    Username : "APIUserName",
    Password: "Passw0rd",
    MembershipID : "MS123456"
});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Ajax example

<div class="validation-summary"></div>
<div>
    <label>Reference1:</label>
    <input id="Reference1" name="Reference1" type="text"/>
</div>
<div>
    <label>Reference2:</label>
    <input id="Reference2" name="Reference2" type="text"/>
</div>
<div>
    <label>Reference3:</label>
    <input id="Reference3" name="Reference3" type="text"/>
</div>
<div>
    <label>EmailAddress:</label>
    <input id="EmailAddress" name="EmailAddress" type="text"/>
</div>
<div>
    <label>Amount:</label>
    <input id="Amount" name="Amount" type="text"/>
</div>
<div>
    <label>AmountOriginal:</label>
    <input id="AmountOriginal" name="AmountOriginal" type="text"/>
</div>
<div>
    <label>AmountSurcharge:</label>
    <input id="AmountSurcharge" name="AmountSurcharge" type="text"/>
</div>
<div>
    <label>CardHolderName:</label>
    <input id="CardHolderName" name="CardHolderName" type="text"/>
</div>

<div>
    <iframe src="https://www.merchantsuite.com/api/v2/txns/iframe/{authKey}" frameborder="0"></iframe>
</div>

<div>
<button id="btnProcess" type="button">Process</button>
</div>

<script type="text/javascript">
    $(document).ready(function () {
        $("#btnProcess").click(function () {
            $("input").attr("disabled", "disabled");
            setTimeout(ProcessPayment, 1000);
        });
    });

function ProcessPayment() {
    $(".validation-summary").empty().hide();
    var url = "https://www.merchantsuite.com/api/v2/txns/processiframetxn/{authKey}";
    var jsonModel = JSON.stringify(GetModelForProcessing());

    $.ajax({
        type: "POST",
        dataType: "json",
        contentType: "application/json",
        url: url,
        data: jsonModel,
        success: function (result) {
            $("input").removeAttr("disabled");

            if (result && result.APIResponse) {
                if (result.APIResponse.ResponseCode == 0) {
                    window.location.href = result.RedirectionUrl;
                }
                else
                    ShowError(result.APIResponse.ResponseText);
            }
            else {
                ShowError("Error processing your request. Response from API is either empty or invalid.");
            }
        },
        error: function (jqXhr, textStatus) {
            $("input").removeAttr("disabled");
            ShowError("AJAX Error processing your request. XHR Status: " + textStatus);
        }
    });
}

function ShowError(errorText) {
    var ul = $("<ul></ul>");

    ul.append("<li>" + errorText + "</li>");

    $(".validation-summary").append(ul).show();
}

function GetModelForProcessing() {
    var model = new Object();

    model.TxnReq = new Object();
    model.TxnReq.PaymentReason = "PaymentReason"
    model.TxnReq.InternalNote = "InternalNote"
    model.TxnReq.Reference1 = $("#Reference1").val();
    model.TxnReq.Reference2 = $("#Reference2").val();
    model.TxnReq.Reference3 = $("#Reference3").val();
    model.TxnReq.EmailAddress = $("#EmailAddress").val();
    model.TxnReq.Currency = "AUD"
    model.TxnReq.Amount = $("#Amount").val();
    model.TxnReq.AmountOriginal = $("#AmountOriginal").val();
    model.TxnReq.AmountSurcharge = $("#AmountSurcharge").val();
    model.TxnReq.CardDetails = new Object();
    model.TxnReq.CardDetails.CardHolderName = $("#CardHolderName").val();

    return model;
}
</script>

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 144
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=qmytl98r23956x2998tyuins; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:07 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "ResultKey" : "df998fea-f309-4e6e-9629-7149799dc028",
  "RedirectionUrl" : "http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=df998fea-f309-4e6e-9629-7149799dc028"
}

Transaction Result

Retrieves the result of a transaction processed via an operation using the Browser integration method. Should the resultKey not be available, the result of the transaction can be determined by issuing a Search Transactions (see section AuthKey) API call.

URL

URL Parameters

resultKey - result key returned in a response to process transaction operation

Request Headers

This is a browser integration method. You will be required to supply following HTTP headers with your GET request

Authorization

base64 encoded API user credentials

Response Headers

Content-Type

application/json; charset=utf-8

GET https://www.merchantsuite.com/api/v2/txns/withauthkey/13cfa799-8278-4872-a705-7ed49d516c0b HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Host: www.merchantsuite.com

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$txn = new MerchantSuite\ResultKeyRetrieval("13cfa799-8278-4872-a705-7ed49d516c0b");
$txn->setCredentials($credentials);

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, TransactionResultKeyRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TransactionResultKeyRequest(credentials, "13cfa799-8278-4872-a705-7ed49d516c0b")
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TransactionResultKeyRequest.new("13cfa799-8278-4872-a705-7ed49d516c0b")

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials =  cred

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TxnResultKeyRequest req = new TxnResultKeyRequest(credentials, "13cfa799-8278-4872-a705-7ed49d516c0b");
TxnResp resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setCredentials(credentials);

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TransactionResultKeyRequest->new(
credentials => $cred,
resultkey => "13cfa799-8278-4872-a705-7ed49d516c0b"
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var txnClient = ClientFactory.
GetClientInstance<TxnClient>(new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var response = txnClient.
RetrieveProcessTxnResult("13cfa799-8278-4872-a705-7ed49d516c0b");

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.TxnResultKey(
"13cfa799-8278-4872-a705-7ed49d516c0b");

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Configure the ApiConfig.java file to input your API user and Merchant credentials
import main.java.com.merchantsuite.android.api.ApiManager;

String authKey = "13cfa799-8278-4872-a705-7ed49d516c0b";

String response = retrieveTransactionResultWithTokenResult(authKey);

//Configure the MerchantSuiteApiConfig.h file to input your API user and Merchant credentials
#import <Foundation/Foundation.h>
#import <bPointSDK/bPointSDK.h>

NSString* authKey = @"13cfa799-8278-4872-a705-7ed49d516c0b";

[[MerchantSuiteTransaction sharedMerchantSuiteTransaction] retrieveTransactionResultWithTokenResult:authKey UsingDelegate:self];

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 882
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:09 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "TxnResp" : {
    "Action" : "payment",
    "Amount" : 19900,
    "AmountOriginal" : 19900,
    "AmountSurcharge" : 0,
    "Authentication3DSResponse" : null,
    "AuthoriseID" : "384582",
    "BankAccountDetails" : null,
    "BankResponseCode" : "00",
    "CVNResult" : {
    "CVNResultCode" : "Unsupported"
  },
  "CardDetails" : {
    "CardHolderName" : "John Smith",
    "ExpiryDate" : "0521",
    "MaskedCardNumber" : "512345...346"
  },
    "CardType" : "MC",
    "Currency" : "AUD",
    "InternalNote" : "test merchant ref",
    "Is3DS" : false,
    "IsCVNPresent" : true,
    "MembershipID" : "MS123456",
    "OriginalTxnNumber" : null,
    "ProcessedDateTime" : "2014-12-12T12:27:15.6830000",
    "RRN" : "434612384582",
    "ReceiptNumber" : "49316631179",
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "ResponseCode" : "0",
    "ResponseText" : "Approved",
    "PaymentReason" : "",
    "SettlementDate" : "20141212",
    "Source" : "api",
    "StoreCard" : false,
    "IsTestTxn" : false,
    "SubType" : "single",
    "TxnNumber" : "1179",
    "Token" : null,
    "Type" : "internet"
  }
}

Wallets

Your payment page can integrate with the digital wallet solutions from major providers.

Including wallets.js

Add this script tag to your page (preferably at the bottom) to get started with the wallet integration.

<script src="https://www.merchantsuite.com/api/merchantsuite/wallets.js?v=2&authkey={AuthKey}" type="text/javascript"></script>

Amex Express Checkout

After passing in the AmexExpressCheckout variable as true in the AuthKey request (see section AuthKey) the Amex Express Checkout button can be integrated and configured for your payment page.

Configuring the Amex Express Checkout button

Add this tag to your page (preferably at the bottom but before the wallets.js script tag) to configure the Amex Express Checkout appearance.

<wallets:init amex-express-checkout-container-id="amexExpressCheckout" amex-express-checkout-button-color="dark" amex-express-checkout-button-theme="desktop"></wallets:init>

Amex Express Checkout Button Init

The init tag defines how the button will display:

Placing Amex Express Checkout button

To place the Amex Express Checkout button, add a div tag to your page with the id that was passed into the amex-express-checkout-container-id parameter.

<div id="amexExpressCheckout"></div>

Tokens

Processes a transaction using either a card or previously added token.

URL Endpoint

https://www.merchantsuite.com/api/v2/token/

2 Party Token

2 Party Add Token

Securely stores payment details and creates a unique token.

URL

Request Headers

Use this method for direct communication between your server and MerchantSuite.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a TokenReq (Token request details) JSON object with following properties.

POST https://www.merchantsuite.com/api/v2/tokens/ HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 247
Expect: 100-continue
Connection: Keep-Alive

{
	"TokenReq" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "John Smith",
			"CardNumber" : "5123456789012346",
			"CVN" : null,
			"ExpiryDate" : "0521"
		},
		"AcceptBADirectDebitTC" : true,
		"EmailAddress" : "john.smith@email.com.au",
		"Reference1" : "12345",
		"Reference2" : "",
		"Reference3" : null
	}
}

include ("./API/MerchantSuite.php");

MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$txn = new MerchantSuite\AddToken();
$cardDetails = new MerchantSuite\CardDetails();

$txn->setCredentials($credentials);

$cardDetails->setCardNumber("XXXXXXXXXXXXXXXX");
$cardDetails->setCardHolderName("cardholdername");
$cardDetails->setExpiryDate("9901");

$txn->setCardDetails($cardDetails);

$txn->setEmailAddress("user@email.com");
$txn->setReference1("Token Reference 1");
$txn->setReference2("Token Reference 2");
$txn->setReference3("Token Reference 3");

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, AddTokenRequest
from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = AddTokenRequest(credentials)
request.base_url = "https://www.merchantsuite.com/api/v2"

request.card_details = CardDetails(
    card_holder_name = "MR C CARDHOLDER",
    expiry_date = "0521",
    card_number = "4444333322221111")
request.reference1 = "Ref One"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::AddTokenRequest.new()
req.credentials = cred

cc = MerchantSuite::CardDetails.new()
cc.card_holder_name = "Card Holder Name"
cc.expiry_date = "9901"
cc.card_number = "5123456789012346"

req.base_url = "https://www.merchantsuite.com/api/v2"
req.card_details = cc
req.reference1 = "reference 1"

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();
TokenAddRequest req = new TokenAddRequest(credentials);
CreditCardDetails cc = new CreditCardDetails();
TokenResp resp;

cc.setCardNumber("4444333322221111");
cc.setExpiryDate("0521");
cc.setCardHolderName("MR C CARDHOLDER");

req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setReference1("Java Token 1");
req.setCardDetails(cc);

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

my $cc = MerchantSuite::CardDetails->new(
card_number => "4444333322221111",
expiry_date => "0521",
card_holder_name => "MR C CARDHOLDER");

$req = MerchantSuite::TokenAddRequest->new(
credentials => $cred,
reference1 => "Perl Token 1",
card_details => $cc);


$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new AddTokenReq()
{
    TokenReq = new TokenRequest()
    {
        CardDetails = new  CreditCardDetails(){
            CardHolderName = "John Smith",
            CardNumber = "5123456789012346",
            ExpiryDate = "0521"
        },
        Reference1 = "12345",
        Reference2 = "",
        Reference3 = "",
        EmailAddress = "john.smith@email.com.au"
    }
};

var response = tokenClient.AddToken(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var cc = new api.CardDetails({
CardNumber: "4444333322221111",
ExpiryDate : "0521",
CardHolderName : "MR C CARDHOLDER"});

var req = new api.TokenRequest({
Reference1: "NodeJS Token 1",
EmailAddress: "notatoken@token.com",
CardDetails: cc});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 339
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=v35boh4ee43lw34cnhhnelst; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:35:07 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"TokenResp" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "John Smith",
			"ExpiryDate" : "0521",
			"MaskedCardNumber" : "512345...346"
		},
		"CardType" : "MC",
		"EmailAddress" : "john.smith@email.com.au",
		"Reference1" : "12345",
		"Reference2" : "",
		"Reference3" : null,
		"Token" : "5999999789012346"
	}
}

2 Party Update Token

Updates details for a given token.

URL

URL Parameters

token - token to be updated

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your PUT request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a TokenReq (Token request details) JSON object with following properties.

All fields other than CardNumber should be present in any update request. If a field other than CardNumber is omitted, the corresponding token details will be deleted.

PUT https://www.merchantsuite.com/api/v2/tokens/5999999789012346 HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 249
Expect: 100-continue

{
	"TokenReq" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "Joanne Smurf",
			"CardNumber" : "4005550000000001",
			"ExpiryDate" : "0521"
		},
		"EmailAddress" : "tommy.smith@email.com.au",
		"Reference1" : "12345",
		"Reference2" : "",
		"Reference3" : null
	}
}

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$txn = new MerchantSuite\UpdateToken("5999999789012346");
$cardDetails = new MerchantSuite\CardDetails();

$cardDetails->setExpiryDate("9901");

$txn->setCredentials($credentials);
$txn->setCardDetails($cardDetails);
$txn->setReference1("New Reference 1");
$txn->setEmailAddress("user@email.com");

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, UpdateTokenRequest
from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = UpdateTokenRequest(credentials,"5999999789012346")
request.base_url = "https://www.merchantsuite.com/api/v2"

request.card_details = CardDetails(
    card_holder_name = "MR C CARDHOLDER",
    expiry_date = "0521",
    card_number = "4444333322221111")
request.reference1 = "Ref One"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::UpdateTokenRequest.new("5999999789012346")
req.credentials = cred

cc = MerchantSuite::CardDetails.new()
cc.card_holder_name = "MR C CARDHOLDER"
cc.expiry_date = "0521"
cc.card_number = "4444333322221111"

req.base_url = "https://www.merchantsuite.com/api/v2"
req.card_details = cc
req.reference1 = "Token Reference"

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();
TokenUpdateRequest req = new TokenUpdateRequest(credentials, "5999999789012346");
CreditCardDetails cc = new CreditCardDetails();
TokenResp resp;

cc.setCardNumber("4444333322221111");
cc.setExpiryDate("0521");
cc.setCardHolderName("MR C CARDHOLDER");

req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setReference1("Java Update Token 1");
req.setCardDetails(cc);

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

my $cc = MerchantSuite::CardDetails->new(
card_number => "4444333322221111",
expiry_date => "0521",
card_holder_name => "MR C CARDHOLDER");

$req = MerchantSuite::TokenUpdateRequest->new(
credentials => $cred,
reference1 => "Perl Token 1",
card_details => $cc,
token => "5999999789012346"
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new UpdateTokenReq()
{
    TokenReq = new TokenRequest()
    {
        CardDetails = new  CreditCardDetails(){
            CardHolderName = "John Smith",
            CardNumber = "5123456789012346",
            ExpiryDate = "0521"
        },
        Reference1 = "12345",
        Reference2 = "",
        Reference3 = "",
        EmailAddress = "john.smith@email.com.au"
    }
};

var response = tokenClient.UpdateToken("5999999789012346",apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var cc = new api.CardDetails({
CardNumber: "4444333322221111",
ExpiryDate : "0521",
CardHolderName : "MR C CARDHOLDER"});

var req = new api.TokenUpdate({
Token: "5999999789012346",
CardDetails: cc, Reference1:
"NodeJS Token 1 - Updated"});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 339
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:43:34 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"TokenResp" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "Joanne Smurf",
			"ExpiryDate" : "0521",
			"MaskedCardNumber" : "400555...001"
		},
		"CardType" : "VC",
		"EmailAddress" : "tommy.smith@email.com.au",
		"Reference1" : "12345",
		"Reference2" : "",
		"Reference3" : "",
		"Token" : "5999999789012346"
	}
}

2 Party Tokenise Card

Creates a token using payment details from a previously processed transaction. The following conditions must be true to tokenise a previously processed transaction:

• The transaction was approved
• The transaction was submitted with StoreCard set to true (see sections 2 Party Payment and AuthKey)

URL

URL Parameters

txnNumber - transaction number of a previously processed transaction

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

POST https://www.merchantsuite.com/api/v2/tokens/txn/1180 HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 0

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$txn = new MerchantSuite\TokeniseTransaction("1180");
$txn->setCredentials($credentials);

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, TokeniseTransactionRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TokeniseTransactionRequest(credentials, "1180")
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TokeniseTransactionRequest.new("1180")

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokeniseTransactionRequest req = new TokeniseTransactionRequest(credentials, "1180");
TokenResp resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TokeniseTransactionRequest->new(
credentials => $cred,
txn_number => "1180");

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var response = tokenClient.TokeniseTxn("1180");

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.TokeniseTransaction("0001");

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 329
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=0d1btj43s3vpxx3dc2zbt422; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:48:31 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"TokenResp" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : null,
			"ExpiryDate" : "0521",
			"MaskedCardNumber" : "512345...346"
		},
		"CardType" : "MC",
		"EmailAddress" : null,
		"Reference1" : "test reference1",
		"Reference2" : "test reference2",
		"Reference3" : "test reference3",
		"Token" : "5999999789012346"
	}
}

2 Party Retrieve Token

Retrieves token details.

URL

URL Parameters

token - token record to retrieve

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your GET request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

GET https://www.merchantsuite.com/api/v2/tokens/5999999789012346 HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Host: www.merchantsuite.com

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$txn = new MerchantSuite\RetrieveToken("5999999789012346");

$txn->setCredentials($credentials);

$response = $txn->submit();

from MerchantSuite.Requests import Credentials, TokenRetrievalRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TokenRetrievalRequest(credentials, "5999999789012346")
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::RetrieveTokenRequest.new("5999999789012346")

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokenFetchRequest req = new TokenFetchRequest(credentials, "5999999789012346");
TokenResp resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TokenRetrievalRequest->new(
credentials => $cred,
token => "5999999789012346");

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var response = tokenClient.RetrieveToken("5999999789012346");

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.RetrieveToken("5999999789012346");

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 337
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:50:40 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"TokenResp" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "John Smith",
			"ExpiryDate" : "0521",
			"MaskedCardNumber" : "512345...346"
		},
		"CardType" : "MC",
		"EmailAddress" : "john.smith@email.com.au",
		"Reference1" : "12345",
		"Reference2" : "",
		"Reference3" : "",
		"Token" : "5999999789012346"
	}
}

2 Party Search Tokens

Performs a search on the merchant's tokens.

URL

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a SearchInput (Search details) JSON object with following properties.

All fields other than CardNumber should be present in any update request. If a field other than CardNumber is omitted, the corresponding token details will be deleted.

POST https://www.merchantsuite.com/api/v2/tokens/search HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 311
Expect: 100-continue

{
  "SearchInput" : {
    "CardType" : null,
    "ExpiredCardsOnly" : false,
    "ExpiryDate" : null,
    "FromDate" : "2014-12-11T12:52:24.8176630+11:00",
    "MaskedCardNumber" : null,
    "Reference1" : null,
    "Reference2" : null,
    "Reference3" : null,
    "Source" : null,
    "ToDate" : "2014-12-12T12:52:24.8176630+11:00",
    "Token" : null,
    "UserCreated" : null,
    "UserUpdated" : null
  }
}

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$search = new MerchantSuite\TokenSearch();

$search->setCredentials($credentials);
$search->setMaskedCardNumber("444433...111");

$response = $search->submit();

from MerchantSuite.Requests import Credentials, TokenSearchRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")
request = TokenSearchRequest(credentials)
request.masked_card_number = "444433...111";
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TokenSearchRequest.new()

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred
req.masked_card_number = "444433...111"

response = req.submit()

import com.MerchantSuite.api.*;
import java.util.ArrayList;
import java.util.List;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokenSearchRequest req = new TokenSearchRequest(credentials);
TokenSearchResponse resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setMaskedCardNumber("444433...111");

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TokenSearchRequest->new(
masked_card_number => "444433...111",
credentials => $cred);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new SearchTokensReq()
{
	SearchInput = new SearchTokensInput()
	{
		MaskedCardNumber = "444433...111"
	}
};

var response = tokenClient.SearchTokens(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.SearchTokens({
MaskedCardNumber : "444433...111" });

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 1963
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=ykvzrfcv53mexg0dbo5uluz0; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:52:18 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "TokenRespList" : [{
    "BankAccountDetails" : null,
    "CardDetails" : {
      "CardHolderName" : "John Smith",
      "ExpiryDate" : "0521",
      "MaskedCardNumber" : "512345...346"
    },
    "CardType" : "MC",
    "EmailAddress" : "jimmy@email.com.au",
    "Reference1" : "12345",
    "Reference2" : "",
    "Reference3" : "",
    "Token" : "5999999789012346"
  },..., {
    "BankAccountDetails" : null,
    "CardDetails" : {
      "CardHolderName" : "John Smith",
      "ExpiryDate" : "0521",
      "MaskedCardNumber" : "512345...346"
  },
    "CardType" : "MC",
    "EmailAddress" : "",
    "Reference1" : "12345",
    "Reference2" : "",
    "Reference3" : "",
    "Token" : "5999999789012346"
  }]
}

2 Party Delete Token

Deletes an existing token

URL

URL Parameters

token - token record to delete

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your DELETE request.

Authorization

base64 encoded API user credentials

Response Headers

Content-Type

application/json; charset=utf-8

DELETE https://www.merchantsuite.com/api/v2/tokens/5999999789012346 HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 0

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$delete = new MerchantSuite\DeleteToken();

$delete->setCredentials($credentials);
$delete->setToken("5999999789012346");

$response = $delete->submit();

from MerchantSuite.Requests import Credentials, DeleteTokenRequest

from MerchantSuite.Utils import CardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = DeleteTokenRequest(credentials, "5999999789012346")
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::DeleteTokenRequest.new("5999999789012346")

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokenDeleteRequest req = new TokenDeleteRequest(credentials, "5999999789012346");
Response resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TokenDeleteRequest->new(
token => "5999999789012346",
credentials => $cred);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var response = tokenClient.DeleteToken("5999999789012346");

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.DeleteToken("5999999789012346");

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 59
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:54:38 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	}
}

AuthKey Token

AuthKey Add Token

Creates a one-time AuthKey to be used with "Add Token" operation when using Browser integration method.

This operation serves following functions:

• Authenticates the merchant by username, merchant number and password. If these details are not correct, the AuthKey will not be generated.
• Creates a unique AuthKey to allow merchant's customer to save their payment details.
• AuthKey prevents processing of duplicate requests.
• Allows merchant to "lock in" certain details and means they cannot be modified even if submitted in subsequent "Add Token" request. These fields include:
  • Reference1
  • Reference2
  • Reference3
  • EmailAddress
• AuthKey is valid only for a predefined period of time (20 minutes). If the request is not attempted during that time merchant's application will need to request a new AuthKey.

URL

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a JSON object with following properties.

POST https://www.merchantsuite.com/api/v2/tokens/addtokenauthkey HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 91
Expect: 100-continue

{
  "FixedAddTokenData" : {
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "EmailAddress" : "john.smith@email.com.au"
  },
  "HppParameters" : {
    "HideReference1" : "false",
    "HideReference2" : "true",
    "HideReference3" : "true",
    "IsEddr" : "true",
    "ShowCustomerDetailsForm" : "true",
    "PaymentReason" : "00Example00",
    "Reference1Label" : "Reference1",
    "Reference2Label" : "",
    "Reference3Label" : ""
  },
  "IframeParameters" : {
    "CSS" : ".control-label{color:blue;}",
    "ShowSubmitButton": true
  },
  "RedirectionUrl" : "http://yourmerchantwebsite.com/tokenreceipt",
  "WebHookUrl" : null
}

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$hppParameters = new MerchantSuite\HppParameters();
$hppParameters->setPaymentReason("00Example00");
$hppParameters->setReferenceLabel1("Reference1");
$hppParameters->setHideReference1(false);
$hppParameters->setHideReference2(true);
$hppParameters->setHideReference3(true);
$hppParameters->setIsEddr(true);
$hppParameters->setShowCustomerDetailsForm(true);

$iframeParameters = new MerchantSuite\IframeParameters();
$iframeParameters->setCSS(".control-label{color:blue;}");
$iframeParameters->setShowSubmitButton(true);

$auth = new MerchantSuite\AddTokenAuthKey();
$auth->setCredentials($credentials);
$auth->setReference1("Ref One");
$auth->setRedirectionUrl("http://yourmerchantwebsite.com/tokenreceipt");
$auth->setEmailAddress("user@email.com");
$auth->setHPPParameters($hppParameters);
$auth->setIframeParameters($iframeParameters);

$response = $auth->submit();

from MerchantSuite.Requests import Credentials, AddTokenAuthKeyRequest, HppParameters, IframeParameters

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

hppParameters = HppParameters()
hppParameters.hide_reference1 = False
hppParameters.hide_reference2 = True
hppParameters.hide_reference3 = True
hppParameters.is_eddr = True
hppParameters.reference1_label = "Reference1"
hppParameters.payment_reason = "00Exmaple00"
hppParameters.show_customer_details_form = True

iframe_parameters = IframeParameters()
iframe_parameters.css = ".control-label{color:blue;}"
iframe_parameters.show_submit_button = True

request = AddTokenAuthKeyRequest(credentials)
request.base_url = "https://www.merchantsuite.com/api/v2"
request.reference1 = "Ref One"
request.redirection_url = "http://yourmerchantwebsite.com/tokenreceipt"
request.hpp_parameters = hppParameters
request.iframe_parameters = iframe_parameters

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

hpp = MerchantSuite::HppParameters.new
hpp.hide_reference1 = false
hpp.hide_reference2 = true
hpp.hide_reference3 = true
hpp.is_eddr = true
hpp.reference1_label = "Reference1"
hpp.payment_reason = "00Example00"
hpp.show_customer_details_form = true

iframe_parameters = MerchantSuite::IframeParameters.new
iframe_parameters.css = ".control-label{color:blue;}"
iframe_parameters.show_submit_button = true

req = MerchantSuite::AddTokenAuthKeyRequest.new()
req.base_url = "https://www.merchantsuite.com/api/v2"
req.reference1  = "Test Ref 1"
req.redirection_url ="http://yourmerchantwebsite.com/tokenreceipt"
req.credentials = cred
req.hpp_parameters = hpp
req.iframe_parameters = iframe_parameters

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokenAddAuthKeyRequest req = new TokenAddAuthKeyRequest(credentials);
AuthKeyResponse resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setReference1("Java Token AuthKey Add Ref 1");
req.setRedirectionUrl("http://yourmerchantwebsite.com/tokenreceipt");

IframeParameters iframeParameters = new IframeParameters();
iframeParameters.setCSS(".control-label{color:blue;}");
iframeParameters.setShowSubmitButton(true);

HppTokenFlowParameters hppParameters = new HppTokenFlowParameters();
hppParameters.setPaymentReason("00Example00");
hppParameters.setReference1Label("Reference1");
hppParameters.setHideReference1(false);
hppParameters.setIsEddr(true);
hppParameters.setShowCustomerDetailsForm(true);

req.setHppTokenFlowParameters(hppParameters);
req.setIframeParameters(iframeParameters);

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

my $hppParameters = MerchantSuite::HppParameters->new(
    hide_reference1 => 0, hide_reference2 => 1, hide_reference3 => 1,
    is_eddr => 1, reference1_label =>"Reference1", reference2_label =>"", reference3_label =>"", payment_reason =>"00Example00",
    show_customer_details_form => 1
);

my $iframeParameters = MerchantSuite::IframeParameters->new(
    css => ".control-label{color:blue;}",
    show_submit_button=> 1
);

$req = MerchantSuite::TokenAddAuthKeyRequest->new(
credentials => $cred,
reference1 => "Perl AuthKey Token Add 1",
redirection_url => "http://yourmerchantwebsite.com/tokenreceipt",
iframe_parameters => $iframeParameters,
hpp_parameters => $hppParameters
);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new CreateAddTokenAuthKeyReq()
{
    WebHookUrl = null,
    RedirectionUrl = "http://yourmerchantwebsite.com/tokenreceipt",
    FixedAddTokenData = new AddTokenData
        {
            Reference1 = "Ref One",
            Reference2 = "",
            Reference3 = "",
            EmailAddress = "user@email.com"
        },
    IframeParameters = new IframeFlowParameters
        {
            CSS = ".control-label{color:blue;}",
            ShowSubmitButton = true
        }
};

var response = tokenClient.CreateAddTokenAuthKey(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var hppParameters = new api.HppParameters({
    HideReference1 : false,
    HideReference2 : true,
    HideReference3 : true,
    IsEddr : true,
    ShowCustomerDetailsForm : true,
    PaymentReason : "00Example00",
    reference1Label : "Reference1",
    reference2Label : null,
    reference3Label : null
});

var iframeParameters = new api.IframeParameters({
    CSS : ".control-label{color:blue;}",
    ShowSubmitButton : true
});

req = new api.AddTokenAuthKey({
Reference1 : "NodeJS Add Token AuthKey 1",
HppParameters : hppParameters,
IframeParameters : iframeParameters,
RedirectionUrl: "http://yourmerchantwebsite.com"});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Configure the ApiConfig.java file to input your API user and Merchant credentials
import main.java.com.merchantsuite.android.api.ApiManager;

String crn1 = "A CRN";

String response = createAnAuthKeyToAddADataVaultTokenForUserWithEmail(crn1);

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 108
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=rser1ad1g3i5umowtys5lpzg; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:56:18 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"AuthKey" : "df998fea-f309-4e6e-9629-7149799dc028"
}

AuthKey Update Token

Creates a one-time AuthKey to be used with the "Update Token" operation when using the Browser integration method.

This operation serves following functions:

• Authenticates the merchant by username, merchant number and password. If these details are not correct, the AuthKey will not be generated.
• Creates a unique AuthKey to allow merchant's customer to update their payment details.
• AuthKey prevents processing of duplicate requests.
• Allows merchant to "lock in" certain details and prevent the details from being modified. These fields include:
  • Reference1
  • Reference2
  • Reference3
  • EmailAddress
• AuthKey is valid only for a predefined period of time (20 minutes). If the request is not attempted during that time merchant's application will need to request a new AuthKey.

URL

Request Headers

This is a direct integration method. You will be required to supply the following HTTP headers with your POST request.

Authorization

base64 encoded API user credentials

Content-Type

application/json; charset=utf-8

Response Headers

Content-Type

application/json; charset=utf-8

Request

Request is a JSON object with following properties.

POST https://www.merchantsuite.com/api/v2/tokens/updatetokenauthkey HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 270
Expect: 100-continue

{
  "FixedUpdateTokenData" : {
    "EmailAddress" : "john.smith@email.com.au",
    "Reference1" : "test reference1",
    "Reference2" : "test reference2",
    "Reference3" : "test reference3",
    "Token" : "5999999789012346"
  },
  "HppParameters" : {
    "HideReference1" : "false",
    "HideReference2" : "true",
    "HideReference3" : "true",
    "IsEddr" : "true",
    "ShowCustomerDetailsForm" : "true",
    "PaymentReason" : "00Example00",
    "Reference1Label" : "Reference1",
    "Reference2Label" : "",
    "Reference3Label" : ""
  },
  "IframeParameters" : {
    "CSS" : ".control-label{color:blue;}",
    "ShowSubmitButton": true
  },
  "RedirectionUrl" : "http://yourmerchantwebsite.com/tokenreceipt",
  "WebHookUrl" : null
}

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);
$hppParameters = new MerchantSuite\HppParameters();

$hppParameters->setPaymentReason("00Example00");
$hppParameters->setReferenceLabel1("Reference1");
$hppParameters->setHideReference1(false);
$hppParameters->setHideReference2(true);
$hppParameters->setHideReference3(true);
$hppParameters->setIsEddr(true);
$hppParameters->setShowCustomerDetailsForm(true);

$iframeParameters = new MerchantSuite\IframeParameters();
$iframeParameters->setCSS(".control-label{color:blue;}");
$iframeParameters->setShowSubmitButton(true);

$auth = new MerchantSuite\UpdateTokenAuthKey();
$auth->setCredentials($credentials);
$auth->setReference1("Ref One");
$auth->setRedirectionUrl("http://yourmerchantwebsite.com/tokenreceipt");
$auth->setEmailAddress("user@email.com");
$auth->setToken("XXXXXXXXXXXXXXXX");
$auth->setHppParameters($hppParameters);
$auth->setIframeParameters($iframeParameters);

$response = $auth->submit();

from MerchantSuite.Requests import Credentials, UpdateTokenAuthKeyRequest, HppParameters, IframeParameters

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

hppParameters = HppParameters()
hppParameters.hide_reference1 = False
hppParameters.hide_reference2 = True
hppParameters.hide_reference3 = True
hppParameters.is_eddr = True
hppParameters.reference1_label = "Reference1"
hppParameters.payment_reason = "00Exmaple00"
hppParameters.show_customer_details_form = True

iframe_parameters = IframeParameters()
iframe_parameters.css = ".control-label{color:blue;}"
iframe_parameters.show_submit_button = True

request = UpdateTokenAuthKeyRequest(credentials,"5999999789012346")
request.base_url = "https://www.merchantsuite.com/api/v2"
request.reference1 = "Ref One"
request.redirection_url = "http://yourmerchantwebsite.com/tokenreceipt"
request.hpp_parameters = hppParameters
request.iframe_parameters = iframe_parameters

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

hpp = MerchantSuite::HppParameters.new
hpp.hide_reference1 = false
hpp.hide_reference2 = true
hpp.hide_reference3 = true
hpp.is_eddr = true
hpp.reference1_label = "Reference1"
hpp.payment_reason = "00Example00"
hpp.show_customer_details_form = true

iframe_parameters = MerchantSuite::IframeParameters.new
iframe_parameters.css = ".control-label{color:blue;}"
iframe_parameters.show_submit_button = true

req = MerchantSuite::UpdateTokenAuthKeyRequest.new()
req.base_url = "https://www.merchantsuite.com/api/v2"
req.reference1  = "Test Ref 1"
req.redirection_url ="http://yourmerchantwebsite.com/tokenreceipt"
req.token = "5999999789012346"
req.credentials = cred
req.hpp_parameters = hpp
req.iframe_parameters = iframe_parameters

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokenUpdateAuthKeyRequest req = new TokenUpdateAuthKeyRequest(credentials);
AuthKeyResponse resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setReference1("Java Token AuthKey Update Ref 1");
req.setToken("XXXXXXXXXXXXXXXX");
req.setRedirectionUrl("http://yourmerchantwebsite.com/tokenreceipt");

IframeParameters iframeParameters = new IframeParameters();
iframeParameters.setCSS(".control-label{color:blue;}");
iframeParameters.setShowSubmitButton(true);

HppTokenFlowParameters hppParameters = new HppTokenFlowParameters();
hppParameters.setPaymentReason("00Example00");
hppParameters.setReference1Label("Reference1");
hppParameters.setHideReference1(false);
hppParameters.setIsEddr(true);
hppParameters.setShowCustomerDetailsForm(true);

req.setHppTokenFlowParameters(hppParameters);
req.setIframeParameters(iframeParameters);

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

my $hppParameters = MerchantSuite::HppParameters->new(
    hide_reference1 => 0, hide_reference2 => 1, hide_reference3 => 1,
    is_eddr => 1, reference1_label => "Reference1", reference2_label => "", reference3_label => "", payment_reason => "00Example00",
    show_customer_details_form => 1
);

my $iframeParameters = MerchantSuite::IframeParameters->new(
    css => ".control-label{color:blue;}",
    show_submit_button => 1
);

$req = MerchantSuite::TokenUpdateAuthKeyRequest->new(credentials => $cred,
reference1 => "Perl AuthKey Token Add 1",
redirection_url => "http://yourmerchantwebsite.com/tokenreceipt",
token => "XXXXXXXXXXXXXXXX",
iframe_parameters => $iframeParameters,
hpp_parameters => $hppParameters);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new CreateUpdateTokenAuthKeyReq()
{
    WebHookUrl = null,
    RedirectionUrl = "http://yourmerchantwebsite.com/tokenreceipt",
    FixedUpdateTokenData = new UpdateTokenData
        {
            Token = "5999999789012346",
            Reference1 = "Ref One",
            Reference2 = "",
            Reference3 = "",
            EmailAddress = "user@email.com"
        },
    IframeParameters = new IframeFlowParameters
        {
            CSS = ".control-label{color:blue;}",
            ShowSubmitButton = true
        }
};

var response = tokenClient.CreateUpdateTokenAuthKey(apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var hppParameters = new api.HppParameters({
    HideReference1 : false,
    HideReference2 : true,
    HideReference3 : true,
    IsEddr : true,
    ShowCustomerDetailsForm : true,
    PaymentReason : "00Example00",
    reference1Label : "Reference1",
    reference2Label : null,
    reference3Label : null
});

var iframeParameters = new api.IframeParameters({
    CSS : ".control-label{color:blue;}",
    ShowSubmitButton : true
});

var req = new api.UpdateTokenAuthKey({
Token: "5999999789012346",
Reference1 : "NodeJS Add Token AuthKey 1",
HppParameters : hppParameters,
IframeParameters : iframeParameters,
RedirectionUrl: "http://yourmerchantwebsite.com"});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Configure the ApiConfig.java file to input your API user and Merchant credentials
import main.java.com.merchantsuite.android.api.ApiManager;

String token = "5999999789012346";

String response = createAnAuthKeyToUpdateADataVaultToken(token);

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 108
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:57:55 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"AuthKey" : "df998fea-f309-4e6e-9629-7149799dc028"
}

Token Webform

Add Token Webform

Securely stores payment details and creates a unique token

This request is made directly from the cardholder's browser. The browser will also automatically handle the response and redirect the cardholder to the appropriate URL.

URL

Request Headers

This is a browser integration method. You will be required to supply following HTTP headers with your POST request.

Content-Type

application/x-www-form-urlencoded charset=utf-8

Response Headers

Request

Request is a Form with following properties.

POST https://www.merchantsuite.com/api/v2/tokens/webform/add HTTP/1.1
Content-Type: application/x-www-form-urlencoded charset=utf-8
Host: www.merchantsuite.com
Content-Length: 226
Expect: 100-continue

&Reference1=12345&Reference2=&Reference3=&EmailAddress=john.smith%40email.com.au&CardNumber=5123456789012346&ExpiryDateMonth=05&ExpiryDateYear=17&CVN=123&CardHolderName=John+Smith&AuthKey=9ab0d695-d16d-4bf0-8800-7c784e1bd203

Response Location

URL to redirect to with result appended to query string

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=415d2da7-0cf1-4c75-8c8b-754bba573647
Set-Cookie: ASP.NET_SessionId=g0mgvdi2hzjj1jhibr3vnj2j; path=/; secure; HttpOnly
p3p: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:56:18 GMT
Content-Length: 0

Update Token Webform

Updates payment details for existing an existing token

This request is made directly from the cardholder's browser. The browser will also automatically handle the response and redirect the cardholder to the appropriate URL.

URL

Request Headers

This is a browser integration method. You will be required to supply following HTTP headers with your POST request.

Content-Type

application/x-www-form-urlencoded charset=utf-8

Response Headers

Request

Request is a Form with following properties.

POST https://www.merchantsuite.com/api/v2/tokens/webform/update HTTP/1.1
Content-Type: application/x-www-form-urlencoded charset=utf-8
Host: www.merchantsuite.com
Content-Length: 236
Expect: 100-continue

&Reference1=test+reference1&Reference2=test+reference2&Reference3=test+reference3&EmailAddress=john%40john.com&CardNumber=5123456789012346&ExpiryDateMonth=05&ExpiryDateYear=17&CVN=123&CardHolderName=John+Smith&AuthKey=5a9e7240-cdfc-4659-9be2-18a01c713b71

Response Location

URL to redirect to with result appended to query string

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=03a038f5-ae28-44a4-a8d0-8c78279f5445
Set-Cookie: ASP.NET_SessionId=fuarrfzj2u0flw3kdgt1h2o1; path=/; secure; HttpOnly
p3p: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:57:56 GMT
Content-Length: 0

Token JavaScript - Simple

Add Token

The API JavaScript makes it easy to store card details without having the card data pass through your servers.

Including api.js

Add this script tag to your page (preferably at the bottom) to get started with the JavaScript API.

Setting up the add token form

This is all you need to start tokenising cards with MerchantSuite. The MerchantSuite JavaScript library will store the card details and redirect the browser to the "RedirectionUrl" supplied when the AuthKey was created (Refer Add Token AuthKey). At the end of the redirection, invoke the "Lookup Add/Update Token Result" call (Refer Lookup Token Result) from your web server to retrieve the token information and render the confirmation receipt to your customers

The three parameters in the sample code above are compulsory. There are several optional parameters, which you can pass to the "SetupAddToken" method to further customise the form as required. Please find below information about the parameters which you can pass to "SetupAddToken" method.

<script src="https://www.merchantsuite.com/api/merchantsuite/api.js?v=2" type="text/javascript"></script>

merchantsuite.SetupAddToken({
  AcceptBankAccountTerms: true ,
  AppendToElementId: "add-form-location",
  AuthKey: $("#AuthKey").val(),
  DefaultErrorUrl: "https://www.yourdomain.com/handleerror"
});

Method Parameters

if this parameter is populated via "Create AuthKey" (Refer AuthKey Add Token) operation then that value will take precedence over value submitted here.

Update Token

The API JavaScript makes it easy to update a token without having the information pass through your servers.

Including api.js

Add this script tag to your page (preferably at the bottom) to get started with the JavaScript API.

Setting up update token form

This is all you need to get started with updating a token. The JavaScript library will update the card details and will redirect the browser to the "RedirectionUrl" supplied when the AuthKey was created (Refer AuthKey Update Token). At the end of the redirection, invoke the "Lookup Add/Update Token Result" call (Refer Lookup Token Result) from your web server to retrieve the token information and render the confirmation receipt to your customers.

The three parameters in the sample code above are compulsory. There are several optional parameters, which you can pass to the "SetupUpdateToken" method to further customise the form as required. Please find below information about the parameters which you can pass to "SetupUpdateToken" method.

<script src="https://www.merchantsuite.com/api/merchantsuite/api.js?v=2" type="text/javascript"></script>

merchantsuite.SetupUpdateToken({
  AppendToElementId: "update-form-location",
  AuthKey: $("#AuthKey").val(),
  DefaultErrorUrl: "https://www.yourdomain.com/handleerror"
});

Method Parameters

if this parameter is populated via "Create AuthKey" (Refer AuthKey Update Token) operation then that value will take precedence over value submitted here.

Token JavaScript - Advanced

Add Token

"SetupAddToken" as explained above is the simple approach to start collecting card or bank account information using the API. For more control over the user experience, please follow the custom method as described below.

Process add token

Invoke the process add token method as explained below when you are ready to store the payment instrument e.g. a button click. "ProcessAddToken" is an asynchronous call - it returns immediately and invokes the "CallbackFunction" when it receives a response from the server.

merchantsuite.ProcessAddToken({
	AuthKey: $("#AuthKey").val(),
	Reference1: $("#Reference1").val(),
	Reference2: $("#Reference2").val(),
	Reference3: $("#Reference3").val(),
	EmailAddress: $("#EmailAddress").val(),
	Type: "CREDITCARD",
	CardHolderName: $("#CardHolderName").val(),
	CardNumber: $("#CardNumber").val(),
	ExpiryMonth: $("#CardExpiryMonth").val(),
	ExpiryYear: $("#CardExpiryYear").val(),
	CallbackFunction: ProcessAddTokenCallBack
});

Method Parameters

The "CallbackFunction" is a JavaScript function you provide to handle the response from the API. It does the following:

1. If the payment information entered by the user returned an error, display it on the page
2. If an error was not returned, then submit the result back to your server to call the "Lookup Add/Update Token Result" (Refer Lookup Token Result) and render the conformation receipt. Note: It is recommended that you do not submit the card details to your server, and only submit the result of the call back to your server.

Below is a sample implementation of "ProcessAddTokenCallBack":

function ProcessAddTokenCallBack(result) {
 var errors = new Array();

 if (result.AjaxResponseType == 0) {
 //AJAX call was successful

  if (result.ApiResponseCode == 0) {
  //API returned success.
  //Refer to (API Response Codes) for API Response codes.
  //Submit result.ResultKey to your server for further
  //processing(Refer Lookup Token Result)
  }
  else {
  errors = result.Errors;
  }
 }
 else if(result.AjaxResponseType == 1) {
 //Error with AJAX call
  errors = result.Errors;
 }
 else if(result.AjaxResponseType == 2) {
 //AJAX call timed out
  errors = result.Errors;
 }

 //Show errors on the page
 if (errors.length > 0) {
  var ul = $("<ul></ul>");

  $.each(errors, function (i, r) {
  ul.append("<li>" + r.Message + "</li>");
  });

  $(".validation-summary").append(ul).show();
 }
}

Result

The result object is described as below:

Update Token

"SetupUpdateToken" as explained above is the simple approach to start updating previously stored card or bank account information using the API. For more control over the user experience, please follow the custom method as described below.

Process update token

Invoke the process update token method as explained below when you are ready to update the token e.g. a button click. "ProcessUpdateToken" is an asynchronous call - it returns immediately and invokes the "CallbackFunction" when it received a response from the server.

merchantsuite.ProcessUpdateToken({
	AuthKey: $("#AuthKey").val(),
	Reference1: $("#Reference1").val(),
	Reference2: $("#Reference2").val(),
	Reference3: $("#Reference3").val(),
	EmailAddress: $("#EmailAddress").val(),
	Type: "CREDITCARD",
	CardHolderName: $("#CardHolderName").val(),
	CardNumber: $("#CardNumber").val(),
	ExpiryMonth: $("#CardExpiryMonth").val(),
	ExpiryYear: $("#CardExpiryYear").val(),
	CallbackFunction: ProcessUpdateTokenCallBack
});

Method Parameters

The "CallbackFunction" is a JavaScript function you provide to handle the response from the API. It does the following:

1. If the payment information entered by the user returned an error, display it on the page
2. If an error was not returned, then submit the result back to your server to call the "Lookup Add/Update Token Result" (Refer Lookup Token Result) and render the conformation receipt. Note: It is recommended that you do not submit the card details to your server, and only submit the result of the call back to your server.

Below is a sample implementation of "ProcessUpdateTokenCallBack":

function ProcessUpdateTokenCallBack(result) {
 var errors = new Array();

 if (result.AjaxResponseType == 0) {
 //AJAX call was successful

  if (result.ApiResponseCode == 0) {
  //API returned success.
  //Refer to Appendix (API Response Codes)  for API Response codes.
  //Submit result.ResultKey to your server for further
  //processing(Refer Lookup Token Result)
  }
  else {
  errors = result.Errors;
  }
 }
 else if(result.AjaxResponseType == 1) {
 //Error with AJAX call
  errors = result.Errors;
 }
 else if(result.AjaxResponseType == 2) {
 //AJAX call timed out
  errors = result.Errors;
 }

 //Show errors on the page
 if (errors.length > 0) {
  var ul = $("<ul></ul>");

  $.each(errors, function (i, r) {
  ul.append("<li>" + r.Message + "</li>");
  });

  $(".validation-summary").append(ul).show();
 }
}

Result

The result object is described as below:

3 Party Redirect

Add Token Redirect

Note: The token add page presented to the cardholder comes directly from MerchantSuite.

To add a token using this method, the cardholder's browser must be directed to the appropriate URL using either a hyperlink or HTTP 302 redirect. In both cases, two values are required to be included:

• merchantAlias, By default this is the same as your MerchantSuite Membership ID (for example, MS123456)
• authKey - Obtained via AuthKey Add call

Hyperlink example

Render a link on your page similar to the following - this will direct the cardholder to the Hosted Payment Page

<a href="https://www.merchantsuite.com/pay/{MerchantAlias}.adddv?in_sessionid={authKey}">Add your payment details</a>

Redirect example

Send the following HTTP 302 Redirect to the cardholder's browser - this will direct the cardholder to the Hosted Payment Page

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: https://www.merchantsuite.com/pay/{MerchantAlias}.adddv?in_sessionid={authKey} 

Response

An API response will be appended to the query string of the redirection URL specified in the authkey request.

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=415d2da7-0cf1-4c75-8c8b-754bba573647
Set-Cookie: ASP.NET_SessionId=g0mgvdi2hzjj1jhibr3vnj2j; path=/; secure; HttpOnly
p3p: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:56:18 GMT
Content-Length: 0

Update Token Redirect

Note: The token update page presented to the cardholder comes directly from MerchantSuite.

To update a token using this method, the cardholder's browser must be directed to the appropriate URL using either a hyperlink or HTTP 302 redirect. In both cases, two values are required to be included:

• merchantAlias, By default this is the same as your MerchantSuite Membership ID (for example, MS123456)
• authKey - Obtained via AuthKey Update call

Hyperlink example

Render a link on your page similar to the following - this will direct the cardholder to the Hosted Payment Page

<a href="https://www.merchantsuite.com/pay/{MerchantAlias}.updatedv?in_sessionid={authKey}">Update your Payment details</a>

Redirect example

Send the following HTTP 302 Redirect to the cardholder's browser - this will direct the cardholder to the Hosted Payment Page

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: https://www.merchantsuite.com/pay/{MerchantAlias}.updatedv?in_sessionid={authKey} 

Response

An API response will be appended to the query string of the redirection URL specified in the authkey request.

HTTP/1.1 302 Found
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Location: http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=415d2da7-0cf1-4c75-8c8b-754bba573647
Set-Cookie: ASP.NET_SessionId=g0mgvdi2hzjj1jhibr3vnj2j; path=/; secure; HttpOnly
p3p: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:56:18 GMT
Content-Length: 0

3 Party Iframe

3 Party Token Add Iframe

There are two available methods.

• Submit button inside iframe (multi page / button mode)
• Submit button outside iframe (single page / button mode)

Submit button inside example

If IframeParameters.ShowSubmitButton is set to true in a create AuthKey request (see AuthKey) then the iframe add Token page will operate in the multi-page / button mode. In this mode the "Process Add Token Iframe" method (See submit button outside example) does not need to be invoked. Instead, the TokenReq.Crn1 parameter needs to be submitted in the create AuthKey call.

<iframe src="https://www.merchantsuite.com/api/v2/tokens/iframe/add/{authKey}" frameborder="0"></iframe>

Clicking the "Submit" button inside iframe will process the add Token request and will redirect the iframe to the RedirectionUrl specified in the AuthKey request.

http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=13cfa799-8278-4872-a705-7ed49d516c0b

Request

Request is a TokenReq (Token request details) JSON object with following properties.

Submit button outside example

If IframeParameters.ShowSubmitButton is either not set (default) or set to false in create AuthKey call (see AuthKey) then the iframe add Token page will operate in the single page / button mode. In this mode as the consumer enters their details into the card fields (card holder name, card number, expiry date), it will get stored on the AuthKey session. The Process Add Token Iframe (https://www.merchantsuite.com/api/v2/tokens/iframe/add/{authKey}) function will need to be invoked to process the add request, this can be either an ajax call or a server to server call.

Server to server example

POST https://www.merchantsuite.com/api/v2/tokens/iframe/add/{authKey} HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 247
Expect: 100-continue
Connection: Keep-Alive

{
	"TokenReq" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "John Smith"
		},
		"AcceptBADirectDebitTC" : true,
		"EmailAddress" : "john.smith@email.com.au",
		"Reference1" : "12345",
		"Reference2" : "",
		"Reference3" : null
	}
}

include ("./API/MerchantSuite.php");

MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$cardDetails = new MerchantSuite\AuthKeyCardDetails();
$cardDetails->setCardHolderName("cardholdername");

$addToken = new MerchantSuite\AddTokenViaIframe("{AuthKey}");
$addToken->setCredentials($credentials);
$addToken->setCardDetails($cardDetails);
$addToken->setEmailAddress("user@email.com");
$addToken->setReference1("Token Reference 1");
$addToken->setReference2("Token Reference 2");
$addToken->setReference3("Token Reference 3");

$response = $addToken->submit();

from MerchantSuite.Requests import Credentials, AddTokenViaIframe
from MerchantSuite.Utils import AuthKeyCardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = AddTokenViaIframe(credentials,"{AuthKey}")
request.base_url = "https://www.merchantsuite.com/api/v2"

request.card_details = AuthKeyCardDetails(card_holder_name = "MR C CARDHOLDER")

request.reference1 = "Ref One"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::AddTokenViaIframe.new("{AuthKey}")
req.credentials = cred

cc = MerchantSuite::AuthKeyCardDetails.new()
cc.card_holder_name = "Card Holder Name"

req.base_url = "https://www.merchantsuite.com/api/v2"
req.card_details = cc
req.reference1 = "reference 1"

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

CreditCardDetailsWith2PartExpiryDate cc = new CreditCardDetailsWith2PartExpiryDate();
cc.setCardHolderName("MR C CARDHOLDER");

AddTokenViaIframe req = new AddTokenViaIframe(credentials);
req.setAuthKey("{authKey}");
req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setReference1("Java Token 1");
req.setCardDetails(cc);

ResultKeyResponse resp;
resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

my $cc = MerchantSuite::AuthKeyCardDetails->new(card_holder_name => "MR C CARDHOLDER");

$req = MerchantSuite::AddTokenViaIframe->new(
credentials => $cred,
reference1 => "Perl Token 1",
card_details => $cc,
auth_key => "{authKey}");


$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new AddDVTokenWithAuthKeyReq()
{
    TokenReq = new TokenRequestWithAuthKey()
    {
        CardDetails = new  CreditCardDetailsWith2PartExpiryDate(){
            CardHolderName = "John Smith"
        },
        Reference1 = "12345",
        Reference2 = "",
        Reference3 = "",
        EmailAddress = "john.smith@email.com.au"
    }
};

var response = tokenClient.AddTokenViaIframe("{authKey}",apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var cc = new api.AuthKeyCardDetails({
CardHolderName : "MR C CARDHOLDER"});

var req = new api.AddTokenViaIframe({
Reference1: "NodeJS Token 1",
EmailAddress: "notatoken@token.com",
CardDetails: cc,
AuthKey: "{AuthKey}"});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Ajax example

<div class="validation-summary"></div>

<div>
    <label>Reference1:</label>
    <input id="Reference1" name="Reference1" type="text"/>
</div>
<div>
    <label>Reference2:</label>
    <input id="Reference2" name="Reference2" type="text"/>
</div>
<div>
    <label>Reference3:</label>
    <input id="Reference3" name="Reference3" type="text"/>
</div>
<div>
    <label>EmailAddress:</label>
    <input id="EmailAddress" name="EmailAddress" type="text"/>
</div>
<div>
    <label>CardHolderName:</label>
    <input id="CardHolderName" name="CardHolderName" type="text"/>
</div>

<div>
    <iframe src="https://www.merchantsuite.com/api/v2/tokens/iframe/add/{authKey}" frameborder="0"></iframe>
</div>

<div>
<button id="btnProcess" type="button">Process</button>
</div>

<script type="text/javascript">
    $(document).ready(function () {
        $("#btnProcess").click(function () {
            $("input").attr("disabled", "disabled");
            setTimeout(ProcessTokenisation, 1000);
        });
    });

function ProcessTokenisation() {
    $(".validation-summary").empty().hide();
    var url = "https://www.merchantsuite.com/api/v2/tokens/iframe/add/{authKey}";
    var jsonModel = JSON.stringify(GetModelForProcessing());

    $.ajax({
        type: "POST",
        dataType: "json",
        contentType: "application/json",
        url: url,
        data: jsonModel,
        success: function (result) {
            $("input").removeAttr("disabled");

            if (result && result.APIResponse) {
                if (result.APIResponse.ResponseCode == 0) {
                    window.location.href = result.RedirectionUrl;
                }
                else
                    ShowError(result.APIResponse.ResponseText);
            }
            else {
                ShowError("Error processing your request. Response from API is either empty or invalid.");
            }
        },
        error: function (jqXhr, textStatus) {
            $("input").removeAttr("disabled");
            $("#btnProcess").removeAttr("disabled");
            ShowError("AJAX Error processing your request. XHR Status: " + textStatus);
        }
    });
}

function ShowError(errorText) {
    var ul = $("<ul></ul>");

    ul.append("<li>" + errorText + "</li>");

    $(".validation-summary").append(ul).show();
}

function GetModelForProcessing() {
    var model = new Object();

    model.TokenReq = new Object();
    model.TokenReq.Crn1 = $("#CRN1").val();
    model.TokenReq.Crn2 = $("#CRN2").val();
    model.TokenReq.Crn3 = $("#CRN3").val();
    model.TokenReq.EmailAddress = $("#EmailAddress").val();
    model.TokenReq.CardDetails = new Object();
    model.TokenReq.CardDetails.CardHolderName = $("#CardHolderName").val();

    return model;
}
</script>

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 144
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=qmytl98r23956x2998tyuins; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:07 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "ResultKey" : "df998fea-f309-4e6e-9629-7149799dc028",
  "RedirectionUrl" : "http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=df998fea-f309-4e6e-9629-7149799dc028"
}

3 Party Token Update Iframe

There are two available methods.

• Submit button inside iframe (multi page / button mode)
• Submit button outside iframe (single page / button mode)

Submit button inside example

If IframeParameters.ShowSubmitButton is set to true in a create AuthKey request (see AuthKey) then the iframe update Token page will operate in the multi-page / button mode. In this mode the "Process Update Token Iframe" method (See submit button outside example) does not need to be invoked. Instead, the TokenReq.Crn1 parameter needs to be submitted in the create AuthKey call.

<iframe src="https://www.merchantsuite.com/api/v2/tokens/iframe/update/{authKey}" frameborder="0"></iframe>

Clicking the "Submit" button inside iframe will process the update Token request and will redirect the iframe to the RedirectionUrl specified in the AuthKey request.

http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=13cfa799-8278-4872-a705-7ed49d516c0b

Request

Request is a TokenReq (Token request details) JSON object with following properties.

Submit button outside example

If IframeParameters.ShowSubmitButton is either not set (default) or set to false in create AuthKey call (see AuthKey) then the iframe update Token page will operate in the single page / button mode. In this mode as the consumer enters their details into the card fields (card holder name, card number, expiry date), it will get stored on the AuthKey session. The Process Update Token Iframe (https://www.merchantsuite.com/api/v2/tokens/iframe/update/{authKey}) function will need to be invoked to process the update request, this can be either an ajax call or a server to server call.

Server to server example

POST https://www.merchantsuite.com/api/v2/tokens/iframe/update/{authKey} HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Content-Type: application/json; charset=utf-8
Host: www.merchantsuite.com
Content-Length: 247
Expect: 100-continue
Connection: Keep-Alive

{
    "TokenReq" : {
        "BankAccountDetails" : null,
        "CardDetails" : {
            "CardHolderName" : "John Smith"
        },
        "AcceptBADirectDebitTC" : true,
        "EmailAddress" : "john.smith@email.com.au",
        "Reference1" : "12345",
        "Reference2" : "",
        "Reference3" : null
    }
}

include ("./API/MerchantSuite.php");

MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$cardDetails = new MerchantSuite\AuthKeyCardDetails();
$cardDetails->setCardHolderName("cardholdername");

$addToken = new MerchantSuite\UpdateTokenViaIframe("{AuthKey}");
$addToken->setCredentials($credentials);
$addToken->setCardDetails($cardDetails);
$addToken->setEmailAddress("user@email.com");
$addToken->setReference1("Token Reference 1");
$addToken->setReference2("Token Reference 2");
$addToken->setReference3("Token Reference 3");

$response = $addToken->submit();

from MerchantSuite.Requests import Credentials, UpdateTokenViaIframe
from MerchantSuite.Utils import AuthKeyCardDetails

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = UpdateTokenViaIframe(credentials,"{AuthKey}")
request.base_url = "https://www.merchantsuite.com/api/v2"

request.card_details = AuthKeyCardDetails(card_holder_name = "MR C CARDHOLDER")
request.reference1 = "Ref One"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::UpdateTokenViaIframe.new("{AuthKey}")
req.credentials = cred

cc = MerchantSuite::AuthKeyCardDetails.new()
cc.card_holder_name = "Card Holder Name"

req.base_url = "https://www.merchantsuite.com/api/v2"
req.card_details = cc
req.reference1 = "reference 1"

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

CreditCardDetailsWith2PartExpiryDate cc = new CreditCardDetailsWith2PartExpiryDate();
cc.setCardHolderName("MR C CARDHOLDER");

UpdateTokenViaIframe req = new UpdateTokenViaIframe(credentials);
req.setAuthKey("{authKey}");
req.setBaseUrl("https://www.merchantsuite.com/api/v2");
req.setReference1("Java Token 1");
req.setCardDetails(cc);

ResultKeyResponse resp;
resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

my $cc = MerchantSuite::AuthKeyCardDetails->new(card_holder_name => "MR C CARDHOLDER");

$req = MerchantSuite::UpdateTokenViaIframe->new(
credentials => $cred,
reference1 => "Perl Token 1",
card_details => $cc,
auth_key => "{authKey}");


$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var apiReq = new UpdateTokenWithAuthKeyReq()
{
    TokenReq = new TokenRequestWithAuthKey()
    {
        CardDetails = new  CreditCardDetailsWith2PartExpiryDate(){
            CardHolderName = "John Smith"
        },
        Reference1 = "12345",
        Reference2 = "",
        Reference3 = "",
        EmailAddress = "john.smith@email.com.au"
    }
};

var response = tokenClient.UpdateTokenViaIframe("{authKey}",apiReq);

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var cc = new api.AuthKeyCardDetails({
CardHolderName : "MR C CARDHOLDER"});

var req = new api.UpdateTokenViaIframe({
Reference1: "NodeJS Token 1",
EmailAddress: "notatoken@token.com",
CardDetails: cc,
AuthKey: "{AuthKey}"});

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Not Available

//Not Available

Ajax example

<div class="validation-summary"></div>

<div>
    <label>Reference1:</label>
    <input id="Reference1" name="Reference1" type="text"/>
</div>
<div>
    <label>Reference2:</label>
    <input id="Reference2" name="Reference2" type="text"/>
</div>
<div>
    <label>Reference3:</label>
    <input id="Reference3" name="Reference3" type="text"/>
</div>
<div>
    <label>EmailAddress:</label>
    <input id="EmailAddress" name="EmailAddress" type="text"/>
</div>
<div>
    <label>CardHolderName:</label>
    <input id="CardHolderName" name="CardHolderName" type="text"/>
</div>

<div>
    <iframe src="https://www.merchantsuite.com/api/v2/tokens/iframe/update/{authKey}" frameborder="0"></iframe>
</div>

<div>
<button id="btnProcess" type="button">Process</button>
</div>

<script type="text/javascript">
    $(document).ready(function () {
        $("#btnProcess").click(function () {
            $("input").attr("disabled", "disabled");
            setTimeout(ProcessTokenisation, 1000);
        });
    });

function ProcessTokenisation() {
    $(".validation-summary").empty().hide();
    var url = "https://www.merchantsuite.com/api/v2/tokens/iframe/update/{authKey}";
    var jsonModel = JSON.stringify(GetModelForProcessing());

    $.ajax({
        type: "POST",
        dataType: "json",
        contentType: "application/json",
        url: url,
        data: jsonModel,
        success: function (result) {
            $("input").removeAttr("disabled");

            if (result && result.APIResponse) {
                if (result.APIResponse.ResponseCode == 0) {
                    window.location.href = result.RedirectionUrl;
                }
                else
                    ShowError(result.APIResponse.ResponseText);
            }
            else {
                ShowError("Error processing your request. Response from API is either empty or invalid.");
            }
        },
        error: function (jqXhr, textStatus) {
            $("input").removeAttr("disabled");
            $("#btnProcess").removeAttr("disabled");
            ShowError("AJAX Error processing your request. XHR Status: " + textStatus);
        }
    });
}

function ShowError(errorText) {
    var ul = $("<ul></ul>");

    ul.append("<li>" + errorText + "</li>");

    $(".validation-summary").append(ul).show();
}

function GetModelForProcessing() {
    var model = new Object();

    model.TokenReq = new Object();
    model.TokenReq.Crn1 = $("#CRN1").val();
    model.TokenReq.Crn2 = $("#CRN2").val();
    model.TokenReq.Crn3 = $("#CRN3").val();
    model.TokenReq.EmailAddress = $("#EmailAddress").val();
    model.TokenReq.CardDetails = new Object();
    model.TokenReq.CardDetails.CardHolderName = $("#CardHolderName").val();

    return model;
}
</script>

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 144
Content-Type: application/json; charset=utf-8
Set-Cookie: ASP.NET_SessionId=qmytl98r23956x2998tyuins; path=/; secure; HttpOnly
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:27:07 GMT

{
  "APIResponse" : {
    "ResponseCode" : 0,
    "ResponseText" : "Success"
  },
  "ResultKey" : "df998fea-f309-4e6e-9629-7149799dc028",
  "RedirectionUrl" : "http://yourmerchantwebsite.com/tokenreceipt?ResponseCode=0&ResponseText=Success&ResultKey=df998fea-f309-4e6e-9629-7149799dc028"
}

Lookup Token Result

Retrieves result of a token added/updated via operation using Browser integration method. Should the resultKey value not be available, a token search (see 2 Party Search Tokens) should be performed to confirm that the token is in place and required details retrieved.

URL

URL Parameters

resultKey - result key returned in a response to add/update transaction operation

Request Headers

This is a merchant integration method. You will be required to supply following HTTP headers with your GET request

Authorization

base64 encoded API user credentials

Response Headers

Content-Type

application/json; charset=utf-8

GET https://www.merchantsuite.com/api/v2/tokens/withauthkey/03a038f5-ae28-44a4-a8d0-8c78279f5445 HTTP/1.1
Authorization: dXNlcm5hbWV8bWVtYmVyc2hpcGlkOnBhc3N3b3Jk
Host: www.merchantsuite.com

include ("./API/MerchantSuite.php");
MerchantSuite\URLDirectory::setBaseURL("reserved","https://www.merchantsuite.com/api/v2");
$credentials = new MerchantSuite\Credentials("APIUserName", "Passw0rd", "MS123456", MerchantSuite\Mode::Live);

$reskey = new MerchantSuite\TokenResultKeyRetrieval();
$reskey->setCredentials($credentials);
$reskey->setResultKey("03a038f5-ae28-44a4-a8d0-8c78279f5445");

$response = $reskey->submit();

from MerchantSuite.Requests import Credentials, TokenResultKeyRequest

credentials = Credentials("APIUserName", "Passw0rd", "MS123456")

request = TokenResultKeyRequest(credentials,"03a038f5-ae28-44a4-a8d0-8c78279f5445")
request.base_url = "https://www.merchantsuite.com/api/v2"

response = request.submit()

require_relative "API/MerchantSuite"

cred = MerchantSuite::Credentials.new("APIUserName", "Passw0rd", "MS123456")

req = MerchantSuite::TokenAuthKeyResultRequest.new("03a038f5-ae28-44a4-a8d0-8c78279f5445")

req.base_url = "https://www.merchantsuite.com/api/v2"
req.credentials = cred

response = req.submit()

import com.MerchantSuite.api.*;

Credentials credentials = new Credentials("APIUserName", "Passw0rd", "MS123456");
Sender s = new Sender();

TokenResultKeyRequest req = new TokenResultKeyRequest(credentials, "03a038f5-ae28-44a4-a8d0-8c78279f5445");
TokenResp resp;

req.setBaseUrl("https://www.merchantsuite.com/api/v2");

resp = s.submit(req);

use MerchantSuite::API;
use Data::Inspect qw(p);

$MerchantSuite::Sender::base_url = "https://www.merchantsuite.com/api/v2";

my $cred = MerchantSuite::Credentials->new(
username => 'APIUserName',
password => 'Passw0rd',
membership_id => "MS123456"
);

my $req;

$req = MerchantSuite::TokenResultKeyRequest->new(
resultkey => "03a038f5-ae28-44a4-a8d0-8c78279f5445",
credentials => $cred);

$result = $req->submit();

using MerchantSuite.API.Client.V2;
using API.Client.Common;
using API.Client.Common.Helpers;

var tokenClient = ClientFactory.GetClientInstance<TokenClient>(
new JsonWebClientHelper(),
"https://www.merchantsuite.com/api/v2",
"APIUserName",
"MS123456",
"Passw0rd",
null);

var response = tokenClient.
RetrieveAddUpdateTokenResult("03a038f5-ae28-44a4-a8d0-8c78279f5445");

var MerchantSuite = require("./MerchantSuite_API/index.js");
var api = new MerchantSuite();

var req = new api.TokenResultKey(
"13cfa799-8278-4872-a705-7ed49d516c0b");

req.baseUrl("https://www.merchantsuite.com/api/v2");

var creds = req.credentials({
Username : "APIUserName",
Password: "Passw0rd",
MembershipID : "MS123456"});

var resp = req.submit(ResponseHandler, // Custom Callback Function
function(code, body) { console.log(code + " : " + body); }, // Error Callback Function
creds);

//Configure the ApiConfig.java file to input your API user and Merchant credentials
import main.java.com.merchantsuite.android.api.ApiManager;

String authKey = "13cfa799-8278-4872-a705-7ed49d516c0b";

String response = lookupAddUpdateDataVaultWithTokenResult(authKey);

//Not Available

Response

Response is a JSON object with the following properties.

HTTP/1.1 200 OK
Cache-Control: private,no-store,no-cache,must-revalidate,proxy-revalidate
Pragma: no-cache
Content-Length: 359
Content-Type: application/json; charset=utf-8
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Max-Age: 1728000
Date: Fri, 12 Dec 2014 01:57:56 GMT

{
	"APIResponse" : {
		"ResponseCode" : 0,
		"ResponseText" : "Success"
	},
	"TokenResp" : {
		"BankAccountDetails" : null,
		"CardDetails" : {
			"CardHolderName" : "John Smith",
			"ExpiryDate" : "0521",
			"MaskedCardNumber" : "512345...346"
		},
		"CardType" : "MC",
		"EmailAddress" : "john.smith@email.com.au",
		"Reference1" : "test reference1",
		"Reference2" : "test reference2",
		"Reference3" : "test reference3",
		"Token" : "5999999789012346"
	}
}

WebHooks

WebHooks are an asynchronous notification mechanism. They are triggered by operations invoked using the Browser integration method. They notify merchant systems that a successful operation has taken place and provides the detailed result.

WebHooks are triggered only if the merchant has provided a WebHook URL in the request to obtain an AuthKey. The system will attempt the WebHook notification upon transaction completion, retrying at 1 hour intervals until successfully acknowledged by the merchant or the retry period has expired. The retry period is 24 hours.

To acknowledge a WebHook notification, the merchant's application must respond to the request with the HTTP Status Code 200. HTTP responses with Status Codes other than 200 will be interpreted as the WebHook call having failed, with retries being attempted until a response featuring a HTTP Status Code of 200 is received or the retry period expires.

Note: There is a possibility that multiple WebHook calls for the same action may be seen by the Merchant's server. For this reason, it is important that WebHook request contents are checked for uniqueness prior to updating data.

Note: China UnionPay transactions will always have a response code of "P". You will need to poll MerchantSuite using the 2 Party Search Transaction method to obtain the result. China UnionPay only returns a response for approved transactions. If the transaction is not completed and approved within 2 hours then a response code of "3" - "TIMED_OUT" will be returned.

Originating IP addresses

WebHook calls originate from specified IP addresses. Please refer to the Firewall Configuration section under References

API Response Codes

A list of the api response codes.