eb_savedPayments Class
Define eb_savedPayments class.
Item Index
Methods
- eb_savedPayments.createRecord
- eb_savedPayments.deleteRecord
- eb_savedPayments.domElement
- eb_savedPayments.getAllACHRecords
- eb_savedPayments.getAllRecords
- eb_savedPayments.getValidPayments
- eb_savedPayments.model
- eb_savedPayments.render
- eb_savedPayments.updateACHCardRecord
- eb_savedPayments.updateRecord
Properties
- eb_savedPayments.createACHSPMService
- eb_savedPayments.createService
- eb_savedPayments.createServiceBluepayHPP
- eb_savedPayments.defaultErrorMessage
- eb_savedPayments.deleteService
- eb_savedPayments.errorResponses
- eb_savedPayments.getACHService
- eb_savedPayments.getService
- eb_savedPayments.getValidPaymentTypes
- eb_savedPayments.ServicePath
- eb_savedPayments.SitePath
- eb_savedPayments.TemplatePath
- eb_savedPayments.updateACHService
- eb_savedPayments.updateService
Methods
eb_savedPayments.createRecord
-
data
-
personId
POST service call method.
Parameters:
-
data
ObjectCard details.
-
personId
StringPerson ID.
Returns:
jQuery promise object which when resolved returns created SPM record details.
eb_savedPayments.deleteRecord
-
personId
-
cardId
DELETE service call method.
Parameters:
-
personId
StringPerson ID.
-
cardId
StringCard ID.
Returns:
jQuery promise object.
eb_savedPayments.domElement
-
domElement
Page DOM element.
Parameters:
-
domElement
Objectcurrent DOM element.
eb_savedPayments.getAllACHRecords
-
personId
GET service call method.
Parameters:
-
personId
StringPerson ID.
Returns:
jQuery promise object which when resolved returns list of SPM ACH records.
eb_savedPayments.getAllRecords
-
personId
GET service call method.
Parameters:
-
personId
StringPerson ID.
Returns:
jQuery promise object which when resolved returns list of SPM records.
eb_savedPayments.getValidPayments
-
personId
GET service call method to get all valid payments of the current user logged-in.
Parameters:
-
personId
NumberPerson ID.
Returns:
Returns jquery promise which resolves to list of valid payments.
eb_savedPayments.model
-
data
-
domElement
-
personId
Saved Payments model responsible for saved payments operations.
Parameters:
-
data
AnySaved payment data for binding if required.
-
domElement
ObjectLogin DOM element.
-
personId
ObjectLogged-in person Id.
eb_savedPayments.render
-
options
The service will return saved payments HTML.
Parameters:
-
options
AnyArray of required data.
-
templatePath
StringSaved payments template URL.
-
Returns:
jQuery promise object which when resolved returns HTML template.
eb_savedPayments.updateACHCardRecord
-
data
-
personId
-
cardId
PATCH service call method.
Parameters:
-
data
ObjectCard collection details.
-
personId
StringPerson ID.
-
cardId
StringCard ID.
Returns:
jQuery promise object which when resolved returns updated SPM ACH record.
eb_savedPayments.updateRecord
-
data
-
personId
-
cardId
PATCH service call method.
Parameters:
-
data
ObjectCard details.
-
personId
StringPerson ID.
-
cardId
StringCard ID.
Returns:
jQuery promise object which when resolved returns updated SPM record.
Properties
eb_savedPayments.createACHSPMService
String
POST service call to create new ACH SPM record.
eb_savedPayments.createService
String
POST service call to create new SPM record.
eb_savedPayments.createServiceBluepayHPP
String
POST service call to create SPM by remote hosted payment method.
eb_savedPayments.defaultErrorMessage
String
Default error message.
eb_savedPayments.deleteService
String
DELETE service call to delete specific SPM record.
eb_savedPayments.errorResponses
Object
Globally defined error codes object for the control. Every error code should have boolean 'useServerMessage' attribute, which when true suggests we are showing service error message on the UI. If the 'useServerMessage' is defined as false, then provide another attribute 'frontEndMessage' with the error string which will be shown on UI. If 'useServerMessage' is false and 'frontEndMessage' is not defined, default error message will be shown. If service error response contains error code not defined in this object then default error message will be shown.
eb_savedPayments.getACHService
String
GET service to get all SPM ACH records.
eb_savedPayments.getService
String
GET service to get all SPM records.
eb_savedPayments.getValidPaymentTypes
String
GET service to get all valid payment types.
eb_savedPayments.ServicePath
String
Service path. It would be set from configuration file.
eb_savedPayments.SitePath
String
Site path. It would be set from configuration file.
eb_savedPayments.TemplatePath
String
Template path.
eb_savedPayments.updateACHService
String
PATCH service call to update specific SPM ACH record.
eb_savedPayments.updateService
String
PATCH service call to update specific SPM record.