developer:soap:objects:paymentmethod

Soap API v1.2

PaymentMethod

Describes a customer payment method.

Description

This object describes a customer payment method. Either CreditCardData or CheckData must be populated but not both. If a PaymentMethod is submitted with both CreditCardData and CheckData populated a fault will be thrown.

If this object is returned from a method, the CreditCardData or CheckData will be masked for security reasons.

Properties

Type Name Description
integer MethodID ID of payment method. This property is ignored when adding a new payment method but required if updating an existing method.
string MethodName Label for payment method. For example “Work Visa” or “Personal Checking.”
string Expires Date on which payment method will expire. Do not leave blank. Format: YYYY-MM-DD
string CardNumber Card Number
string CardExpiration Expiration Date - Should be set to 4 digit MMYY.
string AvsStreet Billing address associated with card, used by AVS.
string AvsZip Billing zipcode associated with card, used by AVS.
String Routing Nine digit bank routing number.
String Account Bank account number.
String AccountType Checking or Savings - if left blank, default is Checking.
integer SecondarySort If set to value greater than 0, use this method as backup in case default fails. Secondary methods will be run in ascending order.
dateTime Created Date/time that the payment method was added
dateTime Modified Date/time that the payment method was last changed

Object Diagram

Places Used

Examples

Change History

Version Change
1.3 Removed CreditCardData and CheckData objects
1.2 Added the Created and Modified Parameters
1.1 Soap 1.1 Release
developer/soap/objects/paymentmethod.txt · Last modified: 2012/08/08 16:42 by charlie

Page Tools