Xero

Xero Bank Feeds API

The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If…

Finance & banking#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you're an existing financial services partner that wants access, contact your local Partner Manager. If you're a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner.

Endpoints 7

BankFeeds

  • GETSearches for feed connections/FeedConnections?page=1&pageSize=100By passing in the appropriate options, you can search for available feed connections in the system.
  • POSTCreate one or more new feed connection/FeedConnectionsBy passing in the FeedConnections array object in the body, you can create one or more new feed connections
  • GETRetrieve single feed connection based on a unique id provided/FeedConnections/:idBy passing in a FeedConnection Id options, you can search for matching feed connections
  • POSTDelete an existing feed connection/FeedConnections/DeleteRequestsBy passing in FeedConnections array object in the body, you can delete a feed connection.
  • GETRetrieve all statements/Statements?page=0&pageSize=0By passing in parameters, you can search for matching statements
  • POSTCreates one or more new statements/Statements
  • GETRetrieve single statement based on unique id provided/Statements/:statementIdBy passing in a statement id, you can search for matching statements

API details

Base URL
https://api.xero.com/bankfeeds.xro/1.0
Authentication
OAuth 2.0 (authorization code flow) with 4 scopes
Operations
7 operations on 5 pathsGET 4POST 3
Main resources
BankFeeds 7
Response formats
application/json application/problem+json
Description format
OpenAPI 3.0.0, API version 20.1.0

How to test the Xero Bank Feeds API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Bank Feeds API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Searches for feed connections” (GET /FeedConnections?page=1&pageSize=100), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Xero Bank Feeds API?

The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If… It is listed under Finance & banking and has 7 endpoints.

Who publishes the Xero Bank Feeds API?

It is listed from Xero's public API description (an OpenAPI document), not published by Xero on Swastik Codes. Anyone who controls xero.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Xero Bank Feeds API?

Requests go to https://api.xero.com/bankfeeds.xro/1.0. Endpoint paths are added to this base URL.

How do I authenticate with the Xero Bank Feeds API?

With OAuth 2.0 (authorization code flow) with 4 scopes.

How many endpoints does the Xero Bank Feeds API have?

7 operations on 5 paths (4 GET, 3 POST). The largest groups are BankFeeds.

Is forking the Xero Bank Feeds API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.