(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Zuora Payment Gateway
This page details the inputs, secure inputs and outputs available for the Zuora Payment Gateway, how to complete each field, and an external link to the Zuora integration documentation.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
Input Fields
Required
Character Limits/Required Input
Description
client_id
Yes
N/A
Unique oAuth client_id provided to the client by Zuora
client_secret
Yes
N/A
Unique oAuth client_secret provided to the client by Zuora
accountKey
Yes
N/A
ID of the customer account to update.
addressLine1
No
255 char
First address line, 255 characters or less.
addressLine2
No
255 char
Second address line, 255 characters or less.
cardHolderName
Yes
50 char
The card holder's full name as it appears on the card, e.g., "John J Smith", 50 characters or less.
city
No
40 char
City, 40 characters or less.
country
No
N/A
Country, must be a valid country name or abbreviation.
email
No
80 char
Card holder's email address, 80 characters or less.
phone
No
40 char
Phone number, 40 characters or less.
state
No
N/A
State; must be a valid state name or 2-character abbreviation.
zipCode
No
20 char
Zip code, 20 characters or less.
creditCardType
Yes
N/A
The type of the credit card.
defaultPaymentMethod
No
Boolean
Specify true to make this card the default payment method; otherwise, omit this parameter to keep the current default payment method.
Comments
No
255 char
Additional comment
numConsecutiveFailures
No
0-100
The number of consecutive failed payments for this payment method. It is reset to 0 upon successful payment.
Secure Inputs
Input Fields
Required
Character Limits/Required Input
Description
creditCardNumber
Yes
36 char
The embossed or encoded number that identifies the card issuer to which a transaction is to be routed and the account to which it is to be charged unless specific instructions indicate otherwise. In the case of a credit card, this is the primary account number.
expiration
Yes
4 char (MMYY)
The 4-digit representation of the expiration date
securityCode
Yes
4 char
A security feature for credit or debit card transactions, providing increased protection against credit card or debit Card fraud. The card security code is located on the back of MasterCard, Visa and Discover credit or debit cards and is typically a separate group of 3 digits to the right of the signature strip. On American Express cards, the card security code is a printed, not embossed, group of four digits on the front towards the right.
Outputs
Output Fields
Description
success
Returns true if the request was processed successfully.
paymentMethodId
ID of the newly-created payment method.
errorCode
Error code returned by Zuora
errorMessage
Error message returned by Zuora
Further information can be found by viewing the integration documentation:
