Merchant Transaction Reference

The Merchant Transaction Reference provides the merchant with a way to associate a reference with a transaction and search for transactions associated with the reference.

Code Samples

CWS

Request

parameters
JSONObject | required
All relevant parameters for merchant reference association.
 
merchantTransactionReference
string | optional
Merchant Transaction Reference
Unique merchant reference code or ID with which to associate the transaction.

Example

Request

Associate the transaction with the merchant reference code or ID.

{
  "method" : "startPaymentTransaction",
  "requestId" : "45002870",
  "targetType" : "paymentGatewayConverge",
  "version" : "1.0",
  "parameters" : {
    "paymentGatewayId" : "79f139c4-3bb0-4bdb-b587-6cbcce02acf7",
    "transactionType" : "SALE",
    "tenderType" : "CARD",
  .....
    "merchantTransactionReference" : "Ras987",
  .....
  }
}

Search the transaction using the merchant transaction reference code or ID.

{
  "method" : "searchPaymentTransaction",
  "requestId" : "45002903",
  "targetType" : "paymentGatewayConverge",
  "version" : "1.0",
  "parameters" : {
    "first6CC" : null,
    "creditCard" : null,
    "merchantTransactionReference" : "Ras987",
    "utcDate" : null,
    "paymentGatewayId" : "6a9d5538-2734-44b0-873f-5fa602860910",
    "transId" : null,
    "endDate" : "20161201",
    "last4CC" : "4243",
    "beginDate" : "20161201",
    "note" : ""
  }
}

Java

Sale with Merchant Transaction Reference (Request)

ECLCurrencyTransactionInterface transaction;
String mtr;
...
transaction.setMerchantTransactionReference(mtr);
...
account.getTransactionProcessor().processTransaction(transaction, tender, transactionListener);

Search Transactions by Merchant Transaction Reference (Request)

ECLTransactionSearchCriteriaInterface theCriteria;
String mtr;
...
theCriteria.setMerchantTransactionReference(mtr);
...
account.getHistorian().search(theCriteria, this);  

Objective-C

Sale with Merchant Transaction Reference (Request)

    id<ECLCurrencyTransactionProtocol> saleTransaction;
    ...
    [saleTransaction setMerchantTransactionReference:_merchantTransRefTextField.text];
    ...
    [[_account transactionProcessor] processTransaction:saleTransaction using:_tender delegate:self];

Search by Merchant Transaction Reference (Request)

    id<ECLTransactionSearchCriteriaProtocol> searchCriteria;
    ...
    [searchCriteria setMerchantTransactionReference:_merchantTransRefTextField.text];
    ...
    [_historian search:searchCriteria delegate:self];

C#

Sale with Merchant Transaction Reference (Request)

    PaymentArgs paymentArgs;
    ...
    paymentArgs.merchantTransactionReference = tb_MTR.Text;
    ...
    m_CWS.StartPaymentTransaction(paymentArgs, MyNotifyCWSEvent, MyPaymentComplete);

Search Transaction by Merchant Transaction Reference (Request)

    TransactionSearchArgs tsa;

    ...
    tsa.merchantTransactionReference = tb_SearchMTR.Text;
    ...
    tsr = m_CWS.TransactionSearch(tsa, null);  /* Search */