XExeroapi
FeedConnections

Retrieve a single Feed Connection

Changed on

Returns one Feed Connection, as a bare object rather than inside an envelope.

The response is 404 bank-feed-not-found when the identifier names no Feed Connection, when it names one belonging to a different Application, when it is an all-zeros GUID, and when it is not a GUID at all. These cases are deliberately indistinguishable from one another, so an Application cannot use this endpoint to discover what another Application has.

get/FeedConnections/{id}

Request

  • Base URL
    https://api.xero.com/bankfeeds.xro/2.0
  • URL
    https://api.xero.com/bankfeeds.xro/2.0/FeedConnections/{id}
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: bankfeedsv2

Path parameters

idstring uuid required

The Feed Connection identifier.

Headers

Xero-Tenant-Idstring required

Xero identifier for Tenant

Response

The Feed Connection.

idstring uuid

Xero's identifier for the Feed Connection.

accountTokenstring

The financial institute's identifier for the account.

accountType'BANK' | 'CREDITCARD'

The high-level type of the account. BANK covers every account type other than a credit card.

accountNumberstring

The account number the feed is connected to.

accountNamestring

The name of the Xero Bank Account.

accountIdstring uuid

Xero's identifier for the Xero Bank Account.

currencystring

ISO-4217 currency code.

countrystring

ISO-3166 alpha-2 country code.

Changes