---
title: "Create a payment method"
method: POST
path: "/v1/payment-methods"
tags: ["Payment Methods"]
---

# Create a payment method

`POST /v1/payment-methods`

You can use this operation to create either a payment method associated 
with a specific customer account, or an orphan payment method that is not associated
with any customer account.

To view the applicable fields for each payment method type, select the payment method type from the `type` list.
The following types of the payment methods are supported:

  * `CreditCard` - Credit card payment method.

  * `CreditCardReferenceTransaction` - Credit Card Reference
  Transaction. See [Supported payment
  methods](https://docs.zuora.com?resourceId=payments-supported-payment-methods)
  for payment gateways that support this type of payment method.

  * `ACH` - ACH payment method.

  * `SEPA` - Single Euro Payments Area.

  * `Betalingsservice` - Direct Debit DK.

  * `Autogiro` - Direct Debit SE.

  * `Bacs` - Direct Debit UK.

  * `Becs` - Direct Entry AU.

  * `Becsnz` - Direct Debit NZ.

  * `PAD` - Pre-Authorized Debit.

  * `PayPalCP` - PayPal Commerce Platform payment method. Use this type
  if you are using a [PayPal Commerce Platform
  Gateway](https://docs.zuora.com?resourceId=payments-paypal-complete-payments-gateway-integration)
  instance.

  * `PayPalEC` - PayPal Express Checkout payment method. Use this type
  if you are using a [PayPal Payflow Pro
  Gateway](https://docs.zuora.com?resourceId=payments-paypal-payflow-pro)
  instance.

  * `PayPalNativeEC` - PayPal Native Express Checkout payment method.
  Use this type if you are using a [PayPal Express Checkout
  Gateway](https://docs.zuora.com?resourceId=payments-paypal-express-checkout-gateway)
  instance.

  * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if
  you are using a [PayPal Adaptive Payment
  Gateway](https://docs.zuora.com?resourceId=payments-paypal-adaptive-payments-gateway)
  instance.

  * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up
  Adyen Apple
  Pay](https://docs.zuora.com?resourceId=payments-create-apply-pay-using-api)
  for details.

  * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up
  Adyen Google
  Pay](https://docs.zuora.com?resourceId=payments-setup-adyen-googlepay-using-api)
  for details.

  * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway
  integration. See [Set up Google Pay on
  Chase](https://docs.zuora.com?resourceId=payments-setup-chase-googlepay-using-api)
  for details. 

 * `AmazonPay` - Amazon Pay integration. 

The fields marked as `required` must be specified when creating non-tokenized payment methods. 
For more information about the required fields for the tokenization of payment methods, see <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">Create tokenized payment methods with existing tokens or account information</a>.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- union — Payment method information associated with an account.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `cardHolderInfo` CreatePaymentMethodCardholderInfo, required — Container for cardholder information. The nested `cardHolderName` field is required.
      - `addressLine1` string — First address line, 255 characters or less.
      - `addressLine2` string — Second address line, 255 characters or less.
      - `cardHolderName` string, required — The card holder's full name as it appears on the card, e.g., "John J Smith", 50 characters or less. The value must consist only of US-ASCII characters and must not include special characters.
      - `city` string — City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — Country, must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `email` string — Card holder's email address, 80 characters or less.
      - `phone` string — Phone number, 40 characters or less.
      - `state` string — State; must be a valid subregion (state or province) name or code. For more information, see <a href="https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region" target="_blank">View subregions of a specific country or region</a>.
      - `zipCode` string — Zip code, 20 characters or less.
    - `cardMaskNumber` string — The masked card number. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `cardNumber` string, required — Credit card number.
    - `cardType` string, required — The type of the credit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see <a href="https://docs.zuora.com?resourceId=payments-supported-payment-gateways" target="_blank">Supported Payment Gateways</a>.
    - `checkDuplicated` boolean — Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`. With this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found. The following fields are used for the duplication check: - `cardHolderName` - `expirationMonth` - `expirationYear` - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example, `************1234`. **This field is being deprecated.** To achieve the same purpose, use the `processingOptions` > `checkDuplicated` field of the payment method object.
    - `expirationMonth` integer, required — One or two digit expiration month (1-12) of the credit card.
    - `expirationYear` integer, required — Four-digit expiration year of the credit card.
    - `identityNumber` string — The identity number of the cardholder. This field is required for Credit Card payment methods in certain countries such as Brazil.
    - `mitConsentAgreementRef` string — Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.
    - `mitConsentAgreementSrc` 'External' — Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
    - `mitNetworkTransactionId` string — Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.
    - `mitProfileAction` 'Activate' | 'Persist' — Specifies how Zuora creates and activates the stored credential profile. - `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.
    - `mitProfileAgreedOn` string, date — The date on which the profile is agreed. The date format is `yyyy-mm-dd`.
    - `mitProfileType` 'Recurring' | 'Unscheduled' — Required if you set the `mitProfileAction` field. Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
    - `screeningAmount` number — For <a href="https://docs.zuora.com?resourceId=payments-chase-orbital-gateway-integration" target="_blank">Chase Paymentech Orbital Gateway</a> integrations, if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions. Two-decimal amount is supported. If the `screeningAmount` field is not specified, the authorization amount is used for fraud screening.
    - `securityCode` string — CVV or CVV2 security code of the credit card. To ensure PCI compliance, this value is not stored and cannot be queried.
    - `tokens` object — To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
      - `gatewayType` string, required — The type of the payment gateway to generate the tokens. This field is case-sensitive.
      - `secondTokenId` string — Pass in the second token of the payment method.
      - `thirdTokenId` string — Pass in the third token of the payment method.
      - `tokenId` string, required — Pass in the first token of the payment method.
    - `tokenize` boolean — Specify `true` to tokenize the payment method with the card information. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `creditCardMaskNumber` string — The masked credit card number, such as `*********1112`. This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods. Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.
    - `secondTokenId` string — A gateway unique identifier that replaces sensitive payment method data. `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method.
    - `tokenId` string, required — A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method. The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `addressLine1` string — First address line, 255 characters or less.
    - `addressLine2` string — Second address line, 255 characters or less.
    - `bankABACode` string, required — The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.
    - `bankAccountMaskNumber` string — The masked account number such as ****1234. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `bankAccountName` string, required — The name of the account holder, which can be either a person or a company. For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://docs.zuora.com?resourceId=payments-bluesnap-payment-gateway-integration) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields.
    - `bankAccountNumber` string, required — The bank account number associated with the ACH payment. For the creation of tokenized ACH payment methods, this field is optional. Currently, ACH tokenization is supported on selected payment gateway integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `bankAccountType` 'BusinessChecking' | 'Checking' | 'Saving', required — The type of bank account associated with the ACH payment. When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.
    - `bankName` string, required — The name of the bank where the ACH payment account is held. When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.
    - `city` string — City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
    - `country` string — Country, must be a valid country name or abbreviation. See <a href="https://docs.zuora.com?resourceId=view-countries-or-regions" target="_blank">View countries or regions</a> for the list of supported country names and abbreviations. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
    - `phone` string — Phone number, 40 characters or less.
    - `state` string — State, must be a valid subregion (state or province) name or code. For more information, see <a href="https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region" target="_blank">View subregions of a specific country or region</a>.
    - `zipCode` string — Zip code, 20 characters or less.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `tokens` object — To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
      - `gatewayType` string, required — The type of the payment gateway to generate the tokens. This field is case-sensitive.
      - `secondTokenId` string — Pass in the second token of the payment method.
      - `thirdTokenId` string — Pass in the third token of the payment method.
      - `tokenId` string, required — Pass in the first token of the payment method.
    - `tokenize` boolean — Specify `true` to tokenize the payment method with the account information. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `IBAN` string, required — The International Bank Account Number. This field is required if the `type` field is set to `SEPA`. However, for the creation of tokenized SEPA payment methods, this field is optional. Currently, SEPA tokenization is supported on selected payment gateway integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `accountHolderInfo` object, required — The container for the account holder information. The nested `accountHolderName` field is required. However, for the creation of tokenized SEPA payment methods, this field is optional. Currently, SEPA tokenization is supported on selected payment gateway integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
      - `accountHolderName` string, required — The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder. This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays. This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountMaskNumber` string — The masked account number such as ****1234. When creating tokenized SEPA payment methods, this `accountMaskNumber` field is required if the `tokens` field is provided. Currently, SEPA tokenization is supported on selected payment gateway integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `businessIdentificationCode` string — The BIC code used for SEPA.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `tokenize` boolean — When creating a SEPA payment method on Adyen Integration v2.0, use this field to specify whether to tokenize the payment method with IBAN. If `tokenize` is `true`, `IBAN` is required. If the `tokens` field is provided, this `tokenize` field is not required. For more information about how to create tokenized SEPA payment methods on Adyen, see <a href="https://docs.zuora.com?resourceId=payments-tokenize-payment-methods-on-adyen" target="_blank">Tokenize SEPA payment methods on Adyen Integration v2.0</a>.
    - `tokens` object — To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, SEPA tokenization is supported on selected payment gateway integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
      - `gatewayType` 'Adyen' | 'Stripe', required — The type of the payment gateway to generate the tokens. This field is case-sensitive.
      - `secondTokenId` string — Pass in the second token of the payment method.
      - `thirdTokenId` string — Pass in the third token of the payment method.
      - `tokenId` string, required — Pass in the first token of the payment method.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `accountHolderInfo` object, required — The container for the account holder information. The nested `accountHolderName` field is required.
      - `accountHolderName` string — Required. The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder.
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays.
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountNumber` string, required — The number of the customer's bank account.
    - `accountMaskNumber` string — The masked account number such as ****1234.
    - `bankCode` string, required — The sort code or number that identifies the bank. This is also known as the sort code.
    - `identityNumber` string, required — The identity number used for Bank Transfer.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `accountHolderInfo` object, required — The container for the account holder information. The nested `accountHolderName` field is required.
      - `accountHolderName` string — Required. The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder.
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays.
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountNumber` string, required — The number of the customer's bank account.
    - `accountMaskNumber` string — The masked account number such as ****1234.
    - `branchCode` string, required — The branch code of the bank used for direct debit.
    - `identityNumber` string, required — The identity number used for Bank Transfer.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `accountHolderInfo` object, required — The container for the account holder information. The nested `accountHolderName` field is required.
      - `accountHolderName` string — Required. The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder.
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays.
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountNumber` string, required — The number of the customer's bank account.
    - `accountMaskNumber` string — The masked account number such as ****1234. When creating BACS payment methods on Stripe, if the `tokens` field is provided, this `accountMaskNumber` field is required. For more information, see <a href="https://docs.zuora.com?resourceId=payments-stripe-gateway-integration" target="_blank">Overview of Stripe payment gateway integration</a>.
    - `bankCode` string, required — The sort code or number that identifies the bank. This is also known as the sort code.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `tokenize` boolean — When creating a BACS payment method on Adyen v2.0, set this field to `true` to support processing BACS recurring payments. For more information about other requirements for processing BACS recurring payments, see <a href="https://docs.zuora.com?resourceId=payments-direct-debit-uk-bacs-for-adyen" target="_blank">Overview of Adyen Integration v2.0</a>.
    - `tokens` object — To create tokenized BACS payment methods on Stripe v2, pass in the existing token information through the fields in this container. For more information, see <a href="https://docs.zuora.com?resourceId=payments-stripe-gateway-integration" target="_blank">Overview of Stripe payment gateway integration</a>.
      - `gatewayType` 'Stripe' — Required. The type of the payment gateway to generate the tokens. This field is case-sensitive.
      - `secondTokenId` string — Pass in the second token of the payment method. For more information, see <a href="https://docs.zuora.com?resourceId=payments-stripe-gateway-integration" target="_blank">Overview of Stripe payment gateway integration</a>.
      - `thirdTokenId` string — Pass in the third token of the payment method.
      - `tokenId` string — Required. Pass in the first token of the payment method. For more information, see <a href="https://docs.zuora.com?resourceId=payments-stripe-gateway-integration" target="_blank">Overview of Stripe payment gateway integration</a>.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `accountHolderInfo` object — The container for the account holder information. The nested `accountHolderName` field is required.
      - `accountHolderName` string — Required. The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder.
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays.
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountNumber` string, required — The number of the customer's bank account.
    - `accountMaskNumber` string — The masked account number such as ****1234.
    - `branchCode` string, required — The branch code of the bank used for direct debit.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `accountHolderInfo` object, required — The container for the account holder information. The nested `accountHolderName` field is required.
      - `accountHolderName` string — Required. The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder.
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays.
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountNumber` string, required — The number of the customer's bank account.
    - `accountMaskNumber` string — The masked account number such as ****1234.
    - `branchCode` string, required — The branch code of the bank used for direct debit.
    - `bankCode` string, required — The sort code or number that identifies the bank. This is also known as the sort code.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `accountHolderInfo` object, required — The container for the account holder information. The nested `accountHolderName` field is required.
      - `accountHolderName` string — Required. The full name of the bank account holder.
      - `addressLine1` string — The first line of the address for the account holder.
      - `addressLine2` string — The second line of the address for the account holder.
      - `city` string — The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
      - `country` string — The country where the account holder stays.
      - `email` string — The email address of the account holder.
      - `firstName` string — The first name of the account holder.
      - `lastName` string — The last name of the account holder.
      - `phone` string — The phone number of the account holder.
      - `state` string — The state where the account holder stays.
      - `zipCode` string — The zip code for the address of the account holder.
    - `accountNumber` string, required — The number of the customer's bank account.
    - `accountMaskNumber` string — The masked account number such as ****1234.
    - `branchCode` string, required — The branch code of the bank used for direct debit.
    - `bankCode` string, required — The sort code or number that identifies the bank. This is also known as the sort code.
    - `mandateInfo` object — The container of the mandate information for the payment method.
      - `mandateId` string — The mandate ID.
      - `mandateReason` string — The reason of the mandate from the gateway side.
      - `mandateStatus` string — The status of the mandate from the gateway side.
    - `processingOptions` object — The container for payment method processing options.
      - `checkDuplicated` boolean — Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see <a href="https://docs.zuora.com?resourceId=payments-duplication-check" target="_blank">Duplication check on payment methods</a>.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `BAID` string, required — ID of a PayPal billing agreement. example: I-1TJ3GAGG82Y9
    - `email` string — Email address associated with the payment method.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `BAID` string, required — ID of a PayPal billing agreement.
    - `email` string, required — Email address associated with the payment method.
    - `tokens` object — To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
      - `gatewayType` string, required — The type of the payment gateway to generate the tokens. This field is case-sensitive.
      - `secondTokenId` string — Pass in the second token of the payment method.
      - `thirdTokenId` string — Pass in the third token of the payment method.
      - `tokenId` string, required — Pass in the first token of the payment method.
    - `tokenize` boolean — Specify `true` to tokenize the payment method. Currently, this field is only supported on certain integrations. See <a href="https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods" target="_blank">this article</a> for more information.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `BAID` string, required — ID of a PayPal billing agreement.
    - `email` string, required — Email address associated with the payment method.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object — Container for custom fields of a payment method object.
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `preapprovalKey` string, required — The PayPal preapproval key.
    - `email` string, email, required — Email address associated with the payment method.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `applePaymentData` string, required — This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://docs.zuora.com?resourceId=payments-create-apply-pay-using-api).
    - `email` string, email — Email address associated with the payment method. This field is specific for setting up Apple Pay on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `googlePaymentToken` string, required — This field is specific for setting up Google Pay on Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Google Pay on Chase](https://docs.zuora.com?resourceId=payments-setup-chase-googlepay-using-api).
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.
  - object
    - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' | 'AmazonPay', required — Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.
    - `amazonPayToken` string, required — This field is specific for setting up Amazon Pay gateway integrations to specify the stringified Amazon Pay token.
    - `accountKey` string — The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation.
    - `authGateway` string — Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment.
    - `currencyCode` string — The currency used for payment method authorization.
    - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
      - `key` string — The name of a gateway-specific parameter.
      - `value` string — The value of the gateway-specific parameter.
    - `ipAddress` string — The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
    - `makeDefault` boolean — Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway.
    - `skipValidation` boolean — Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation.

## Response `200`

OK

- POSTPaymentMethodResponse
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — Error code.
    - `message` string — Error message.
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.
  - `id` string — Internal ID of the payment method that was created.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)