Mandate

Mandate

Service to interact with a customer's mandates

Constructor

new Mandate(options)

Create a new mandate service

Source:
Parameters:
Name Type Description
options Object

configuration parameters

Methods

deleteMandate() → {Promise}

Deletes specific direct debit mandate

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token.

parameters.mandateUid string

the unique mandate ID

Returns:
Type:
Promise
  • the http request promise

getMandate() → {Promise}

Gets a specific direct debit mandate

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.mandateUid string

unique identifier of the mandate

Returns:
Type:
Promise
  • the http request promise

listMandates() → {Promise}

Gets a list of the customer's current direct debit mandates

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

Returns:
Type:
Promise
  • the http request promise