SmartPayService
This service provides a common API for programmatically accessing and manipulating your SmartPay account, customers, and invoices.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAutopayCustomer
Creates a new autopay profile in the system. -
AddBankAccount
Creates a new bank account by using the specified information. -
AddCreditCardAccount
Creates a new credit card account by using the specified information. -
AddCustomer
Creates a new customer in the system using the specified information and optionally sends the new customer a welcome email. -
AddInvoice
Creates a new invoice in the system. -
AddInvoice2
Creates a new invoice in the system. -
AddInvoiceTemplate
Creates a new invoice template in the system. -
AddPaymentPlan
Adds a payment plan. -
Authenticate
Provides user authentication for the merchant logging into the system. -
BulkAddCustomer
Creates several new customers in the system based on data from the given file. -
BulkAddInvoice
Creates several new invoices in the system based on data from the given file. -
CancelPaymentPlan
Gets a list of current active payment plans. -
Challenge
This method checks a series of challenges to ensure that the connection is properly secured. -
CreatePayment
Creates a payment in SmartPay, optionally processing the specified credit card or ACH account, and optionally creates a new customer to associate the payment with. -
DeleteBankAccount
Deletes the specified bank account from the system. -
DeleteCreditCardAccount
Deletes the specified credit card account from the system. -
DeleteCustomer
Deletes the specified customer from the system. -
DeleteInvoice
Deletes the specified invoice from the system. -
DeleteInvoiceTemplate
Deletes the specified invoice template from the system. -
EditBankAccount
Updates the bank account in the system based on the data from the specifiedBankAccountinstance. -
EditCreditCardAccount
Updates the credit card account in the system based on the data from the specifiedCreditCardAccountinstance. -
EditCustomer
Updates the specified SmartPay customer with the data specified in theCustomerobject and optionally resets the username and password of the customer. -
EditCustomer2
Updates the specified SmartPay customer with the data specified in theCustomerobject and optionally resets the username and password of the customer. -
EditInvoice
Updates the invoice in the system based on the data from the specifiedInvoiceinstance. -
EditInvoice2
Updates the invoice in the system based on the data from the specifiedInvoiceinstance. -
EditInvoiceTemplate
Updates the invoice template in the system based on the data from the specifiedInvoiceTemplateinstance. -
GetAndMarkSubmittedPayments
Gets the list of current payments that have not been marked as exported and marks them as being exported so that they are not included in future requests. Optionally only retrieves the (non-exported) payments created between the specified dates. -
GetAutopayCustomerList
Gets a list of all the customers that have an autopay profile setup, and some basic information about the autopay profile. -
GetBankAccount
Gets a single bank account that matches the specified ID. -
GetCreditCardAccount
Gets a single credit card account that matches the specified ID. -
GetCustomer
Gets the information for a customer from the system. -
GetInvoice
Gets the invoice with the specified invoice number. -
GetInvoiceTemplate
Gets the invoice template with the specified template name. -
GetPaymentPlan
Gets a single payment plan that matches the specified ID. -
GetSettings
Gets the merchant settings. -
ImportInvoicePdf
Imports the specified PDF file for the specified invoice. -
ListBankAccounts
Gets a list of current active bank accounts. -
ListBankAccountsForCustomer
Gets a list of current active bank accounts associated with the specified customer. -
ListCreditCardAccounts
Gets a list of current active credit card accounts. -
ListCreditCardAccountsForCustomer
Gets a list of current active credit card accounts associated with the specified customer. -
ListPaymentPlans
Gets a list of current active payment plans. -
ListPayments
Gets a list of payments and optionally filters the payment list for payments created between the specified dates. This method will not mark payments as exported. -
RecordPayment
Records a manual payment. For legacy support only. Use the CreatePayment method instead. -
SendInvoiceEmail
Sends an email to the customer with information about the invoice and a PDF of the invoice attached to the email. -
SendInvoiceEmail2
Sends an email to the customer with information about the invoice and a PDF of the invoice attached to the email.