Payments Canada · Authentication Profile

Payments Canada Authentication

Authentication

Payments Canada secures its APIs with apiKey and oauth2 across 2 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the clientCredentials flow(s).

Financial ServicesPaymentsCanadaPayment InfrastructureClearing and SettlementReal-Time RailISO 20022LynxCrown CorporationFaster Payments
Methods: apiKey, oauth2 Schemes: 2 OAuth flows: clientCredentials API key in: header

Security Schemes

Bearer apiKey
· in: header (Authorization)
oAuth oauth2
· flows: clientCredentials

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-23'
method: derived
source: openapi/fif-branch-api-openapi.yml, openapi/fif-extracts-api-openapi.yml, openapi/rtr-balance-report-api-openapi.yml,
  openapi/rtr-inbound-csp-heartbeat-api-openapi.yml, openapi/rtr-inbound-participant-payment-api-openapi.yml,
  openapi/rtr-interest-report-api-openapi.yml
summary:
  types:
  - apiKey
  - oauth2
  api_key_in:
  - header
  oauth2_flows:
  - clientCredentials
schemes:
- name: Bearer
  type: apiKey
  in: header
  parameter: Authorization
  sources:
  - openapi/fif-branch-api-openapi.yml
  - openapi/fif-extracts-api-openapi.yml
- name: oAuth
  type: oauth2
  flows:
  - flow: clientCredentials
    tokenUrl: https://api.payments.ca/accesstoken
    scopes: 1
  description: This API uses OAuth 2 with the implicit grant flow. (The access token expires
    in 5 minutes)
  sources:
  - openapi/rtr-balance-report-api-openapi.yml
  - openapi/rtr-inbound-csp-heartbeat-api-openapi.yml
  - openapi/rtr-inbound-participant-payment-api-openapi.yml
  - openapi/rtr-interest-report-api-openapi.yml