Payments Canada Developer Portal

GET  fif-branch-sandbox

This sandbox API product is used to lookup data on a single branch at a time by querying the Direct Payment Routing Number (DPRN) which is a unique numerical number consisting of nine digits. For more information about the branch information received, please consult the field description data model.

Resource URL

https://api.payments.ca /fif-branch-sandbox/branches/{dprn}

Security

Content Type

Category

fif-branch-api-resources

Name Values Description
asAtDate
Retrieve the extract record(s) in effective as at this date (yyyy-MM-dd). If not provided, then the effective date from latest completed cycle is used.
Name Values Description
Accept  (required)
This is a required header. Based on the response type please add the following values for Header Type Accept:
JSON Respons = application/vnd.fif.api.v1+json
TEXT Response = application/vnd.fif.api.v1+text

Request Body

dprn dprn null true

HTTP Basic
OAuth 2.0
API Key
Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

Error Code Description
200 Status OK
400 Bad Request. Possible explanations-
DPRN not formatted properly - needs to be numerical and 9 digits in length
asAtDate should be of type date (yyyy-MM-dd).
404 Branch Not Found
Working...