Payment

Payment

Service to interact with a customer's payments

Constructor

new Payment(options)

Create a new payment service

Source:
Parameters:
Name Type Description
options Object

configuration parameters

Methods

getPaymentOrder() → {Promise}

Get a payment order

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.paymentOrderUid string

the payment order uid

Returns:
Type:
Promise
  • the http request promise

getPaymentOrderPayments() → {Promise}

Get a payment order's payments

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.paymentOrderUid string

the payment order uid

Returns:
Type:
Promise
  • the http request promise

getStandingOrder() → {Promise}

Get a standing order

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.accountUid string

the account uid of the standing order

parameters.categoryUid string

the category uid of the standing order

parameters.paymentOrderUid string

the payment order uid of the standing order

Returns:
Type:
Promise
  • the http request promise

listStandingOrders() → {Promise}

List standing orders

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.accountUid string

the account uid of the account to get standing orders of

parameters.categoryUid string

the category uid of the category to get standing orders of

Returns:
Type:
Promise
  • the http request promise