Was this article helpful?

Z-Payment Page Fields

Overview

This section lists and describes all the fields that can appended to the hosted page URL that add functionality to the Z-Payments Page. You need to add the prefix field_ to each parameter when it is appended to the URL.

Payment Method Fields

Field Name (case sensitive)

Description

Max Len

accountId

The Zuora system account ID of the contact with which this payment method is associated.

32

deviceSessionId

The (web) session ID of the user when the PaymentMethod was created or updated. This is used for fraud prevention with some gateways. If passed to Zuora, Zuora will pass this field to supported gateways. Currently, only Verifi supports this field.

255

ipAddress

The IP address of the user when the PaymentMethod was created or updated. This is used for fraud prevention with some gateways. If passed to Zuora, Zuora will pass this field to supported gateways. Currently, only PayPal, CyberSource, Authorize.Net, and Verifi support this field.

15

useDefaultRetryRule

Set this to true to use the default payment run retry rules configured in the Z-Payments Administration settings. Set this to false to set the specific rules for this payment method.

If you set this to false, you must specify values for the paymentRetryWindow and maxConsecutivePaymentFailures fields. 

5

paymentRetryWindow

Use the retry interval setting to prevent a payment attempt if the last failed payment was within the specified number of hours. For example, if the last failed payment was at 1PM and the retry interval is 4 hours, then a payment run at 2PM will not attempt a payment, but a payment run at 6PM will.

If you want to retry once a day, Zuora recommends that you enter 22 or 23 hours, because it is possible for a payment to be attempted at the end of the payment run on one day and the beginning of the payment run the next day.

This field is required if UseDefaultRetryRule is set to false.

6

maxConsecutivePaymentFailures

Specifies the number of allowable consecutive failures Zuora will make with the payment method before stopping.

6

Credit Card Type Fields

Field Name (case sensitive)

Possible Values

Max Len

creditCardType

param_supportedTypes

Visa, MasterCard, AmericanExpress, Discover

20

creditCardNumber

string

16

creditCardExpirationMonth

integer

2

creditCardExpirationYear

integer

4

creditCardSecurityCode

string

4

creditCardHolderName

string

50

creditCardCountry

3-digit ISO code

32

creditCardAddress1

string

255

creditCardAddress2

string

255

creditCardCity

string

40

creditCardState

string

50

creditCardPostalCode

string

20

phone

string

40

email

string

80

  1.  
Was this article helpful?
Pages that link here
Page statistics
425 view(s), 12 edit(s) and 6256 character(s)

Tags

This page has no custom tags set.

Comments

You must to post a comment.

Attach file

Attachments