Apple Payment Data*

string

required

This field is used to configure Apple Pay for Adyen. It should contain a stringified payload with the Apple Pay token or Apple payment data. For more information, see Set up Adyen Apple Pay.

Account Key

string

optional

The customer account ID (for example, 2x92c0f859b0480f0159d3a4a6ee5bb6) or customer account number (for example, A02855638).

To create an orphan payment method that is not associated with any customer account, you can omit this field. Once the account information becomes available, associate the payment method with a customer account using the Update a payment method operation.

Auth Gateway

string

optional

The internal ID of the payment gateway Zuora uses to authorize payments for this payment method.

If not specified, Zuora uses the default payment gateway of the associated customer account if the accountKey field is set, or the tenant's default payment gateway if the accountKey field is not set.

Currency Code

string

optional

The currency used for payment method authorization.

Email

string <email>

optional

The email address associated with the payment method. This field is used when setting up Apple Pay with Adyen v2.0 and is passed to Adyen as shopperEmail.

IP Address

string

optional

The IP address IPv4 or IPv6 of the user at the time the payment method is created or updated. Some gateways use this information for fraud prevention, and Zuora forwards it directly to them. The IP address must not exceed 45 characters, or a validation error will occur. For SEPA payment method validation on Stripe v2, this field is mandatory.

Skip Validation

boolean

optional

Default: false

Specifies whether to skip validation through the payment gateway. For example, set this field to true when migrating payment methods to bypass validation.

makeDefault

boolean

optional

Default: false

Specifies whether this payment method should be set as the default for the customer account that owns it. This applies only when the accountKey field is provided.

If set to true, ensure the payment method is supported by the default payment gateway.

Type*

string

required

Specifies the type of payment method. To view the schema and examples for a specific payment method type, select the corresponding value from the supported list.

Enum:CreditCard, CreditCardReferenceTransaction, ACH, SEPA, Betalingsservice, Autogiro, Bacs, Becs, Becsnz, PAD, PayPalCP, PayPalEC, PayPalNativeEC, PayPalAdaptive, AdyenApplePay, AdyenGooglePay, GooglePay, and AmazonPay.