Understanding how the Feeds endpoint works.
The Transactions API Feeds endpoint provides the ability to create, query and cancel feeds.
| Supported Method | Description | HTTP Status Codes |
|---|---|---|
|
GET |
A financial institutions can retrieve the current status of all bank feeds for a given account (by externalId) |
200 | 403 | 500 | 503 |
POST |
A financial institution can request to establish bank feed connection. A new bank feed will be created if no prior feed exists. If a previously cancelled feed existed between the financial institution account and the business ledger, then this cancelled feed will be re-activated. |
201 | 207 | 400 | 404 | 422 | 500 | 503 |
|
DELETE |
A financial institution can request to remove bank feed connection for a specific bank account. All bank feeds from the financial institution for that bank account will be cancelled and no further transaction data will be made available to any business ledgers the account had been linked to. |
204 | 404 | 500 | 503 |
Description: When one or more bank feeds associated with the specified account exist and are retrieved.
Context: Response can contain empty array when no bank feeds associated with the specified account exist, or multiple bank feeds if accounts are connected to multiple business ledgers.
See Feed endpoints page for the GET response samplesDescription: When the request is validated and successfully processed.
Context: All accounts to be connected in the request have been processed, a response with the result of the operation should be expected.
See Feed endpoints page for POST response samplesDescription: When a request to cancel all bank feeds associated with the specified account (externalId) is processed.
Context: No response body, returns a HTTP status code 204 (No Content) only.
Description: When a request is validated and processed but not all accounts are onboarded.
Context: One or more accounts provided in the request has associated feeds that have been created, however one or more of the accounts does not have associated feeds created due to error(s).
See Feed endpoints page for POST response samplesDescription: When request body is malformatted, missing the required fields such as applicationId & accountDetails or a single account contains violated fields.
Context: Response contains a single error object in the errorDetails field stating the violation or error description.
Response type: Single Error Message
Description: When multiple specified accounts (externalIds) have violated fields in request.
Response type: Multiple Error Message
Description: When a financial institution is not enabled to access this Transaction API endpoint.
Response type: Single Error Message
Description: When a request is validated and processed but no accounts are onboarded.
Context: No accounts provided in the request have associated feeds created due to each of them having error(s).
See Feed endpoints page for POST response samplesDescription: When Transaction API is experiencing an internal error.
Response type: Single Error Message
Description: When Transaction API is unable to process requests due to an affiliated service being unavailable.
Response type: Single Error Message
Error Response Attribute
|
Single Error Message samplesWhen a financial institution is not enabled to access this Transaction API endpoint.
When a request has required fields that contain invalid value in one account, an element in the “errors” array will present the related externalId and the details of any invalid field violations.
Multiple Error Message samplesWhere multiple specified accounts (externalIds) have violated fields, details of any field violations for each account are presented as an element in the “errors” array.
|
Copyright © 2020 MYOB Technology Pty Ltd