Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xero BankFeeds API

The BankFeeds API from Xero — 5 operation(s) for bankfeeds.

Xero BankFeeds API is one of 10 APIs that Xero publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include BankFeeds. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 7 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 11.1.0.

Requests are made against a single base URL, https://api.xero.com/api.xro/2.0.

7 operations 5 paths 13 schemas 4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
11.1.0
Base URL
https://api.xero.com/api.xro/2.0
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Xero BankFeeds API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 16 scopes.

  • OAuth2 — For more information

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

BankFeeds 7
GET
/FeedConnections
Xero Searches for feed connections
getFeedConnections 3 params → 202400
POST
/FeedConnections
Xero Create one or more new feed connection
createFeedConnections 2 params body → 202400
GET
/FeedConnections/{id}
Xero Retrieve single feed connection based on a unique id provided
getFeedConnection 2 params → 200400
POST
/FeedConnections/DeleteRequests
Xero Delete an existing feed connection
deleteFeedConnections 2 params body → 202400
GET
/Statements
Xero Retrieve all statements
getStatements 5 params → 200400
POST
/Statements
Xero Creates one or more new statements
createStatements 2 params body → 202400403409413422500
GET
/Statements/{statementId}
Xero Retrieve single statement based on unique id provided
getStatement 2 params → 200404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are FeedConnection (10 properties), Statement (10 properties), StatementLine (9 properties), Pagination (4 properties). Each schema is shown below with its type and property counts.

CreditDebitIndicator
string
If the statement balances are credit or debit, the CreditDebitIndicator should be specified from the perspective of the Customer.
Pagination
object
4 properties
StatementLine
object
the lines details for a statement
9 properties
StatementLines
array
StartBalance
object
The starting balance of the statement
2 properties
CurrencyCode
string
3 letter alpha code for the ISO-4217 currency code, e.g. USD, AUD.
CountryCode
string
ISO-3166 alpha-2 country code, e.g. US, AU This element is required only when the Application supports multi-region. Talk to your Partner Manager to confirm if…
FeedConnection
object
10 properties
Statements
object
2 properties
FeedConnections
object
2 properties
Statement
object
10 properties
Error
object
On error, the API consumer will receive an HTTP response with a HTTP Status Code of 4xx or 5xx and a Content-Type of application/problem+json.
4 properties
EndBalance
object
The StartBalance plus all the Statement Line Amounts should be equal to the EndBalance Amount.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xero-bankfeeds-api-openapi.yml Raw ↑

Other APIs Xero publishes across the network.

Xero Accounting API
Xero Asset API
Xero Files API
Xero Finance API
Xero Identity API
Xero PayrollAu API
Xero PayrollNz API
Xero PayrollUk API
Xero Project API