| account_id |
String |
The ID of the customer account associated with this payment method. This field is not required for the account ID. |
[optional] |
| ach_aba_code |
String |
The nine-digit routing number or ABA number used by banks. Use this field for ACH payment methods. Character limit: 9 Values: a string of 9 characters or fewer |
[optional] |
| ach_account_name |
String |
The name of the account holder, which can be either a person or a company. Use this field for ACH payment methods. Character limit: 70 Values: a string of 70 characters or fewer |
[optional] |
| ach_account_number_mask |
String |
This is a masked displayable version of the ACH account number, used for security purposes. For example: `XXXXXXXXX54321`. Use this field for ACH payment methods. Character limit: 32 Values: automatically generated |
[optional] |
| ach_account_type |
String |
The type of bank account associated with the ACH payment. Use this field for ACH payment methods. Character limit: 16 Values: - `BusinessChecking` - `Checking` - `Saving` |
[optional] |
| ach_address1 |
String |
Line 1 for the ACH address. Required on create for the Vantiv payment gateway. Optional for other gateways. Character limit: Values: an address |
[optional] |
| ach_address2 |
String |
Line 2 for the ACH address. Required on create for the Vantiv payment gateway. Optional for other gateways. Character limit: Values: an address |
[optional] |
| ach_bank_name |
String |
The name of the bank where the ACH payment account is held. Use this field for ACH payment methods. Character limit: 70 Values: a string of 70 characters or fewer |
[optional] |
| active |
BOOLEAN |
Specifies whether a payment method is available in Zuora. The default value is `false`. Character limit: 5 Values: `true`, `false` |
[optional] |
| bank_branch_code |
String |
The branch code of the bank used for direct debit. Use this field for direct debit payment methods. Character limit: 10 Values: string of 10 characters or fewer |
[optional] |
| bank_check_digit |
String |
The check digit in the international bank account number, which confirms the validity of the account. Use this field for direct debit payment methods. Character limit: 4 Values: string of 4 characters or fewer |
[optional] |
| bank_city |
String |
The city of the direct debit bank. Use this field for direct debit payment methods. Character limit:70 Values: string of 70 characters or fewer |
[optional] |
| bank_code |
String |
The sort code or number that identifies the bank. This is also known as the sort code. This field is required for direct debit payment methods. Character limit: 18 Values: string of 18 characters or fewer |
[optional] |
| bank_identification_number |
String |
The first six digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. Character limit: 6 Values: string of 6 characters or fewer |
[optional] |
| bank_name |
String |
The name of the direct debit bank. Use this field for direct debit payment methods. Character limit:80 Values: string of 80 characters or fewer |
[optional] |
| bank_postal_code |
String |
The zip code or postal code of the direct debit bank. Use this field for direct debit payment methods. Character limit:20 Values: string of 20 characters or fewer |
[optional] |
| bank_street_name |
String |
The name of the street of the direct debit bank. Use this field for direct debit payment methods. Character limit:60 Values: string of 60 characters or fewer |
[optional] |
| bank_street_number |
String |
The number of the direct debit bank. Use this field for direct debit payment methods. Character limit:10 Values: string of 10 characters or fewer |
[optional] |
| bank_transfer_account_name |
String |
The name on the direct debit bank account. Use this field for direct debit payment methods. Character limit: 60 Values: string of 60 characters or fewer |
[optional] |
| bank_transfer_account_number_mask |
String |
This is a masked displayable version of the bank account number, used for security purposes. For example: `XXXXXXXXX54321`. Character limit: 32 Values: automatically generated |
[optional] |
| bank_transfer_account_type |
String |
The type of the customer's bank account. Use this field for direct debit payment methods. Character limit: 11 Values: `DirectDebit` |
[optional] |
| bank_transfer_type |
String |
Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user. Use this field is used for direct debit payment methods. Character limit: 20 Values: - `AutomatischIncasso` (NL) - `LastschriftDE` (Germany) - `LastschriftAT` (Austria) - `DemandeDePrelevement` (FR) - `DirectDebitUK` (UK) - `Domicil` (Belgium) - `LastschriftCH` (CH) - `RID` (Italy) - `OrdenDeDomiciliacion` (Spain) |
[optional] |
| business_identification_code |
String |
The business identification code for Swiss direct payment methods that use the Global Collect payment gateway. Use this field only for direct debit payments in Switzerland with Global Collect. Character limit: 11 Values: string of 11 characters or fewer |
[optional] |
| city |
String |
The city of the customer's address. Use this field for direct debit payment methods. Character limit:80 Values: string of 80 characters or fewer |
[optional] |
| country |
String |
The two-letter country code of the customer's address. Use this field for direct debit payment methods. Character limit: 2 Values: a valid country code |
[optional] |
| created_by_id |
String |
The user ID of the person who created the `PaymentMethod` object when there is a login user in the user session. In Hosted Payment Method and Zuora Checkout pages, this field is set to 3 as there is no login user to initiate a user session. Character limit: 32 Values: automatically generated |
[optional] |
| created_date |
DateTime |
The date when the `PaymentMethod` object was created in the Zuora system. Character limit: 29 Values: automatically generated |
[optional] |
| credit_card_address1 |
String |
The first line of the card holder's address, which is often a street address or business name. Use this field for credit card and direct debit payment methods. Character limit: 255 Values: a string of 255 characters or fewer |
[optional] |
| credit_card_address2 |
String |
The second line of the card holder's address. Use this field for credit card and direct debit payment methods. Character limit: 255 Values: a string of 255 characters or fewer |
[optional] |
| credit_card_city |
String |
The city of the card holder's address. Use this field for credit card and direct debit payment methods Character limit: 40 Values: a string of 40 characters or fewer |
[optional] |
| credit_card_country |
String |
The country of the card holder's address. |
[optional] |
| credit_card_expiration_month |
Integer |
The expiration month of the credit card or debit card. Use this field for credit card and direct debit payment methods. Character limit: 2 Values: a two-digit number, 01 - 12 |
[optional] |
| credit_card_expiration_year |
Integer |
The expiration month of the credit card or debit card. Use this field for credit card and direct debit payment methods. Character limit: 4 Values: a four-digit number |
[optional] |
| credit_card_holder_name |
String |
The full name of the card holder. Use this field for credit card and direct debit payment methods. Character limit: 50 Values: a string of 50 characters or fewer |
[optional] |
| credit_card_mask_number |
String |
A masked version of the credit or debit card number. Character limit: 32 Values: automatically generated |
[optional] |
| credit_card_postal_code |
String |
The billing address's zip code. This field is required only when you define a debit card or credit card payment. Character limit: 20 Values: a string of 20 characters or fewer |
[optional] |
| credit_card_state |
String |
The billing address's state. Use this field is if the `CreditCardCountry` value is either Canada or the US. State names must be spelled in full. |
[optional] |
| credit_card_type |
String |
The type of credit card or debit card. This field is required only when you define a debit card or credit card payment. Character limit: 32 Values: `AmericanExpress`, `Discover`, `MasterCard`, `Visa` |
[optional] |
| device_session_id |
String |
The session ID of the user when the `PaymentMethod` was created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, then Zuora passes this field to supported gateways. Currently only Verifi supports this field. Character limit: 255 Values: |
[optional] |
| email |
String |
An email address for the payment method in addition to the bill to contact email address. Character limit: 80 Values: a string of 80 characters or fewer |
[optional] |
| existing_mandate |
String |
Indicates if the customer has an existing mandate or a new mandate. A mandate is a signed authorization for UK and NL customers. When you are migrating mandates from another system, be sure to set this field correctly. If you indicate that a new mandate is an existing mandate or vice-versa, then transactions fail. This field is used only for the direct debit payment method. Character limit: 3 Values: `Yes`, `No` |
[optional] |
| first_name |
String |
The customer's first name. This field is used only for the direct debit payment method. Character limit: 30 Values: a string of 30 characters or fewer |
[optional] |
| iban |
String |
The International Bank Account Number. This field is used only for the direct debit payment method. Character limit: 42 Values: a string of 42 characters or fewer |
[optional] |
| ip_address |
String |
The IP address of the user when the payment method was created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, then Zuora passes this field to supported gateways. Currently PayPal, CyberSource, Authorize.Net, and Verifi support this field. Character limit: 15 Values: a string of 15 characters or fewer |
[optional] |
| id |
String |
Object identifier. |
[optional] |
| last_failed_sale_transaction_date |
DateTime |
The date of the last failed attempt to collect payment with this payment method. Character limit: 29 Values: automatically generated |
[optional] |
| last_name |
String |
The customer's last name. This field is used only for the direct debit payment method. Character limit: 70 Values: a string of 70 characters or fewer |
[optional] |
| last_transaction_date_time |
DateTime |
The date of the most recent transaction. Character limit: 29 Values: a valid date and time value |
[optional] |
| last_transaction_status |
String |
The status of the most recent transaction. Character limit: 39 Values: automatically generated |
[optional] |
| mandate_creation_date |
Date |
The date when the mandate was created, in `yyyy-mm-dd` format. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method. Character limit: 29 |
[optional] |
| mandate_id |
String |
The ID of the mandate. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method. Character limit: 36 Values: a string of 36 characters or fewer |
[optional] |
| mandate_received |
String |
Indicates if the mandate was received. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method. Character limit: 3 Values: `Yes`, `No `(case-sensitive) |
[optional] |
| mandate_update_date |
Date |
The date when the mandate was last updated, in `yyyy-mm-dd` format. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method. Character limit: 29 |
[optional] |
| max_consecutive_payment_failures |
Integer |
Specifies the number of allowable consecutive failures Zuora attempts with the payment method before stopping. Values: a valid number |
[optional] |
| name |
String |
The name of the payment method. |
[optional] |
| num_consecutive_failures |
Integer |
The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. |
[optional] |
| payment_method_status |
String |
Specifies the status of the payment method. It is set to Active on creation. Character limit: 6 Values: `Active` or `Closed` |
[optional] |
| payment_retry_window |
Integer |
The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours. This field is required if the `UseDefaultRetryRule` field value is set to `false`. Character limit: 4 Values: a whole number between 1 and 1000, exclusive |
[optional] |
| paypal_baid |
String |
The PayPal billing agreement ID, which is a contract between two PayPal accounts. Typically, the selling party initiates a request to create a BAID, and sends it to buying party for acceptance. The seller can keep track of the BAID and use it for future charges against the buyer. This field is required when defining a PayPal payment method. Character limit: 64 Values: a string of 64 characters or fewer |
[optional] |
| paypal_email |
String |
The email address associated with the account holder's PayPal account or of the PayPal account of the person paying for the service. This field is required only when you define a PayPal payment method. Character limit: 80 Values: a string of 80 characters or fewer |
[optional] |
| paypal_preapproval_key |
String |
PayPal's Adaptive Payments API key. Zuora does not create this key, nor does it call PayPal to generate it. You must use PayPal's Adaptive Payments' API to generate this key, and then pass it to Zuora. Zuora uses this key to authorize future payments to PayPal's Adaptive Payments API. This field is required when you use PayPal Adaptive Payments gateway. Character limit: 32 Values: a valid PayPal Adaptive Payment pre-approval key |
[optional] |
| paypal_type |
String |
Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments. This field is required when you use PayPal Adaptive Payments or Payflow Pro (Express Checkout) gateways. Character limit: 32 Values: `ExpressCheckout`, `AdaptivePayments` |
[optional] |
| phone |
String |
The phone number that the account holder registered with the bank. This field is used for credit card validation when passing to a gateway. Character limit: 40 Values: a string of 40 characters or fewer |
[optional] |
| postal_code |
String |
The zip code of the customer's address. This field is used only for the direct debit payment method. Character limit: 20 Values: a string of 20 characters or fewer |
[optional] |
| second_token_id |
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. Character limit: 64 Values: a string of 64 characters or fewer |
[optional] |
| state |
String |
The state of the customer's address. This field is used only for the direct debit payment method. Character limit: 70 Values: a string of 70 characters or fewer |
[optional] |
| street_name |
String |
The street name of the customer's address. This field is used only for the direct debit payment method. Character limit: 100 Values: a string of 100 characters or fewer |
[optional] |
| street_number |
String |
The street number of the customer's address. This field is used only for the direct debit payment method. Character limit: 30 Values: a string of 30 characters or fewer |
[optional] |
| token_id |
String |
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, then SecondTokenId is conditionally required for representing the underlying tokenized payment method. TokenId is required for the CC Reference Transaction payment method. Character limit: 255 Values: a string of 255 characters or fewer |
[optional] |
| total_number_of_error_payments |
Integer |
The number of error payments that used this payment method. Character limit: Values: automatically generated |
[optional] |
| total_number_of_processed_payments |
Integer |
The number of successful payments that used this payment method. Character limit: Values: automatically generated |
[optional] |
| type |
String |
The type of payment method. |
[optional] |
| updated_by_id |
String |
The ID of the user who last updated the payment method. Character limit: 32 Values: automatically generated |
[optional] |
| updated_date |
DateTime |
The date when the payment method was last updated. Character limit: 29 Values: automatically generated |
[optional] |
| use_default_retry_rule |
BOOLEAN |
Determines whether to use the default retry rules configured in the Zuora Payments settings. Set this to `true` to use the default retry rules. Set this to `false` to set the specific rules for this payment method. If you set this value to `false`, then the fields, `PaymentRetryWindow` and `MaxConsecutivePaymentFailures`, are required. Character limit: 5 Values: `t``rue`, `false` |
[optional] |