Payment

Payment

Service to interact with a customer's transactions

Constructor

new Payment(options)

Create a new transaction service

Parameters:
Name Type Description
options Object

configuration parameters

Source:

Methods

listScheduledPayments(accessToken) → {Promise}

Lists the customer's scheduled payments

Parameters:
Name Type Description
accessToken string

the oauth bearer token.

Source:
Returns:
  • the http request promise
Type
Promise

makeLocalPayment(accessToken, destinationAccountId, reference, amount, currencyopt) → {Promise}

Makes a payment on behalf of the customer to another UK bank account using the Faster Payments network

Parameters:
Name Type Attributes Description
accessToken string

the oauth bearer token.

destinationAccountId string

the account identifier of the recipient

reference string

The payment reference, max. 18 characters.

amount string

the amount to be send.

currency string <optional>

the currency, optional, defaults to "GBP".

Source:
Returns:
  • the http request promise
Type
Promise