Field mappings for credit card transactions through FiservIPG
This payment gateway integration can be requested through the Specialized Payment Connections service at an additional cost.
The following tables describe the mappings of key identifier fields for credit card transactions through the FiservIPG integration.
To find out more information about the communication between Zuora and the gateway for payment method creation, verification, and payment processing, you can use the information in the following tables in combination with the information in the payment method transaction log and payment transaction log. For how to export transaction logs, see Discover information about payment method creation and payment processing.
Payment method validation
| Zuora API Field | Zuora Field | Request/Response | Description |
|---|---|---|---|
|
TokenId |
GatewayResponseToken1 | Request | The Token ID generated by the payment gateway. |
|
SecondTokenId |
GatewayResponseToken2 |
Request | The second Token ID generated by the payment gateway. |
|
N/A |
ZuoraResponseCode |
Request |
If both tokens are present, Approved. Else, Failed |
Payment
| Fiserv IPG API Field | Zuora Field | Request/Response | Description |
|---|---|---|---|
|
IPGApiOrderRequest.Transaction.KoreanPaymentServiceTxType.StoreId |
N/A |
Request | Your unique store identifier. This field is constant for each environment. |
|
IPGApiOrderRequest.Transaction.KoreanPaymentServiceTxType.Type |
N/A |
Request | The transaction type. |
|
IPGApiOrderRequest.Transaction.KoreanPaymentInformation.BillKeyId |
TokenId |
Request | The token ID for the payment. This ID is obtained from the gateway during Payment Method (PM) creation. |
|
IPGApiOrderRequest.Transaction.KoreanPaymentInformation.Entry |
N/A |
Request | The payment entry method. |
|
IPGApiOrderRequest.Transaction.KoreanPaymentInformation.BillType |
N/A |
Request | The type of bill. |
|
IPGApiOrderRequest.Transaction.Payment.ChargeTotal |
PaymentAmount |
Request | The total amount of the billing request. This value must be greater than 0 and must match the currency format of your merchant account. |
|
IPGApiOrderRequest.Transaction.Payment.currency |
Currency |
Request |
The currency used to make the payment. |
|
IPGApiOrderRequest.Transaction.TransactionDetails.OrderId |
PaymentId |
Request | A universally unique identifier (UUID) for the order. |
|
IPGApiOrderResponse.IpgTransactionId |
GatewayReferenceId |
Response | A unique identifier for the transaction, generated by the gateway. |
|
IPGApiOrderResponse.ProcessorResponseCode |
GatewayResponseCode |
Response | The response code generated by the gateway. |
|
IPGApiOrderResponse.ProcessorResponseMessage |
GatewayResponseMessage |
Response |
A message generated by the gateway that provides additional details about the transaction's processing. |
Refund
| Fiserv IPG API Field | Zuora Field | Request/Response | Description |
|---|---|---|---|
|
IPGApiOrderRequest.Transaction.KoreanPaymentServiceTxType.StoreId |
N/A |
Request |
Your unique store identifier. This field is constant for each environment. |
|
IPGApiOrderRequest.Transaction.KoreanPaymentServiceTxType.Type |
N/A |
Request |
Your unique store identifier. This field is constant for each environment. |
|
IPGApiOrderRequest.Transaction.Payment.ChargeTotal |
RefundAmount |
Request |
The total amount of the refund. |
|
IPGApiOrderRequest.Transaction.Payment.currency |
Currency |
Request |
The currency used to make the payment. |
|
IPGApiOrderRequest.Transaction.TransactionDetails.OrderId |
PaymentId |
Request |
A universally unique identifier (UUID) sent in the request. |
|
IPGApiOrderResponse.IpgTransactionId |
GatewayReferenceId |
Response |
A unique identifier for the refund transaction, generated by the gateway. |
|
IPGApiOrderResponse.ProcessorResponseCode |
GatewayResponseCode |
.Response |
The response code generated by the gateway. |
|
IPGApiOrderResponse.ProcessorResponseMessage |
GatewayResponseMessage |
Response |
A message generated by the gateway, that provides the additional details about the refund transaction's processing. |
Delete Payment Method
| Fiserv IPG API Field | Zuora Field | Request/Response | Description |
|---|---|---|---|
|
IPGApiActionRequest.Action.DeleteBillKey.StoreId |
N/A |
Request |
Your unique store identifier. This field is constant for each environment. |
|
IPGApiActionRequest.Action.DeleteBillKey.CustomerID |
SecondTokenId |
Request |
The customer ID that is associated with the payment method. This value must be stored when creating payment methods. |
|
IPGApiActionResponse.successfully |
ZuoraResponseCode |
Request |
Indicates the success or failure of the deletion request. |
|
IPGApiActionResponse.ProcessorResponseCode |
GatewayResponseCode |
Request | The response code generated by the gateway for the delete payment method request. |
|
IPGApiActionResponse.ProcessorResponseMessage |
GatewayResponseMessage |
Request | A message generated by the gateway providing additional details about the deletion attempt. |
When a payment method is deleted or closed in Zuora, its corresponding billkey is also permanently deleted on the payment gateway. Therefore, the same payment method cannot be reactivated or re-opened. A new payment method must be created in Zuora, which will generate a new billkey on the gateway.