Customer

Customer holds all the data pertinent to your paying customer.

Customer Object 

Field Notes Data Type
Identifier See Identifier string 
FirstName   string 
LastName   string 
Company   string
Email The value will be used by the system to send the customer emails, if enabled string
Phone   string
Fax   string
Website   string
Active   bool?
Address Reserved for future use, currently the address is associated with the payment method. AddressInfo

Available Methods 

Below are the methods that deal directly with Customers.  These definitions are for the SOAP interface.  The only difference in the REST interface is putting the sessionToken in the HTTP Authorization Header instead of as a parameter.

CreateCustomer

Creates a new Customer in the system.  

Parameter Description Data Type
customer Customer data Customer
merchantProfileId   string
serviceKey   string

UpdateCustomer

Updates an already existing Customer.

Parameter Description Data Type
customer Customer data Customer
currentIdentifier The Identifier of the Customer to be updated with the submitted data. Only submitted fields are updated. Null fields are ignored. string
merchantProfileId   string
serviceKey   string

GetCustomer

Retrieve a Customer from the system.

Parameter Description Data Type
identifier The Identifier of the Customer to retrieve string
merchantProfileId   string
serviceKey   string

CreateCustomerWithCredit

Creates a new Customer and CreditCardPayment in the system.  

Parameter Description Data Type
customer Customer data Customer
creditCardInfo   CreditCardInfo
addressInfo   AddressInfo
merchantProfileId   string
serviceKey   string
avsOverride Ignore the result of the AVSVerify and create the payment method any way. bool

CreateCustomerWithAch

Creates a new Customer and AchPayment in the system.  

Parameter Description Data Type
customer Customer data Customer
AchAccountInfo   AchAccountInfo
addressInfo   AddressInfo
merchantProfileId   string
serviceKey   string

CreateCustomerFromTransaction

Creates a new Customer in the system using the payment information of a referenced transaction.  

Parameter Description Data Type
transactionId The TPS TransactionId GUID to attempt to build a customer and payment from. string
merchantProfileId   string
serviceKey   string
customerIdentifier Optional. string
paymentIdentifier Optional. string

GetCustomerCount

Retrieve the total number of Customers in the system, to help with paging.

Parameter Description Data Type
merchantProfileId   string
serviceKey   string

GetCustomers

Retrieve 1 page of Customers.

Parameter Description Data Type
pageNum   int
pageSize   int
merchantProfileId   string
serviceKey   string

SearchCustomers

Search all Plans for specific values.

Parameter Description Data Type
searchTerms See SearchTerms SearchTerms
merchantProfileId   string
serviceKey   string

 

Updated: 1/10/17 ~DS

Comments