A payment method for a particular customer, such as a credit card, bank account, or pre-approved PayPal billing agreement, can be added, updated, or deleted via the API. A customer may have more than one payment method on file. The collection method setting on the customer decides which payment method to use.
Methods
The following methods are available:
- Get Customer Payment Methods
- Create Customer Payment Method
- Update Payment Method
- Delete Payment Method
Data Structures
Credit Card Info
Field | Description | Required | Format |
---|---|---|---|
AccountNumber | Credit card number. | yes | up to 20 characters |
AddressLine1 | Street address line 1 for billing address. | up to 60 characters | |
AddressLine2 | Street address line 2 for billing address. | up to 60 characters | |
City | City for billing address. | up to 60 characters | |
CountryCode | Three letter ISO country code for customer address | yes | 3 characters |
CVCode | The card verification code, also referred to as CVV, CVV2, orCSC. | yes | up to 4 characters |
ExpirationDate | The expiration date of the credit card. Must be specified as 4characters in MMYY format. | yes | MMYY |
FirstName | First name for customer. | yes | up to 60 characters |
HomeNumber | Home telephone number for customer. | up to 40 characters | |
LastName | Last name for customer. | yes | up to 60 characters |
PostalCode | Postal code for customer address. | up to 60 characters | |
StateProvince | State or province for customer address. | up to 60 characters | |
IPAddress | IP address of the client computer making the signup request. | yes | IPv4 or IPv6 |
PayPal (pre-approved) Billing Agreement
FIELD | DESCRIPTION | REQUIRED | FORMAT |
---|---|---|---|
AddressLine1 | Street address line 1 for billing address. | up to 60 characters | |
AddressLine2 | Street address line 2 for billing address. | up to 60 characters | |
Agreement ID | The pre-approval key | yes | up to 60 characters |
City | City for billing address. | up to 60 characters | |
CountryCode | Three letter ISO country code for customer address | yes | 3 characters |
EndingDate | The ending date of the agreement. | yes | yyyy-mm-dd |
FirstName | First name for customer. | yes | up to 60 characters |
Issuer | The issuer of the agreement (PayPal). | yes | up to 60 characters |
LastName | Last name for customer. | yes | up to 60 characters |
MaxTotalAmountOfAllPayments | The maximum total amount of all payments for the agreement. Default maximum is $2,000. | yes | decimal string |
TermLengthInMonths | The length of time for the agreement. Default maximum is 24 months. | yes | integeter string |
PostalCode | Postal code for customer address. | up to 60 characters | |
StartingDate | The starting date of the agreement. Cannot be in the past. | yes | yyyy-mm-dd |
StateProvince | State or province for customer address. | up to 60 characters | |
IPAddress | IP address of the client computer making the signup request. | yes | IPv4 or IPv6 |
Bank Account Info
FIELD | DESCRIPTION | REQUIRED | FORMAT |
---|---|---|---|
AccountNumber | Bank account number. | yes | up to 20 characters |
AccountType | The type of bank account. Either “BUSINESSCHECKING”, “CHECKING”, or “SAVING”. | yes | specific value |
BankName | The name of the bank. | yes | up to 60 characters |
CountryCode | Three letter ISO country code for customer address. Authorize.Net eCheck only supports USA as for ACH bank account transfers. | yes | 3 characters |
FirstName | First name for customer. | yes | up to 60 characters |
LastName | Last name for customer. | yes | up to 60 characters |
RoutingNumber | The routing number for the bank. | yes | up to 60 characters |
IPAddress | IP address of the client computer making the signup request. | yes | IPv4 or IPv6 |