Payments Canada Developer Portal

API Specifications

Explore our products and APIs. Each API specification includes the API description, API URL, and Payload details (header, request parameters, response, error codes). With proper authentication, any user can test API connectivity through the catalogue. The proxy resources have Sandbox (Accessible by Registered Users) and Live APIs (Accessible by Production Users).

API to generate access token using the Consumer Key and Consumer Secret.

API to retrieve CCIN master and updated extract data. The information corresponds to the the same data provided through weekly master and updated extract files from CCIN.

API to retrieve single CCIN lookup. The information corresponds to the the same data provided through weekly extract files from CCIN for a specific Corporate Creditor.

API to retrieve branch extract data. The information corresponds to the the same data provided through weekly extract files from FIF for a specific branch.

API to retrieve master and updated extract data. The information corresponds to the the same data provided through weekly master and updated extract files from FIF.

API For Lynx Sandbox. **Note: To have access to the APIs please contact your Organization’s Access Officer (A.O.) or Security Officer.

These illustrative APIs are built with the purpose of allowing consumers to envision how a future real time payments rail will look and function. These APIs are based on the ISO 20022 messaging standard and are subject to change and evolve with the needs of the ecosystem.