| account_id |
String |
The ID of the customer account associated with this payment method. |
[optional] |
| ach_aba_code |
String |
The nine-digit routing number or ABA number used by banks. Applicable to ACH payment methods. |
[optional] |
| ach_account_name |
String |
The name of the account holder, which can be either a person or a company. Applicable to ACH payment methods. |
[optional] |
| ach_account_number_mask |
String |
This is a masked displayable version of the ACH account number, used for security purposes. For example: `XXXXXXXXX54321`. |
[optional] |
| ach_account_type |
String |
The type of bank account associated with the ACH payment. |
[optional] |
| ach_bank_name |
String |
The name of the bank where the ACH payment account is held. |
[optional] |
| bank_branch_code |
String |
The branch code of the bank used for direct debit. |
[optional] |
| bank_check_digit |
String |
The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods. |
[optional] |
| bank_city |
String |
The city of the direct debit bank. |
[optional] |
| bank_code |
String |
The sort code or number that identifies the bank. This is also known as the sort code. |
[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. |
[optional] |
| bank_name |
String |
The name of the direct debit bank. |
[optional] |
| bank_postal_code |
String |
The zip code or postal code of the direct debit bank. |
[optional] |
| bank_street_name |
String |
The name of the street of the direct debit bank. |
[optional] |
| bank_street_number |
String |
The number of the direct debit bank. |
[optional] |
| bank_transfer_account_name |
String |
The name on the direct debit bank account. |
[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`. |
[optional] |
| bank_transfer_account_type |
String |
The type of the customer's bank account. Applicable to direct debit payment methods. |
[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. Possible 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. Only applicable to direct debit payments in Switzerland with Global Collect. |
[optional] |
| city |
String |
The city of the customer's address. Applicable to debit payment methods. |
[optional] |
| country |
String |
The two-letter country code of the customer's address. Applicable to direct debit payment methods. |
[optional] |
| credit_card_address1 |
String |
The first line of the card holder's address, which is often a street address or business name. Applicable to credit card and direct debit payment methods. |
[optional] |
| credit_card_address2 |
String |
The second line of the card holder's address. Applicable to credit card and direct debit payment methods. |
[optional] |
| credit_card_city |
String |
The city of the card holder's address. Applicable to credit card and direct debit payment methods. |
[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. Applicable to credit card and direct debit payment methods. |
[optional] |
| credit_card_expiration_year |
Integer |
The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods. |
[optional] |
| credit_card_holder_name |
String |
The full name of the card holder. Applicable to credit card and direct debit payment methods. |
[optional] |
| credit_card_mask_number |
String |
A masked version of the credit or debit card number. |
[optional] |
| credit_card_postal_code |
String |
The billing address's zip code. |
[optional] |
| credit_card_state |
String |
The billing address's state. Applicable if `CreditCardCountry` is either Canada or the US. |
[optional] |
| credit_card_type |
String |
The type of credit card or debit card. |
[optional] |
| device_session_id |
String |
The session ID of the user when the `PaymentMethod` was created or updated. |
[optional] |
| email |
String |
An email address for the payment method in addition to the bill to contact email address. |
[optional] |
| existing_mandate |
String |
Indicates if the customer has an existing mandate or a new mandate. Only applicable to direct debit payment methods. |
[optional] |
| first_name |
String |
The customer's first name. Only applicable to direct debit payment methods. |
[optional] |
| iban |
String |
The International Bank Account Number. Only applicable to direct debit payment methods. |
[optional] |
| ip_address |
String |
The IP address of the user when the payment method was created or updated. |
[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. |
[optional] |
| last_name |
String |
The customer's last name. Only applicable to direct debit payment methods. |
[optional] |
| last_transaction_date_time |
DateTime |
The date of the most recent transaction. |
[optional] |
| last_transaction_status |
String |
The status of the most recent transaction. |
[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. Only applicable to direct debit payment methods. |
[optional] |
| mandate_id |
String |
The ID of the mandate. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods. |
[optional] |
| mandate_received |
String |
Indicates if the mandate was received. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods. |
[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. Only applicable to direct debit payment methods. |
[optional] |
| max_consecutive_payment_failures |
Integer |
The number of allowable consecutive failures Zuora attempts with the payment method before stopping. |
[optional] |
| name |
String |
The name of the payment method. |
[optional] |
| num_consecutive_failures |
Integer |
The number of consecutive failed payment for the payment method. |
[optional] |
| payment_method_id |
String |
Object identifier of the payment method. |
[optional] |
| payment_method_status |
String |
Specifies the status of the payment method. |
[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. |
[optional] |
| paypal_baid |
String |
The PayPal billing agreement ID, which is a contract between two PayPal accounts. |
[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. |
[optional] |
| paypal_preapproval_key |
String |
PayPal's Adaptive Payments API key. |
[optional] |
| paypal_type |
String |
Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments. |
[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. |
[optional] |
| postal_code |
String |
The zip code of the customer's address. Only applicable to direct debit payment methods. |
[optional] |
| second_token_id |
String |
A gateway unique identifier that replaces sensitive payment method data. Applicable to CC Reference Transaction payment methods. |
[optional] |
| state |
String |
The state of the customer's address. Only applicable to direct debit payment methods. |
[optional] |
| street_name |
String |
The street name of the customer's address. Only applicable to direct debit payment methods. |
[optional] |
| street_number |
String |
The street number of the customer's address. Only applicable to direct debit payment methods. |
[optional] |
| token_id |
String |
A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. Applicable to CC Reference Transaction payment methods. |
[optional] |
| total_number_of_error_payments |
Integer |
The number of error payments that used this payment method. |
[optional] |
| total_number_of_processed_payments |
Integer |
The number of successful payments that used this payment method. |
[optional] |
| type |
String |
The type of payment method. |
[optional] |
| use_default_retry_rule |
BOOLEAN |
Determines whether to use the default retry rules configured in the Zuora Payments settings. |
[optional] |