Skip to main content

Field mappings between Zuora and CyberSource

Zuora

Field mappings between Zuora and CyberSource

This article describes the object and field mappings between Zuora and CyberSource for credit card and ACH payment methods. 

Deprecation Notice

On 28 February 2024 PDT, we will deprecate the following payment gateway integrations, following changes to Cybersource’s authentication standards:

  • CyberSource Enterprise Gateway, API v1.97
  • CyberSource Enterprise Gateway, API v1.28

If you are on one of the preceding integrations, to prevent service disruption, please migrate to the CyberSource, Payment API v2.0 payment gateway integration by following this migration guide before 28 February 2024. We also recommend you to avoid creating new instances of integrations that will be deprecated. For any questions, please contact Zuora Global Support.

Credit Card field mappings

API field passed to CyberSource Source of this information in Zuora (object.field)
card_accountNumber PaymentMethod.CreditCardNumber
card_cvNumber PaymentMethod.CreditCardSecurityCode
card_expirationMonth PaymentMethod.CreditCardExpirationMonth
card_expirationYear PaymentMethod.CreditCardExpirationYear
purchaseTotals_currency Account.Currency
item_0_unitPrice Payment.Amount
purchaseTotals_grandTotalAmount Payment.Amount
billTo_ipAddress PaymentMethod.IPAddress
billTo_customerID Account.AccountNumber
billTo_company Account.Name
billTo_email

These address fields are populated based on the following priority order:

  1. Address of the payment method: The address of the payment method takes precedence.
    • PaymentMethod.Email field
    • PaymentMethod.Phone
    • PaymentMethod.CreditCardHolderName
    • PaymentMethod.CreditCardHolderName
    • PaymentMethod.CreditCardAddress1
    • PaymentMethod.CreditCardAddress2
    • PaymentMethod.CreditCardCity
    • PaymentMethod.CreditCardState
    • PaymentMethod.CreditCardPostalCode
    • PaymentMethod.CreditCardCountry
  2. Bill-To address: If no information is available in the payment method address, the Bill-To address is used.
  3. Sold-To address: If neither the payment method address nor the Bill-To address is available, the Sold-To address is used.
billTo_phoneNumber
billTo_firstName
billTo_lastName
billTo_street1
billTo_street2
billTo_city
billTo_state
billTo_postalCode
billTo_country

ACH field mappings

API field passed to CyberSource Source of this information
in Zuora (object.field)
Description
check_bankTransitNumber PaymentMethod.AchAbaCode  
check_accountNumber PaymentMethod.AchAccountNumber  
purchaseTotals_currency Account.Currency  
item_0_unitPrice Payment.Amount  
purchaseTotals_grandTotalAmount Payment.Amount  
billTo_customerID Account.AccountNumber  
billTo_company Account.Name  
billTo_email

These address fields are populated based on the following priority order:

  1. Address of the payment method: The address of the payment method takes precedence.
  2. Bill-To address: If no information is available in the payment method address, the Bill-To address is used.
  3. Sold-To address: If neither the payment method address nor the Bill-To address is available, the Sold-To address is used.

For billTo_firstName and billTo_lastName:

  • If the account name does not contain the ampersand (&) character:
    •  billTo_firstName is set to the string before the first space from the left.
    • billTo_lastName is set to the string after the first space from the left.
  • If the account holder name contains the ampersand (&) character:
    •  billTo_firstName is set to NA.
    •  billTo_lastName is set to the whole string specified for the account holder name.
billTo_phoneNumber
billTo_firstName
billTo_lastName
billTo_street1
billTo_street2
billTo_city
billTo_state
billTo_postalCode
billTo_country