eb_paymentControl Class
Define eb_paymentControl class.
Item Index
Methods
- eb_paymentControl.deleteSavedCard
- eb_paymentControl.editSavedCard
- eb_paymentControl.getAllACHSavedCardRecords
- eb_paymentControl.getAllACHSavedCardRecordsCompany
- eb_paymentControl.getAllRecords
- eb_paymentControl.getAllRecordsCompany
- eb_paymentControl.getValidPayments
- eb_paymentControl.getValidPaymentsCompany
- eb_paymentControl.paymentModel
- eb_paymentControl.render
- eb_paymentControl.updateACHCardRecord
Properties
- : eb_paymentControl.activePaymentTypes
- : eb_paymentControl.monthConstants
- : eb_paymentControl.validPaymentTypesForUser
- eb_paymentControl.creditCardtypes
- eb_paymentControl.defaultErrorMessage
- eb_paymentControl.deleteSavedPaymentURL
- eb_paymentControl.editSavedPaymentURL
- eb_paymentControl.errorResponses
- eb_paymentControl.getSavedCardForAch
- eb_paymentControl.getSavedCardForAchCompany
- eb_paymentControl.getSavedCardsService
- eb_paymentControl.getSavedCardsServiceCompany
- eb_paymentControl.getValidPaymentTypes
- eb_paymentControl.getValidPaymentURLCompany
- eb_paymentControl.ServicePath
- eb_paymentControl.SitePath
- eb_paymentControl.TemplatePath
- eb_paymentControl.updateACHrecordService
Methods
eb_paymentControl.deleteSavedCard
-
cardDetails
Service call method to delete Saved Card record of the current user logged-in.
Parameters:
-
cardDetails
NumberSaved Cards Details.
Returns:
Returns jquery promise.
eb_paymentControl.editSavedCard
-
cardDetails
Service call method to edit Saved Card record of the current user logged-in.
Parameters:
-
cardDetails
NumberSaved Cards Details.
Returns:
Returns jquery promise.
eb_paymentControl.getAllACHSavedCardRecords
-
personId
GET service call method to get all ACH Saved Cards records of the current user logged-in.
Parameters:
-
personId
NumberPerson ID.
Returns:
Returns jquery promise which resolves to list of saved cards.
eb_paymentControl.getAllACHSavedCardRecordsCompany
-
companyId
GET service call method to get all ACH Saved Cards records of current company .
Parameters:
-
companyId
NumberCompany ID.
Returns:
Returns jquery promise which resolves to list of saved cards.
eb_paymentControl.getAllRecords
-
personId
GET service call method to get all Saved Cards records of the current user logged-in.
Parameters:
-
personId
NumberPerson ID.
Returns:
Returns jquery promise which resolves to list of saved cards.
eb_paymentControl.getAllRecordsCompany
-
companyId
GET service call method to get all Saved Cards records of the current company.
Parameters:
-
companyId
Numbercompany ID.
Returns:
Returns jquery promise which resolves to list of saved cards.
eb_paymentControl.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_paymentControl.getValidPaymentsCompany
-
companyId
GET service call method to get all valid payments of the current company.
Parameters:
-
companyId
Numbercompany ID.
Returns:
Returns jquery promise which resolves to list of valid payments.
eb_paymentControl.paymentModel
-
options
-
control
Payment Control Model for binding data and to handle events.
Parameters:
-
options
ObjectObject with data required for model binding.
-
ServicePath
StringService URL.
-
SitePath
StringSite URL
-
domElement
ObjectDOM element.
-
templatePath
StringHTML path.
-
savedCards
ObjectSaved Cards list of current user.
-
-
control
ObjectThe model of current calling control. It is needed to access payment function, control properties, error handling properties defined in calling control.
eb_paymentControl.render
-
options
Rendering public method to load HTML template. Based on page level configuration it will select the template and load in DOM. Template path and DOM element are required parameters. GET the template by Ajax call using template path and then assign it to DOM element.
Parameters:
-
options
ObjectObject with data required for getting HTML template through Ajax call.
-
SitePath
StringSite path.
-
templatePath
StringHTML file path.
-
domElement
ObjectDOM element.
-
Returns:
jQuery promise object which when resolved returns HTML template.
eb_paymentControl.updateACHCardRecord
-
ACH
-
personId
-
cardId
PATCH ACH service method.
Parameters:
-
ACH
Objectcard collection object.
-
personId
Stringperson ID.
-
cardId
StringcardId
Returns:
jQuery promise object which return updated ACH record.
Properties
: eb_paymentControl.activePaymentTypes
Object
All active payment types
: eb_paymentControl.monthConstants
Object
Object with each month's numeric value.
: eb_paymentControl.validPaymentTypesForUser
Object
All active payment types
eb_paymentControl.creditCardtypes
Object
All card types.
eb_paymentControl.defaultErrorMessage
String
Default error message.
eb_paymentControl.deleteSavedPaymentURL
String
Service URL to delete Saved Cards records.
eb_paymentControl.editSavedPaymentURL
String
Service URL to update/edit Saved Cards records.
eb_paymentControl.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_paymentControl.getSavedCardForAch
String
Service URL to get Saved Cards records for ACH.
eb_paymentControl.getSavedCardForAchCompany
String
Service URL to get Saved Cards records for ACH for a company.
eb_paymentControl.getSavedCardsService
String
GET service to get all Saved Cards records.
eb_paymentControl.getSavedCardsServiceCompany
String
GET service to get all Saved Cards records for a company.
eb_paymentControl.getValidPaymentTypes
String
GET service to get all valid payment types.
eb_paymentControl.getValidPaymentURLCompany
String
GET service to get all valid payment types for a company.
eb_paymentControl.ServicePath
String
The path to the eBusiness SOA layer.
eb_paymentControl.SitePath
String
Control level setting: Site path.
eb_paymentControl.TemplatePath
String
Control level setting Template path.
eb_paymentControl.updateACHrecordService
String
PATCH ACH record.