Fields used in payment void
This document outlines the fields used in the Cancel a payment API, including their corresponding Zuora API fields and Payment Page client parameters.
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"
}