Terminate Feed Connections
Changed onTerminates the Feed Connections named in the request. Terminating a Feed Connection discontinues the bank feed, and does not otherwise affect the customer's data in Xero.
Each item is identified by the Feed Connection id alone. An item naming a Feed Connection that does not exist, has already been terminated, or belongs to a different Application is reported as feed-not-found-or-already-deleted with status SUCCESS and statusCode 204 — there was nothing to terminate, which is not a failure, and is reported the same way a real termination is.
The same identifier may not appear twice in one request.
Re-sending a completed delete is idempotent. If an item reports PARTIAL_FAILURE, or the original response was lost, resend the same DeleteRequests item. The retry checks whether the connection remains and terminates it if needed. A SUCCESS item on the resend means the deletion is complete, including feed-not-found-or-already-deleted at statusCode 204. If a retry keeps reporting PARTIAL_FAILURE, contact Xero support with the connection id in error.connectionId.
Request
- Base URLhttps://api.xero.com/bankfeeds.xro/2.0
- URLhttps://api.xero.com/bankfeeds.xro/2.0/FeedConnections/DeleteRequests
- AuthOAuth 2Authorization code: https://login.xero.com/identity/connect/authorizeToken URL: https://identity.xero.com/connect/token scopes: bankfeedsv2
Headers
Xero identifier for Tenant
Request body
Response
All items are 2xx: each one reached its desired state, and there is nothing left for you to do. This includes a request in which none of the identifiers matched a connection to terminate, since feed-not-found-or-already-deleted is reported at statusCode 204 — the requested final state already holds, which is not a failure.
A response that mixes these with rejected or partially failed items is a 207.
Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking