API Docs for:
Show:

eb_savedPayments Class

Define eb_savedPayments class.

Methods

eb_savedPayments.createRecord

(
  • data
  • personId
)
Object

POST service call method.

Parameters:

  • data Object

    Card details.

  • personId String

    Person ID.

Returns:

Object:

jQuery promise object which when resolved returns created SPM record details.

eb_savedPayments.deleteRecord

(
  • personId
  • cardId
)
Object

DELETE service call method.

Parameters:

  • personId String

    Person ID.

  • cardId String

    Card ID.

Returns:

Object:

jQuery promise object.

eb_savedPayments.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_savedPayments.getAllACHRecords

(
  • personId
)
Object

GET service call method.

Parameters:

  • personId String

    Person ID.

Returns:

Object:

jQuery promise object which when resolved returns list of SPM ACH records.

eb_savedPayments.getAllRecords

(
  • personId
)
Object

GET service call method.

Parameters:

  • personId String

    Person ID.

Returns:

Object:

jQuery promise object which when resolved returns list of SPM records.

eb_savedPayments.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_savedPayments.model

(
  • data
  • domElement
  • personId
)

Saved Payments model responsible for saved payments operations.

Parameters:

  • data Any

    Saved payment data for binding if required.

  • domElement Object

    Login DOM element.

  • personId Object

    Logged-in person Id.

eb_savedPayments.render

(
  • options
)
String

The service will return saved payments HTML.

Parameters:

  • options Any

    Array of required data.

    • templatePath String

      Saved payments template URL.

Returns:

String:

jQuery promise object which when resolved returns HTML template.

eb_savedPayments.updateACHCardRecord

(
  • data
  • personId
  • cardId
)
Object

PATCH service call method.

Parameters:

  • data Object

    Card collection details.

  • personId String

    Person ID.

  • cardId String

    Card ID.

Returns:

Object:

jQuery promise object which when resolved returns updated SPM ACH record.

eb_savedPayments.updateRecord

(
  • data
  • personId
  • cardId
)
Object

PATCH service call method.

Parameters:

  • data Object

    Card details.

  • personId String

    Person ID.

  • cardId String

    Card ID.

Returns:

Object:

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.