Gateway Property

Gateway to process transactions with.

Syntax

 recurringbilling.getGateway([callback])
 recurringbilling.setGateway( gateway, [callback])

Possible Values

  0 (rbgwNoGateway), 
  1 (rbgwAuthorizeNet), 
  2 (rbgwEprocessing), 
  4 (rbgwITransact), 
  6 (rbgwPayFlowPro), 
  7 (rbgwUSAePay), 
  8 (rbgwPlugNPay), 
  9 (rbgwPlanetPayment), 
  15 (rbgwMerchantAnywhere), 
  16 (rbgwSkipjack), 
  23 (rbgwOrbital), 
  24 (rbgwLinkPoint), 
  25 (rbgwMoneris), 
  28 (rbgwNetworkMerchants), 
  30 (rbgwPRIGate), 
  31 (rbgwMerchantPartners), 
  33 (rbgwFirstData), 
  34 (rbgwYourPay), 
  35 (rbgwACHPayments), 
  36 (rbgwForte), 
  37 (rbgwCyberSource), 
  38 (rbgwEway), 
  41 (rbgwChase), 
  42 (rbgwNexCommerce), 
  44 (rbgwTransactionCentral), 
  49 (rbgwMyVirtualMerchant), 
  52 (rbgwMonerisUSA), 
  53 (rbgwBambora), 
  54 (rbgwVerifi), 
  61 (rbgwQBMS), 
  63 (rbgwLitle), 
  70 (rbgwPayTrace), 
  73 (rbgwOmniFund), 
  74 (rbgwTransNationalBankcard), 
  83 (rbgwPayscape), 
  85 (rbgwAuthorizeNetCIM), 
  87 (rbgwWorldPayLink), 
  88 (rbgwPaymentWorkSuite), 
  90 (rbgwFirstDataPayPoint), 
  93 (rbgwConverge), 
  96 (rbgwAuthorizeNetXML), 
  97 (rbgwPhoeniXGate), 
  98 (rbgwRepay), 
  100 (rbgwPayWiser), 
  104 (rbgwBlueSnap), 
  106 (rbgwBASYS), 
  108 (rbgwSquare), 
  110 (rbgwNuvei)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getGateway([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setGateway([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is used to select the gateway with which transactions will be processed. Setting the Gateway property will also fill the GatewayURL, SpecialFieldName, and SpecialFieldValue properties with default data for the selected gateway. The following table shows the currently supported gateways, as well as the corporate home page for each.

Data Type

Integer