API Docs for:
Show:

eb_paymentControl Class

Define eb_paymentControl class.

Methods

eb_paymentControl.deleteSavedCard

(
  • cardDetails
)
Object

Service call method to delete Saved Card record of the current user logged-in.

Parameters:

  • cardDetails Number

    Saved Cards Details.

Returns:

Object:

Returns jquery promise.

eb_paymentControl.editSavedCard

(
  • cardDetails
)
Object

Service call method to edit Saved Card record of the current user logged-in.

Parameters:

  • cardDetails Number

    Saved Cards Details.

Returns:

Object:

Returns jquery promise.

eb_paymentControl.getAllACHSavedCardRecords

(
  • personId
)
Object

GET service call method to get all ACH Saved Cards records of the current user logged-in.

Parameters:

  • personId Number

    Person ID.

Returns:

Object:

Returns jquery promise which resolves to list of saved cards.

eb_paymentControl.getAllACHSavedCardRecordsCompany

(
  • companyId
)
Object

GET service call method to get all ACH Saved Cards records of current company .

Parameters:

  • companyId Number

    Company ID.

Returns:

Object:

Returns jquery promise which resolves to list of saved cards.

eb_paymentControl.getAllRecords

(
  • personId
)
Object

GET service call method to get all Saved Cards records of the current user logged-in.

Parameters:

  • personId Number

    Person ID.

Returns:

Object:

Returns jquery promise which resolves to list of saved cards.

eb_paymentControl.getAllRecordsCompany

(
  • companyId
)
Object

GET service call method to get all Saved Cards records of the current company.

Parameters:

  • companyId Number

    company ID.

Returns:

Object:

Returns jquery promise which resolves to list of saved cards.

eb_paymentControl.getValidPayments

(
  • personId
)
Object

GET service call method to get all valid payments of the current user logged-in.

Parameters:

  • personId Number

    Person ID.

Returns:

Object:

Returns jquery promise which resolves to list of valid payments.

eb_paymentControl.getValidPaymentsCompany

(
  • companyId
)
Object

GET service call method to get all valid payments of the current company.

Parameters:

  • companyId Number

    company ID.

Returns:

Object:

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 Object

    Object with data required for model binding.

    • ServicePath String

      Service URL.

    • SitePath String

      Site URL

    • domElement Object

      DOM element.

    • templatePath String

      HTML path.

    • savedCards Object

      Saved Cards list of current user.

  • control Object

    The 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
)
String

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 Object

    Object with data required for getting HTML template through Ajax call.

    • SitePath String

      Site path.

    • templatePath String

      HTML file path.

    • domElement Object

      DOM element.

Returns:

String:

jQuery promise object which when resolved returns HTML template.

eb_paymentControl.updateACHCardRecord

(
  • ACH
  • personId
  • cardId
)
Object

PATCH ACH service method.

Parameters:

  • ACH Object

    card collection object.

  • personId String

    person ID.

  • cardId String

    cardId

Returns:

Object:

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.