Credit Card field mapping between Zuora and Opayo
The following table describes the object and field mappings between Zuora and Opayo for Credit Card payment methods.
| Opayo Direct API field | Zuora UI field | Zuora API field (object.field) | Additional information |
|---|---|---|---|
| VendorTxCode |
In payment method creation: N/A In payment processing: Payment Number In refund processing: Refund Number |
In payment method creation: N/A In payment processing: Payment.PaymentNumber In refund processing: Refund.RefundNumber |
During payment method creation and validation, Zuora generates a random ID for In payment or refund processing, Zuora Payment Number or Refund Number is used as |
| BillingSurname | Credit Card > Card Holder Name | PaymentMethod.CreditCardHolderName | |
| BillingFirstnames | Credit Card > Card Holder Name | PaymentMethod.CreditCardHolderName | |
| BillingAddress1 | Credit Card > Billing Address (line 1) | PaymentMethod.CreditCardAddress1 | |
| BillingAddress2 | Credit Card > Billing Address (line 2) | PaymentMethod.CreditCardAddress2 | |
| BillingCity | Credit Card > Billing City | PaymentMethod.CreditCardCity | |
| BillingState | Credit Card > Billing State/Province | PaymentMethod.CreditCardState | |
| BillingCountry | Credit Card > Billing Country | PaymentMethod.CreditCardCountry | |
| BillingPostCode | Credit Card > Billing Postal Code | PaymentMethod.CreditCardPostalCode | |
| BillingPhone | Credit Card > Phone | PaymentMethod.Phone | |
| DeliverySurname | Credit Card > Card Holder Name | PaymentMethod.CreditCardHolderName | |
| DeliveryFirstnames | Credit Card > Card Holder Name | PaymentMethod.CreditCardHolderName | |
| DeliveryAddress1 | Credit Card > Billing Address (line 1) | PaymentMethod.CreditCardAddress1 | |
| BillingAddress2 | Credit Card > Billing Address (line 2) | PaymentMethod.CreditCardAddress2 | |
| DeliveryCity | Credit Card > Billing City | PaymentMethod.CreditCardCity | |
| DeliveryState | Credit Card > Billing State/Province | PaymentMethod.CreditCardState | |
| DeliveryCountry | Credit Card > Billing Country | PaymentMethod.CreditCardCountry | |
| DeliveryPostCode | Credit Card > Billing Postal Code | PaymentMethod.CreditCardPostalCode | |
| DeliveryPhone | Credit Card > Phone | PaymentMethod.Phone | |
| CustomerEMail | Credit Card > Email | PaymentMethod.Email | |
| Currency | Account Currency | Account.Currency | |
| Amount | Gateway Instance > Default Authorization Amount | N/A | |
| CV2 | Credit Card > Card Security Code | PaymentMethod.CreditCardSecurityCode | |
| CardHolder | Credit Card > Card Holder Name | PaymentMethod.CreditCardHolderName | |
| ExpiryDate | Credit Card > Expiration Date | PaymentMethod.CreditCardExpirationMonth | concatenated MMYY |
| ExpiryDate | Credit Card > Expiration Date | PaymentMethod.CreditCardExpirationYear | concatenated MMYY |
| CardType | Credit Card > Credit Card Type | PaymentMethod.CreditCardType | |
| CardNumber | Credit Card > CardNumber | PaymentMethod.CreditCardNumber | |
| Amount | Payment Amount | Payment.Amount | |
| Amount | Refund Amount | Refund.Amount | |
| Description | Payment Number | Payment.PaymentNumber | |
| VPSTxId |
In payment processing: Reference ID In payment void: Payment Reference ID |
In payment processing: Payment.GatewayReferenceId In payment void: Payment.ReferenceId |
|
| SecurityKey + TxAuthNo | Second Payment Reference | Payment.GatewaySecondReferenceId | These 2 response fields are needed for Payment Void and Refund in addition to the VPSTxId. |
| RelatedVendorTxCode | In refund processing: Payment Number | Payment.PaymentNumber | |
| RelatedVPSTxId | In refund processing: Payment Reference ID | Payment.ReferenceId | |
| RelatedSecurityKey + RelatedTxAuthNo | In refund processing: Second Payment Reference ID | Payment.SecondPaymentReferenceId |