Skip to main content

Gateway Option fields supported by CyberSource v2.0

Zuora

Gateway Option fields supported by CyberSource v2.0

  1. Last updated
  2. Save as PDF

The following table describes the Gateway Option fields supported by CyberSource, Payment API v2.0.

Gateway option field Zuora API field Zuora Payment Page client parameter Description
tokenize gatewayOptions.tokenize param_gwOptions_shopperIP

Indicates whether to tokenize the payment method information.

You can use these fields in Payment Pages 2.0 or the following REST API:
  • ipAddress
  • deviceFingerprintID
  • merchantDefinedData_mddField_<Number>, where <Number> ranges from 1 to 100
  • gatewayOptions.ipAddress
  • gatewayOptions.deviceFingerprintID
  • gatewayOptions.merchantDefinedData_mddField_<Number>, where <Number> ranges from 1 to 100
  • param_gwOptions_ipAddress
  • param_gwOptions_deviceFingerprintID
  • param_gwOptions_merchantDefinedData_mddField_<Number>, where <Number> ranges from 1 to 100

Used in authorization or capture requests for the Decision Manager service.

You can use these fields in Payment Pages 2.0, SOAP API, or the following REST API:
  • item_<Number>_unitPrice
  • item_<Number>_quantity
  • item_<Number>_productName
  • item_<Number>_productSKU

 <Number> ranges from 1 to 100
  • gatewayOptions.item_<Number>_unitPrice
  • gatewayOptions.item_<Number>_quantity
  • gatewayOptions.item_<Number>_productName
  • gatewayOptions.item_<Number>_productSKU

<Number> ranges from 1 to 100
  • param_gwOptions_item_<Number>_unitPrice
  • param_gwOptions_item_<Number>_quantity
  • param_gwOptions_item_<Number>_productName
  • param_gwOptions_item_<Number>_productSKU

<Number> ranges from 1 to 100

These gateway option fields are on the invoice item level and provide more information about invoice items, which facilitates fraud detection on the gateway side. They can be used in only the payment method creation (authorization) request.

A maximum of 100 invoice items can be included in each request.

You can use these fields in Payment Pages 2.0, SOAP API, or the following REST API:

ShipTo fields, including:

  • Title
  • FirstName
  • MiddleName
  • LastName
  • Suffix
  • Street1
  • Street2
  • Street3
  • Street4
  • Street5
  • City
  • County
  • State
  • BuildingNumber
  • District
  • postalCode
  • Country
  • Company
  • PhoneNumber
  • Email
  • ShippingMethod
  • Name
  • Id
  • AddressVerificationStatus
  • NotApplicable
  • Immutable
  • DestinationCode
  • PointOfReference
  • Default
  • DestinationTypes

gatewayOptions.ShipTo<ShipTo_Option_Field>

In your API request, replace <ShipTo_Option_Field> with the field name in the Gateway option field column, as the nested field. Here is an example:

"gatewayOptions":

{

 "ShipToTitle": "Title",

 "ShipToFirstName": "Firsname", 

 "ShipToPhoneNumber": "123456789"

 }

param_gwOptions_ShipTo<ShipTo_Option_Field>

In client code, replace <ShipTo_Option_Field> with the field name in the Gateway option field column. Here is an example:

param_gwOptions_ShipToTitle

Defines the address where to deliver the items.

You can use these fields in Payment Pages 2.0, SOAP API, or the following REST API: