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

FIF Branch API

Financial Institutions File (FIF) branch API returning weekly branch extract data for Canadian financial institutions. Registered-user access via the developer portal.

FIF Branch API is one of 10 APIs that Payments Canada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Financial Institutions File and Reference Data. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://api.payments.ca/fif-branch.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.payments.ca/fif-branch
Authentication
API Key
Resource Areas
1

Authentication & Security 1

FIF Branch API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

fif-branches-resource 1

Fif Branches Resource

GET
/branches/{dprn}
Get branch details by DPRN from a given asAtDate - if no date is provided, latest completed cycle is used.
getBranchById 2 params → 200400401404406500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is MasterRecord (20 properties). Each schema is shown below with its type and property counts.

MasterRecord
object
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fif-branch-api-openapi.yml Raw ↑

Other APIs Payments Canada publishes across the network.

RTR Sandbox - Inbound Participant Payment API
RTR Sandbox - Inbound Exchange Heartbeat API
RTR Sandbox - Interest Report API
RTR Sandbox - Payment Capacity Balance Report API
Lynx Sandbox API
ACSS API
FIF Extracts API
CCIN Extracts API
CCIN Lookup API