Payments Canada Developer Portal

FIF Extracts API

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.

fif-extracts-api-resources

Method
Description
GET 

fif-master-sandbox

https://api.payments.ca/fif-extracts-sandbox/extracts/master
This sandbox API product provides data on the entire branch directory. It is recommended to always use this product when updating your back-end system. The response headers include additional details such as the Cycle Number & Effective Date representing when the information in the file becomes effective. For more information on the branch information found in this product, or on the header response used to validate when the information is considered live, please consult the field description data model.
GET 

fif-updated-sandbox

https://api.payments.ca/fif-extracts-sandbox/extracts/updated
This sandbox API product provides data on the changes that occured within the last 7 days to the branch directory. It is not recommended to use this product for updates to your back-end system. This product gives the provision of finding out a delta over a range of dates by specifying start and end date parameters. The default response headers include additional details such as the Cycle Number & Effective Date representing when the information in the file becomes effective. For more information on the branch information found in this product, or on the header response used to validate when the information is considered live, please consult the field description data model.