Constructor
new Payee(options)
Create a new payee service
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object
|
configuration parameters |
Methods
createPayee() → {Promise}
Create a new payee
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token. |
parameters.payeeCreationRequest |
Object
|
the payee creation request. |
Returns:
- Type:
-
Promise
- the http request promise
deletePayee() → {Promise}
Delete an account holder's payee
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token. |
parameters.payeeUid |
string
|
the payeeUid of the payee to be deleted. |
Returns:
- Type:
-
Promise
- the http request promise
getPayees() → {Promise}
Get an account holder's payees
- 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