Gateway Options fields supported by Global Payments

Last updated
Save as PDF

This payment gateway integration can be requested through the Specialized Payment Connections service at an additional cost.

You can submit additional information to the gateway by using the Gateway Options fields. The following table describes the Gateway Option fields supported by the Global Payments integration.

All Gateway Options fields are string fields.

Fields used in validation and authorization

The following fields can be used in the Create a payment method API, the Create authorization API, and Payment Pages 2.0:

Global Payments field	Zuora API field	Zuora Payment Page client parameter	Description
Authorize.Paymentdata.Source	gatewayOptions.Source	param_gwOptions_Source	`Keyed`, `Vault`, `Wallet`, etc.
Authorize.Request.InvoiceNumber	gatewayOptions.InvoiceNumber	param_gwOptions_InvoiceNumber
Authorize.Request.RegisterNumber	gatewayOptions.RegisterNumber	param_gwOptions_RegisterNumber
Authorize.Request.CardAcceptorTerminalId	gatewayOptions.TerminalId	param_gwOptions_TerminalId
Authorize.Request.StoreCardInVault	gatewayOptions.StoreCard	param_gwOptions_StoreCard	Boolean value
Authorize.Request.PurchaseOrderNumber	gatewayOptions.PurchaseOrderNumber	param_gwOptions_PurchaseOrderNumber	The customer-defined identifier declaring a purchase order for the transaction.
Authorize.Request.StoredCardReason	gatewayOptions.StoredCardReason	param_gwOptions_StoredCardReason	Required for storing the card in `Vault`. If `StoreCardinVault` is set to `True` , this field is required. If the value for `Source` is `Vault`, the gateway accepts only `UNSCHEDULEDCIT` and `UNSCHEDULEDMIT` as the value for `StoredCardReason`.

Fields used in payment

The following fields can be used in the Create a payment API and Payment Pages 2.0:

Global Payments field	Zuora API field	Zuora Payment Page client parameter	Description
Sale.Paymentdata.Source	gatewayOptions.Source	param_gwOptions_Source	`Keyed`, `Vault`, `Wallet`, etc.
Sale.Request.TaxAmount	gatewayOptions.TaxAmount	param_gwOptions_TaxAmount
Sale.Request.InvoiceNumber	gatewayOptions.InvoiceNumber	param_gwOptions_InvoiceNumber
Sale.Request.RegisterNumber	gatewayOptions.RegisterNumber	param_gwOptions_RegisterNumber
Sale.Request.CardAcceptorTerminalId	gatewayOptions.TerminalId	param_gwOptions_TerminalId
Sale.Request.StoreCardInVault	gatewayOptions.StoreCard	param_gwOptions_StoreCard	Boolean value
Sale.Request.PurchaseOrderNumber	gatewayOptions.PurchaseOrderNumber	param_gwOptions_PurchaseOrderNumber	The customer-defined identifier declaring a purchase order for the transaction.
Sale.Request.StoredCardReason	gatewayOptions.StoredCardReason	param_gwOptions_StoredCardReason	Required for storing the card in `Vault`. If `StoreCardinVault` is set to `True` , this field is required. If the value for `Source` is `Vault`, the gateway accepts only `UNSCHEDULEDCIT` and `UNSCHEDULEDMIT` as the value for `StoredCardReason`.
Sale.Request.Invoice.DiscountAmount	gatewayOptions.InvoiceDiscount	param_gwOptions_InvoiceDiscount	Required for L2
Sale.Request.Invoice.ShippingAmount	gatewayOptions.ShippingAmount	param_gwOptions_ShippingAmount	Required for L2
Sale.Request.Invoice.DutyAmount	gatewayOptions.DutyAmount	param_gwOptions_DutyAmount	Required for L2
Sale.Request.Invoice.DestinationPostalCode	gatewayOptions.SoldToContactZip	param_gwOptions_SoldToContactZip	Required for L2
Sale.Request.Invoice.ShipFromPostalCode	gatewayOptions.ShipFromZip	param_gwOptions_ShipFromZip	Required for L2
Sale.Request.Invoice.taxIndicator	gatewayOptions.TaxExempt	param_gwOptions_TaxExempt	For L2
Sale.Request.Invoice.ProductDescription	gatewayOptions.ProductDescription	param_gwOptions_ProductDescription	For L2

Fields used in refund

The following fields can be used in the Refund a payment API:

Global Payments field	Zuora API field	Zuora Payment Page client parameter	Description
Sale.Paymentdata.Source	gatewayOptions.Source	param_gwOptions_Source	`Keyed`, `Vault`, `Wallet`, etc.
Sale.Request.InvoiceNumber	gatewayOptions.InvoiceNumber	param_gwOptions_InvoiceNumber
Sale.Request.RegisterNumber	gatewayOptions.RegisterNumber	param_gwOptions_RegisterNumber
Sale.Request.CardAcceptorTerminalId	gatewayOptions.TerminalId	param_gwOptions_TerminalId
Sale.Request.StoredCardReason	gatewayOptions.StoredCardReason	param_gwOptions_StoredCardReason	Required for storing the card in `Vault`. If `StoreCardinVault` is set to `True` , this field is required. If the value for `Source` is `Vault`, the gateway accepts only `UNSCHEDULEDCIT` and `UNSCHEDULEDMIT` as the value for `StoredCardReason`.

Fields used in payment void

The following fields can be used in the Cancel a payment API:

Global Payments field	Zuora API field	Zuora Payment Page client parameter
Sale.Request.RegisterNumber	gatewayOptions.RegisterNumber	param_gwOptions_RegisterNumber
Sale.Request.CardAcceptorTerminalId	gatewayOptions.TerminalId	param_gwOptions_TerminalId

Here are examples for specifying the parameters.

Through Payment Pages 2.0:

"param_gwOptions_Source" : "Vault";
"param_gwOptions_StoredCardReason" : "UNSCHEDULEDCIT"

Through the API operation:

"gatewayOptions": {
    "Source":"20",
    "StoredCardReason":"UNSCHEDULEDCIT"
}

Fields used in validation and authorization

Fields used in payment

Fields used in refund

Fields used in payment void

Related information