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 Extracts API

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

FIF Extracts 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 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 2.0, at version 1.0.

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

2 operations 2 paths 3 schemas 2 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-extracts
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 2

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

fif-extracts-resource 2

Fif Extracts Resource

GET
/extracts/master
Get the master extract. Defaults to last completed cycle unless specific date in 'asAtDate' parameter
getMaster 2 params → 200400401404406500
GET
/extracts/updated
Get the updated branches from the extracts for a given asAtDate range between the 'startDate' and 'endDate'
getUpdate 2 params → 200400401404406500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are UpdatesRecord (21 properties), MasterRecord (20 properties), ValueFlag (2 properties). Each schema is shown below with its type and property counts.

MasterRecord
object
20 properties
UpdatesRecord
object
21 properties
ValueFlag
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fif-extracts-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 Branch API
CCIN Extracts API
CCIN Lookup API