Feeds
List, create and cancel feeds
Date Released: May 2023 Date Updated: May 2023
The elements list below details information for Feeds. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.
Items shown with are required when posting or puting data
Items shown with are read-only elements
Attribute Details
- applicationIdString
- Unique identifier of application passed from MYOB to financial institution
- accountDetails []
- externalIdString (100)
- Unique identifier of account from financial institution
- accountTypeString (13)
- Account type descriptor - “BankAccount” or "CreditCard"
- accountNameString (30)
- Account holder’s name or type of account
- accountNumberString (16)
- Financial institution account number. When accountType is “CreditCard”, the account number is the last 4 digits of the credit card number.
- bsbString (7)
- Identifier for financial institution and branch, valid format is “XXX-XXX” or “XXXXXX”. Only required for Australian bank accounts.
- currencyCodeString (3)
- Country currency code, valid values are “AUD” or “NZD”
Response
- feeds []
- feedIdString(25)
- Unique feed identifier
- externalIdString(100)
- Unique identifier of account from financial institution
- statusString(30)
- Current status of feed. If feed is still active and in use, value will be "BankFeedReady". If feed has been cancelled, value will be "Cancelled".
GET /feeds
Response examples
Status code: 200
Body:
- {
- "feeds": [
- "feedId":"B000000426,
- "externalId":"ty79v3-452iU-7op81z-AwMDIxMj",
- "status": "BankFeedReady"
- },
- "feedId":"B000000427,
- "externalId":"tyf6q4-d6bnd8-7op81z-JI4gHm",
- "status": "Cancelled"
- }
- ]
- }
GET /feeds/{externalId}
Response examples
Status code: 200
Body:
- {
- "feeds": [
- {
- "feedId":"B000000427",
- "externalId":"tyf6q4-d6bnd8-7op81z-JI4gHm",
- "status": "Cancelled"
- }
- ]
- }
POST /feeds
Request examples
- {
- "applicationId":"6328y-jdh32b-bag3ed-hgjt65",
- "accountDetails": [
- {
- "externalId": "27fh5r-htnf5i-jsuhe4-37Ku4",
- "accountType":"BankAccount",
- "accountName":"John Smith's Transaction Account",
- "accountNumber":"1095736",
- "bsb":"063211",
- "currencyCode":"AUD"
- },
- {
- "externalId": "36fc5a-htqm7i-Q1Ce4-34Lm7",
- "accountType":"CreditCard",
- "accountName":"John Smith's Credit Card",
- "accountNumber":1234,
- "currencyCode":"AUD"
- }
- ]
- }
Response examples
Status code: 201
Body:
- {
- "feeds": [
- {
- "feedId":"B000000428,
- "externalId":"27fh5r-htnf5i-jsuhe4-37Ku4",
- "status": "BankFeedReady"
- },
- "feedId":"B000000429,
- "externalId":"36fc5a-htqm7i-Q1Ce4-34Lm7",
- "status": "BankFeedReady"
- }
- ]
- }
DELETE /feeds/{externalId}
Response examples
Status code: 204
