To send requests to Transaction API endpoints please ensure you have a valid access token. Please see the Authentication page for instructions on obtaining an access token.
Ensure an access token is present in the header of each request to Transactions API. We use these tokens to identify your institution. Requests made without a token will be refused access to endpoints.
Use the following guide to connect feeds to a set of one or more specified customer bank accounts using Transaction API.
Step 1 - When a customer elects to connect new feeds they are redirected from the MYOB product page and sent to your institution's online banking portal.
Step 2 - The url used to redirect them will have this general form
https://{your-institution-portal-url}?applicationId=d3cef720-57af-4bf3-bd90-3b8755edb116&redirectUrl=https%3A%2F%2Fbankfeeds-portal-sit.svc.platform.myobdev.com%2Fonboard%2Fsummary%3FapplicationId%3Dd3cef720-57af-4bf3-bd90-3b8755edb116%26consumptionId%3Dca9ef19b-5b18-421c-b04b-aa295b99c8ee&redirectUrl=https%3A%2F%2Fpdv-sme-web.app.myob.com%2F%23%2Fau%2Fca9ef19b-5b18-421c-b04b-aa295b99c8ee%2FbankFeeds&feedsRemaining=1
Step 3 - Take note of this redirect url, it contains four main elements, one of which is optional. Two of these elements are used during later stages of this process. These elements are described in the below table:
| URL Element | Description |
|---|---|
| {your-institution-portal-url} | The hostname and path you provided for your institution's online banking portal. |
| applicationId | This is the identifier assigned to the customer's bank feeds application. The application id value is required in the request body of the request to the create feeds endpoint. See below. |
| redirectUrl | The Url of the MYOB product to return the customer to once they have completed the feeds creation process within your institution's online banking portal. |
| feedsRemaining | This field is optional and will be sent only if the customer's subscription has a bank feed limit. It can be used to validate the number of accounts selected in step 4. |
Step 4 - The customer logs in to your institution's banking portal and selects the accounts they wish to connect feeds for.
Step 5 - To connect feeds for the selected accounts hit the Feeds POST endpoint. A sample request body is shown on the Feeds page.
Step 6 - The applicationId field in the request body uses the same value as the applicationId specified in the url described in Step 3.
Step 7 - After sending the request to the Feeds POST endpoint you will receive a response that describes the outcome of the feed connection attempt. The are three response codes that indicate a successful (non-error) response. These are summarised below
| Response code | Description |
|---|---|
| 201 (Created) | A new feed was created for each specified account |
| 207 (Multi-Status) | Some of the specified accounts did not have a feed created |
| 422 (Unprocessable Content) | None of the specified accounts had a feed created |
An example of a response body can be seen on the Feeds page.
Step 8 - If a 5xx or other 4xx response codes are received refer to the Feeds Information page for further explanation.
Step 9 - After the feeds connection operation has been completed, use the redirectUrl parameter value from the original url as described in step 3 to redirect the customer back to the MYOB product page.
Step 10 - Once the customer has been redirected they will be shown a screen that presents the results of the feeds connection operation.
Step 11 - You have now connected feeds to the specified accounts. These new feeds are ready to start receiving transaction data.
Step 1 - To check the status of one specific feed or all feeds for your institution hit the Feeds GET endpoint.
Refer to the Feeds page for endpoint usage and sample response bodies.
Step 2 - To check the status of a single feed, you need to specify an externalId as a path parameter. The externalId is the unique identifier your institution provided for the account related to this feed.
To check the status of all your institution's feeds, no additional parameters are necessary. Simply call the base Feeds GET endpoint route.
Step 3 - After sending the request to the Feeds POST endpoint you will receive an HTTP 200 (OK) response code with a body containing the following items for each feed:
A status of 'BankFeedReady' indicates the feed is active and ready to receive transactions. A status of 'Cancelled' indicates the feed is inactive and is unable to receive transactions.
If you receive a 4xx or a 5xx response code refer to the Feeds Information page for further explanation.
Step 1 - To remove an account's feed connection hit the Feeds DELETE endpoint. This action will cancel the connection so the feed will no longer receive transaction data.
Step 2 - Refer to the Feeds page for endpoint usage.
You need to specify an externalId as a path parameter. The externalId is the unique identifier your institution provided for the account related to this feed.
Step 3 - After sending the request to the Feeds DELETE endpoint you will receive an HTTP 204 (No Content) response code.
If you receive a 4xx or a 5xx response code refer to the Feeds Information page for further explanation.
Once an account has had a feed connected, transaction data can be sent to this feed.
Step 1 - To send data to a connected feed hit the Transactions POST endpoint. A sample request body is shown on the Transactions page.
Step 2 - The endpoint is set up to accept transactions for one account per call. The externalId specified in the request body is the same value that your institution provided as the account's unique identifier when initially connecting a feed for the account.
Step 3 - After sending the request to the Feeds POST endpoint you will receive an HTTP 201 (Created) response code.
If you receive a 4xx or a 5xx response codes refer to the Transactions Information page for further explanation.
Copyright © 2020 MYOB Technology Pty Ltd