Introduction
Apps allow you to access merchants information, and perform actions on their behalf using our API. Information on what you can do with the API can be found here.
Registering An App
This is not available to end users and must be done by support emailing our support team at support@payadvantage.com.au and providing:
Name |
The name of your app. |
AppUrl |
The URL of the app. |
RedirectUrl |
The URL to direct users to once they have authorised your app. This will need to process the OAuth response. |
Icon |
An icon that will be shown alongside your app name. |
Permissions |
The permissions that your app needs to function. See below. |
Are multiple instances required |
Will your app be installed on multiple sites? |
Available Permissions
Permission Name |
Description |
batch_direct_debit_authorise |
Ability to authorise debit instruction batches. |
batch_direct_debit_read |
Ability to read debit instructions. |
batch_direct_debit_write |
Ability to create, update and delete debit instructions. |
customer_read |
Ability to read the merchant’s customers. |
customer_write |
Ability to create, update and delete the merchants customers. |
direct_debit_read |
Ability to read the merchant’s direct debits. |
direct_debit_write |
Ability to create, update and delete the merchants direct debits. |
payment_read |
Ability to read the payments and refunds. |
payment_write |
Ability to create payments. |
refund_write |
Ability to refund payments. |
settlement_read |
Ability to read settlements. |
Note: When a merchant authorises an app, they must accept all permissions that the app requests. If the app requires additional permissions in the future, you must get the merchant to re authorise the app.
Comments
0 comments
Please sign in to leave a comment.