Open topic with navigation

You are here: API Reference > Objects > PaymentMethod

PaymentMethod

PaymentMethod contains information on how the contact pays for the account. In order to activate an account, you need to create a payment method.

Supported Calls

This object is used in the create, query, update, and delete calls.

Fields

In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.

Name Required? Type Allowable Values Description
AccountId No for the subscribe call; Yes otherwise zns: ID A valid account ID This is the Zuora system account ID of the contact with whom this payment method is associated.
AchAbaCode Yes when defining an ACH payment method; No otherwise string Always nine digits only This is the nine-digit routing number or ABA number used by banks.
AchAccountName Yes when defining an ACH payment method; No otherwise string 50 characters This is the name of the account holder (a person or a company).
AchAccountNumber Yes when defining an ACH payment method; No otherwise string 50 characters, numbers and hyphens only This is the bank account number to be used with the ACH payment.
AchAccountNumberMask Yes when defining an ACH payment method; No otherwise string See Description This is a mask to help hide the account number; for example, XXXXXXXXX54321.
AchAccountType Yes when defining an ACH payment method; No otherwise string Checking, Savings This is the type of bank account the ACH payment is coming from.
AchBankName Yes when defining an ACH payment method; No otherwise string 50 characters This is the name of the bank where the ACH payment account is held.
Active No boolean Yes or No (1 or 0) Specifies whether you want the payment method to be an active payment.
CreatedDate Yes dateTime This field is not editable. The Zuora system automatically generates this date when the payment method is created.
CreditCardAddress1 Yes when defining a debit or credit card payment method; No otherwise string 255 characters The first line of the billing address for the credit or debit card holder.
CreditCardAddress2 No string 255 characters The second line of the billing address for the credit or debit card holder.
CreditCardCity Yes when defining a debit or credit card payment method; No otherwise string 40 characters The billing address's city.
CreditCardCountry Yes when defining a debit or credit card payment method; No otherwise string 40 characters The country in which the billing address is. Country names must be spelled in full; we've provided a list of supported country names.
CreditCardExpirationMonth Yes when defining a debit or credit card payment method; No otherwise int A two-digit number (01 through 12). The expiration month of the credit or debit card.
CreditCardExpirationYear Yes when defining a debit or credit card payment method; No otherwise int A four-digit number. The expiration year of the credit or debit card.
CreditCardHolderName Yes when defining a debit or credit card payment method; No otherwise string 80 characters The full name (first or personal and last or family) of the holder of the credit or debit card.
CreditCardMaskNumber Yes when defining a debit or credit card payment method; No otherwise string 20 characters, encrypted An encrypted version of the credit or debit card number. This is a read-only field.
CreditCardNumber Yes when defining a debit or credit card payment method; No otherwise string 16 characters The credit or debit card number. This is an insert-only field; it cannot be updated.
CreditCardPostalCode Yes when defining a debit or credit card payment method; No otherwise string 20 characters The billing address's postal code.
CreditCardState Yes when defining a debit or credit card payment method; No otherwise string 40 characters The billing address's state. Applies if the CreditCardCountry is either Canada or the US. State names must be spelled in full; we've provided a list of supported state names.
CreditCardType Yes when defining a debit or credit card payment method; No otherwise string AmericanExpress, Discover, MasterCard, or Visa The type of credit or debit card that is being billed. The values are case sensitive and must be used exactly as shown here.
LastTransactionDateTime No dateTime A valid dateTime value The date of the most recent transaction.
LastTransactionStatus No string This is a read-only field The status of the most recent transaction.
Name Yes string 50 characters The name of the payment method. This is something your customer will specify so they can identify it more easily.
PaypalBaid Yes when defining a PayPal payment method; No otherwise string 64 characters The PayPal billing agreement ID. This is a "contract" established between two PayPal accounts. Typically, the selling party initiates a request to create a BAID and sends it to buying party for acceptance. After that, the seller can keep track of the BAID and use it for future charges against the buyer.
PaypalEmail Yes when defining a PayPal payment method; No otherwise string 80 characters The email address associated with the account holder's PayPal account (or of the PayPal account of the person paying for the service).
Type Yes string ACH, CreditCard, DebitCard, Paypal The type of payment method being used. The values are case sensitive and must be used exactly as shown here. See Using PaymentMethod, below, for a discussion of these choices.
UpdatedDate Yes dateTime This field is not editable. The Zuora system automatically generates this date when the payment method is modified.

Using PaymentMethod

For most of the Type field choices, if you choose one of the options, you cannot use the fields for any of the other choices.

The following table shows this same information.

If Using This PaymentMethod Type: Then Use the Fields for
ACH CreditCard Paypal
ACH Yes No No
CreditCard No Yes No
DebitCard No Yes No
Paypal No No Yes

Copyright © 2008-2009 Zuora, Inc.

 

Open topic with navigation