aid: payments-canada url: https://raw.githubusercontent.com/api-evangelist/payments-canada/refs/heads/main/apis.yml name: Payments Canada kind: company description: >- Payments Canada (formerly the Canadian Payments Association) is the public-purpose organization created by federal statute (the Canadian Payments Act) that owns and operates Canada's core national payment clearing and settlement infrastructure, under the oversight of the Bank of Canada and the Minister of Finance. Its members are Canada's financial institutions. It operates Lynx (the high-value, ISO 20022 real-time gross settlement system that replaced LVTS), the Automated Clearing Settlement System (ACSS, Canada's retail batch/ACH rail), and is building the Real-Time Rail (RTR) — a 24/7/365 irrevocable faster-payments system fully based on the ISO 20022 messaging standard. Payments Canada is payments infrastructure, distinct from Canada's Consumer-Driven Banking (open banking) framework, which is legislated but not yet operational and overseen by the FCAC. It runs a real, publicly registerable API developer portal (developer.payments.ca, launched February 19, 2020) exposing member/registered-user sandbox and data-extract APIs — including downloadable RTR sandbox OpenAPI specifications — secured with OAuth2 client-credentials (Consumer Key/Secret via Apigee); production access is license/agreement gated. image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg tags: - Financial Services - Payments - Canada - Payment Infrastructure - Clearing and Settlement - Real-Time Rail - ISO 20022 - Lynx - Crown Corporation - Faster Payments created: '2026-07-23' modified: '2026-07-23' specificationVersion: '0.19' apis: - aid: payments-canada:rtr-inbound-participant-payment-api name: RTR Sandbox - Inbound Participant Payment API description: >- Real-Time Rail sandbox API for sending an RTR payment (ISO 20022 pacs.008 Customer Credit Transfer) to another RTR participant and enquiring on payment status (pacs.028), returning a payment status report (pacs.002) or message reject (admi.002). OAuth2 client-credentials; OpenAPI 3.0.3 harvested verbatim from the developer portal Swagger UI. humanURL: https://developer.payments.ca/rtr-sandbox-api/apis baseURL: https://api.payments.ca/rtr-sandbox tags: - Real-Time Rail - Payments - ISO 20022 properties: - type: OpenAPI url: openapi/rtr-inbound-participant-payment-api-openapi.yml - type: Overlay url: overlays/rtr-inbound-participant-payment-api-overlay.yaml - type: Documentation url: https://developer.payments.ca/rtr-sandbox-api/apis - type: APIReference url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html - aid: payments-canada:rtr-inbound-heartbeat-api name: RTR Sandbox - Inbound Exchange Heartbeat API description: >- Real-Time Rail sandbox API for sending heartbeat requests between a participant and the RTR exchange (ISO 20022 admi.004 System Event Notification), returning admi.011 System Event Acknowledgement or admi.002 Message Reject. OAuth2 client-credentials; OpenAPI 3.0.3 harvested verbatim. humanURL: https://developer.payments.ca/rtr-sandbox-api/apis baseURL: https://api.payments.ca/rtr-sandbox tags: - Real-Time Rail - ISO 20022 - Monitoring properties: - type: OpenAPI url: openapi/rtr-inbound-csp-heartbeat-api-openapi.yml - type: Overlay url: overlays/rtr-inbound-csp-heartbeat-api-overlay.yaml - type: Documentation url: https://developer.payments.ca/rtr-sandbox-api/apis - type: APIReference url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html - aid: payments-canada:rtr-interest-report-api name: RTR Sandbox - Interest Report API description: >- Real-Time Rail sandbox clearing-and-settlement API that calls the C&S system to generate an interest report (ISO 20022 camt.003 Get Account returning camt.004 Return Account with interest data). OAuth2 client-credentials; OpenAPI 3.0.3 harvested verbatim. humanURL: https://developer.payments.ca/rtr-sandbox-api/apis baseURL: https://api.payments.ca/rtr-sandbox tags: - Real-Time Rail - Clearing and Settlement - ISO 20022 properties: - type: OpenAPI url: openapi/rtr-interest-report-api-openapi.yml - type: Overlay url: overlays/rtr-interest-report-api-overlay.yaml - type: Documentation url: https://developer.payments.ca/rtr-sandbox-api/apis - type: APIReference url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html - aid: payments-canada:rtr-balance-report-api name: RTR Sandbox - Payment Capacity Balance Report API description: >- Real-Time Rail sandbox clearing-and-settlement API that calls the C&S system to generate a payment-capacity balance report (ISO 20022 camt.003 Get Account returning camt.004 Return Account with balance data). OAuth2 client-credentials; OpenAPI 3.0.3 harvested verbatim. humanURL: https://developer.payments.ca/rtr-sandbox-api/apis baseURL: https://api.payments.ca/rtr-sandbox tags: - Real-Time Rail - Clearing and Settlement - ISO 20022 properties: - type: OpenAPI url: openapi/rtr-balance-report-api-openapi.yml - type: Overlay url: overlays/rtr-balance-report-api-overlay.yaml - type: Documentation url: https://developer.payments.ca/rtr-sandbox-api/apis - type: APIReference url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html - aid: payments-canada:lynx-sandbox-api name: Lynx Sandbox API description: >- Sandbox APIs giving members access to test-data interactions with Lynx, Canada's high-value ISO 20022 real-time gross settlement system. Access is member-gated (contact your organization's Access Officer / Security Officer); no downloadable OpenAPI is published publicly for Lynx. humanURL: https://developer.payments.ca/lynx-sandbox-api/apis tags: - Lynx - High-Value Payments - ISO 20022 properties: - type: Documentation url: https://developer.payments.ca/lynx-sandbox-api/apis - aid: payments-canada:acss-api name: ACSS API description: >- APIs for the Automated Clearing Settlement System (ACSS), Canada's retail batch/ACH clearing rail. Access is member-gated via the developer portal. humanURL: https://developer.payments.ca/acss-api/apis tags: - ACSS - Retail Payments - Clearing and Settlement properties: - type: Documentation url: https://developer.payments.ca/acss-api/apis - aid: payments-canada:fif-extracts-api name: FIF Extracts API description: >- Financial Institutions File (FIF) extracts API returning master and weekly updated extract data for Canadian financial institutions. Registered-user access via the developer portal. humanURL: https://developer.payments.ca/fif-extracts-api/apis baseURL: https://api.payments.ca/fif-extracts tags: - Financial Institutions File - Reference Data properties: - type: OpenAPI url: openapi/fif-extracts-api-openapi.yml - type: Documentation url: https://developer.payments.ca/fif-extracts-api/apis - type: Overlay url: overlays/fif-extracts-api-overlay.yaml - aid: payments-canada:fif-branch-api name: FIF Branch API description: >- Financial Institutions File (FIF) branch API returning weekly branch extract data for Canadian financial institutions. Registered-user access via the developer portal. humanURL: https://developer.payments.ca/fif-branch-api/apis baseURL: https://api.payments.ca/fif-branch tags: - Financial Institutions File - Reference Data properties: - type: OpenAPI url: openapi/fif-branch-api-openapi.yml - type: Documentation url: https://developer.payments.ca/fif-branch-api/apis - type: Overlay url: overlays/fif-branch-api-overlay.yaml - aid: payments-canada:ccin-extracts-api name: CCIN Extracts API description: >- Corporate Creditor Identification Number (CCIN) extracts API returning master and updated extract data matching the weekly file distribution. Registered-user access via the developer portal. humanURL: https://developer.payments.ca/ccin-extracts-api/apis baseURL: https://api.payments.ca tags: - CCIN - Reference Data properties: - type: OpenAPI url: openapi/ccin-extracts-api-openapi.yml - type: Documentation url: https://developer.payments.ca/ccin-extracts-api/apis - type: Overlay url: overlays/ccin-extracts-api-overlay.yaml - aid: payments-canada:ccin-lookup-api name: CCIN Lookup API description: >- Corporate Creditor Identification Number (CCIN) single-lookup API returning weekly extract data for a specific corporate creditor. Registered-user access via the developer portal. humanURL: https://developer.payments.ca/ccin-lookup-api/apis baseURL: https://api.payments.ca tags: - CCIN - Reference Data properties: - type: OpenAPI url: openapi/ccin-lookup-api-openapi.yml - type: Documentation url: https://developer.payments.ca/ccin-lookup-api/apis - type: Overlay url: overlays/ccin-lookup-api-overlay.yaml common: - type: DomainSecurity url: security/payments-canada-domain-security.yml - type: AgenticAccess url: agentic-access/payments-canada-agentic-access.yml - type: OAuthScopes url: scopes/payments-canada-scopes.yml - type: Authentication url: authentication/payments-canada-authentication.yml - type: Conventions url: conventions/payments-canada-conventions.yml - type: ErrorCatalog url: errors/payments-canada-problem-types.yml - type: Conformance url: conformance/payments-canada-conformance.yml - type: Lifecycle url: lifecycle/payments-canada-lifecycle.yml - type: DataModel url: data-model/payments-canada-data-model.yml - type: WellKnown url: well-known/payments-canada-well-known.yml - type: Sandbox url: sandbox/payments-canada-sandbox.yml - type: MCPServer url: mcp/payments-canada-mcp.yml - type: ToolCrosswalk url: mcp/payments-canada-tool-crosswalk.yml - type: LLMsTxt url: llms/payments-canada-llms.txt - type: AgentSkill url: skills/_index.yml - type: Website url: https://www.payments.ca/ - type: DeveloperPortal url: https://developer.payments.ca/ - type: Documentation url: https://developer.payments.ca/apis - type: GettingStarted url: https://developer.payments.ca/getting-started - type: GitHubOrganization url: https://github.com/paymentscanada - type: APIStandards url: https://developer.payments.ca/payments-canada-api-standards - type: Postman url: https://github.com/paymentscanada/api-toolkit/tree/develop/postman-collection - type: Support url: https://developer.payments.ca/content/contact-us - type: TermsOfService url: https://developer.payments.ca/legal - type: PrivacyPolicy url: https://developer.payments.ca/legal - type: LinkedIn url: https://www.linkedin.com/company/payments-canada - type: Twitter url: https://twitter.com/paymentscanada maintainers: - FN: Kin Lane email: kin@apievangelist.com