BankFeeds

Searches for feed connections

By passing in the appropriate options, you can search for available feed connections in the system.

get/FeedConnections

Query parameters

pageinteger

Example:1

Page number which specifies the set of records to retrieve. By default the number of the records per set is 10. Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?page=1 to get the second set of the records. When page value is not a number or a negative number, by default, the first set of records is returned.

pageSizeinteger

Example:100

Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?pageSize=100 to specify page size of 100.

Response

search results matching criteria returned with pagination and items array

Example response

{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "pageCount": 1,
    "itemCount": 2
  },
  "items": [
    {
      "id": "0d3cf8d-95dc-4466-8dc0-47e6d1197e28",
      "accountToken": "10000123",
      "accountNumber": "3809087654321500",
      "accountName": "Joe's Savings Account",
      "accountId": "079a88ea-276d-41fb-a1f1-366ef3e22921",
      "accountType": "BANK",
      "currency": "AUD",
      "country": "GB",
      "status": "REJECTED",
      "error": {
        "title": "Invalid Application",
        "status": 403,
        "detail": "The application has not been configured to use these API endpoints.",
        "type": "invalid-application"
      }
    }
  ]
}

Changes

Changed in 1 of the 54 revisions of this API.1

Jan 15, 2024dc639fa380c71See the full diff
- ○
  removed the enum value from the // response property for the response status
  response-property-enum-value-removed

Full history