Transactions

These are the payment transactions that you can integrate into your application:

In this topic:

Prerequisite

Send Converge Credentials

Before you can post any transaction requests, you need to send your Converge credentials to Commerce SDK using the openPaymentGateway command to initialize your application. After Commerce SDK receives your credentials, it uses these for all subsequent communications with Converge.

Request

Response

Code Samples

• CWS
• C#

CWS

Request

{
  "method" : "openPaymentGateway",
  "requestId" : "1326383996",
  "targetType" : "paymentGatewayConverge",
  "version" : "1.0",
  "parameters" : {
    "app" : "VMM",
    "email" : "******",
    "pin" : "******",
    "userId" : "******",
    "handleDigitalSignature" : true,
    "paymentGatewayEnvironment" : "DEMO",
    "vendorId" : "******",
    "vendorAppName" : "******",
    "vendorAppVersion" : "******",
    "overrideDefaultTerminalLanguage" : {
      "languageInformation" : {
        "languageCode" : "UNSET",
        "countryCode" : "UNSET"
      }
    },
    "overrideDebitNetworkPreferences" : {
      "visa" : "NO_PREFERENCE",
      "mastercard" : "US_COMMON_DEBIT",
      "discover" : "GLOBAL_NETWORK"
    }
  }
}

Response

{
  "requestId" : "1326383996",
  "statusDetails" : "REQUEST_ACCEPTED",
  "data" : {
    "paymentGatewayCommand" : {
      "completed" : true,
      "eventQueue" : [ ],
      "openPaymentGatewayData" : {
        "result" : "SUCCESS",
        "paymentGatewayId" : "0907356b-d985-4e3f-adae-1a74b9264a8a"
      }
    }
  }
}

C#

OpenPaymentArgs opa = new OpenPaymentArgs();           
opa.merchantId = MY_MERCHANT;
opa.userId = MY_USER;
opa.pin = MY_PIN;
opa.app = MY_APP;
opa.email = MY_EMAIL;
opa.vendorId = MY_VENDOR_ID;
opa.vendorAppName = MY_VENDOR_APP_NAME;
opa.vendorAppVersion = MY_VENDOR_APP_VERSION;
opa.paymentGatewayEnvironment = MY_SERVERTYPE;
opa.handleDigitalSignature = true; /* We can handle digital signature */

// The language used for transaction can be overridden.
// This applies to RBA pinpads only and will have no effect for other pinpads.
// This is completely optional. If not used, a possibly server supplied language preference info is going to be used.
// You can specify a pair of (language, country) to determine the language to be used on pinpad during a transaction.
// If the pair you supplied is not supported, the return value will indicate the language CSDK chose to use.
// This is determined to be the closest match to what you specified.
// Currently, CSDK supports English in US and English and French in Canada.
opa.overrideDefaultTerminalLanguage = new OverrideDefaultTerminalLanguage();
opa.overrideDefaultTerminalLanguage.languageInformation = new LanguageInformation();
opa.overrideDefaultTerminalLanguage.languageInformation.languageCode = MY_OVERRIDE_LANGUAGE_LANGUAGE_CODE;
opa.overrideDefaultTerminalLanguage.languageInformation.countryCode = MY_OVERRIDE_LANGUAGE_COUNTRY_CODE;

// You can override the CSDK setting for the debit network preference in the US.
// This applies to US RBA pinpads only and will have no effect for other pinpads.
// This is completely optional. If not used, a possibly server supplied value is going to be used.
// The possible choices are: global debit network, us common debit network or no preference at all,
// in which case the user will be asked to do the selection on the pinpad, if applicable.
// Be advised that in case of contactless transactions, the pinpad will not ask the user for a selection,
// but it will select the AID with the highest priority remaining after filtering them based on the setting.
// For example, if the choice is to use the global network and there 2 global AIDS on the card,
// RBA will automatically select the one with the highest priority.
opa.overrideDebitNetworkPreferences = new OverrideDebitNetworkPreferences();
opa.overrideDebitNetworkPreferences.visa = MY_VISA_PREF;
opa.overrideDebitNetworkPreferences.mastercard = MY_MASTERCARD_PREF;
opa.overrideDebitNetworkPreferences.discover = MY_DISCOVER_PREF;

OpenPaymentGatewayResults opgr = m_CWS.OpenPaymentGateway(opa, null);
MyOpenPaymentGatewayComplete(opgr);

...

public void MyOpenPaymentGatewayComplete(OpenPaymentGatewayResults opgr)
{
    OpenPaymentData opd = opgr.OpenPaymentData;
    if (null != opd)
    {
        // success, store the payment gateway id
    }
    else
    {
        // failure
    }
}

RBA PINPad Processing Options

RBA PINPad Language

This method overrides the language used on an RBA pinpad during a transaction.

Request

Response

Example Request

{
  "method" : "overrideDefaultTerminalLanguage",
  "requestId" : "386097750",
  "targetType" : "api",
  "version" : "1.0",
  "parameters" : {
    "languageInformation" : {
      "languageCode" : "EN",
      "countryCode" : "US"
    }
  }
}

Response

{
  "requestId" : "386097750",
  "statusDetails" : "REQUEST_ACCEPTED",
  "data" : {
    "countryCode" : "US",
    "completed" : true,
    "languageCode" : "EN"
  }
}

US Debit Network Preference

This method overrides the US debit network preference used on an RBA pinpad during a transaction.

Request

Response

Example Request

{
  "method" : "overrideDebitNetworkPreferences",
  "requestId" : "386097749",
  "targetType" : "api",
  "version" : "1.0",
  "parameters" : {
    "discover" : "GLOBAL_NETWORK",
    "mastercard" : "US_COMMON_DEBIT",
    "visa" : "NO_PREFERENCE"
  }
}

Response

{
  "requestId" : "386097749",
  "statusDetails" : "REQUEST_ACCEPTED",
  "data" : {
    "completed" : true
  }
}