Payments Canada

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.

Payments Canada publishes 12 API contracts indexed on the APIs.io network, including application level heartbeat API, Ccin Extract Resource API, Fif Branches Resource API, and 9 more. Tagged areas include Financial Services, Payments, Canada, Payment Infrastructure, and Clearing and Settlement.

The Payments Canada catalog on APIs.io includes 1 Spectral governance ruleset.

Payments Canada’s developer surface includes authentication, sandbox, documentation, getting-started guide, support, and 32 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

42.4/100 developing ▬ flat Agent 24/100 agent aware Front door AI 2/6 trace Heartbeat 50/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

8 published contracts 3 Agent Skills

Financial Services Payments Canada Payment InfrastructureClearing and SettlementReal-Time RailISO 20022LynxCrown Corporation Faster Payments

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Payments & Card Management

BC-1340

single credit transfersingle credit transfer status enquiry

POST /payments POST /payments/status

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 42.4/100 · developing

Contract Quality 8.4 / 19

Developer Ergonomics 10.3 / 15

Access Clarity 3.2 / 15

Operational Transparency 0.3 / 10

Contract Governance 2.9 / 9

Discoverability 5.2 / 8

Regulatory Posture 5.8 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 24/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 0 / 7

Typed Event Surface 0 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/payments-canada/"><img src="https://apis.io/badge/payments-canada/card.svg" alt="Payments Canada on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Rate-Limit Signaling +7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented)
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document

8 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 21.1 — up to +15.8 composite points
Contract Quality scores 44.8 — up to +13.8 composite points
Operational Transparency scores 2.6 — up to +12.7 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/payments-canada/apis.yml: open an issue on github.com/api-evangelist/payments-canada to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Canada RPAA Payment Service Providers (Bank of Canada registry + Payments Canada)	standard	17.2 (thin)	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 3

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

ISO 20022

tagged — the provider's own APIs.json carries the standard as a tag; implementation not verified

OpenAPI

measured — observed by APIs.io (published)

OAuth 2.0

measured — observed by APIs.io (declared)

APIs 12

Individual APIs this provider publishes, each with its own machine-readable definition.

Lynx Sandbox API

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 org...

ACSS API

APIs for the Automated Clearing Settlement System (ACSS), Canada's retail batch/ACH clearing rail. Access is member-gated via the developer portal.

Payments Canada application level heartbeat API

The application level heartbeat API from Payments Canada — 1 operation(s) for application level heartbeat.

Payments Canada Ccin Extract Resource API

Ccin Extract Resource

Payments Canada Fif Branches Resource API

Fif Branches Resource

Payments Canada Fif Extracts Resource API

Fif Extracts Resource

Payments Canada Interest Report API

The Interest Report API from Payments Canada — 1 operation(s) for interest report.

Payments Canada Master Extract Resource API

Master Extract Resource

Payments Canada Report API

The report API from Payments Canada — 1 operation(s) for report.

Payments Canada single credit transfer API

The single credit transfer API from Payments Canada — 1 operation(s) for single credit transfer.

Payments Canada single credit transfer status enquiry API

The single credit transfer status enquiry API from Payments Canada — 1 operation(s) for single credit transfer status enquiry.

Payments Canada Update Extract Resource API

Update Extract Resource

Scroll for all 12

Open Collections 8

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

CCIN Output API

OPEN COLLECTION

CCIN Output API

OPEN COLLECTION

FIF Output API

OPEN COLLECTION

FIF Output API

OPEN COLLECTION

Payment Capacity Balance Report

OPEN COLLECTION

Inbound Exchange Heartbeat API

OPEN COLLECTION

Inbound Participant Payment API

OPEN COLLECTION

Interest Report

OPEN COLLECTION

Scroll for all 8

Agent Skills 3

Packaged agent skills for driving this provider's APIs from an AI assistant.

Look up Canadian financial-institution and creditor reference data

AGENT SKILL

Retrieve RTR interest and balance reports

AGENT SKILL

Send an RTR credit transfer and check its status

AGENT SKILL

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Payments Canada API Rules

49 rules · 47 errors 1 warnings 1 info

SPECTRAL

OpenAPI Overlays 8

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Ccin Extracts Api Overlay

1 action · update · ccin-extracts-api-openapi.yml

DERIVED

Ccin Lookup Api Overlay

1 action · update · ccin-lookup-api-openapi.yml

DERIVED

Fif Branch Api Overlay

1 action · update · fif-branch-api-openapi.yml

DERIVED

Fif Extracts Api Overlay

1 action · update · fif-extracts-api-openapi.yml

DERIVED

Rtr Balance Report Api Overlay

1 action · update · rtr-balance-report-api-openapi.yml

DERIVED

Rtr Inbound Csp Heartbeat Api Overlay

1 action · update · rtr-inbound-csp-heartbeat-api-openapi.yml

DERIVED

Rtr Inbound Participant Payment Api Overlay

1 action · update · rtr-inbound-participant-payment-api-openapi.yml

DERIVED

Rtr Interest Report Api Overlay

1 action · update · rtr-interest-report-api-openapi.yml

DERIVED

Scroll for all 8

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Payments Canada Authentication

apiKey/oauth2 · 2 schemes

SECURITY

Payments Canada Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Payments Canada Scopes

1 scope · clientCredentials

1 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Payments Canada Agentic Access

11 operations · 5 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

Sandbox

Sandbox

DeveloperPortal

DeveloperPortal

GettingStarted

GettingStarted

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

WellKnown

WellKnown

X-MCPServerCandidate

X-MCPServerCandidate

LLMsTxt

LLMsTxt

AgentSkill

AgentSkill

Design & Contract 5

Pagination, idempotency, versioning, errors, and events

Conventions

ErrorCatalog

Conformance

Lifecycle

DataModel

Build 3

SDKs, sample code, and the tooling you integrate with

ToolCrosswalk

ToolCrosswalk

GitHubOrganization

GitHubOrganization

Postman

Postman

Access & Security 3

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

OAuthScopes

OAuthScopes

Authentication

Authentication

Operate 1

Status, limits, changes, and where to get help

Support

Support

Commercial 2

Pricing, plans, and the legal terms of use

TermsOfService

TermsOfService

PrivacyPolicy

PrivacyPolicy

Company 4

The organization behind the API

BlogRSS

BlogRSS

Website

Website

LinkedIn

Twitter

Twitter

Other 10

Properties that don't map to a standard resource type

CapabilityMap

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

APIStandards

Scroll for all 10

Source (apis.yml)

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.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - security
  - sandbox
  generated: '2026-11-06'
  method: derived
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
tags_raw:
- Financial Services
- Payments
- Canada
- Payment Infrastructure
- Clearing and Settlement
- Real-Time Rail
- ISO 20022
- Lynx
- Crown Corporation
- Faster Payments
- Financial-Services
created: '2026-07-23'
modified: '2026-10-06'
specificationVersion: '0.23'
apis:
- 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:payments-canada-application-level-heartbeat-api
  name: Payments Canada application level heartbeat API
  description: The application level heartbeat API from Payments Canada — 1 operation(s) for application level heartbeat.
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - application level heartbeat
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-application-level-heartbeat-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-ccin-extract-resource-api
  name: Payments Canada Ccin Extract Resource API
  description: Ccin Extract Resource
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - ccin-extract-resource
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-ccin-extract-resource-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-fif-branches-resource-api
  name: Payments Canada Fif Branches Resource API
  description: Fif Branches Resource
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - fif-branches-resource
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-fif-branches-resource-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-fif-extracts-resource-api
  name: Payments Canada Fif Extracts Resource API
  description: Fif Extracts Resource
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - fif-extracts-resource
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-fif-extracts-resource-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-interest-report-api
  name: Payments Canada Interest Report API
  description: The Interest Report API from Payments Canada — 1 operation(s) for interest report.
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - Interest Report
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-interest-report-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-master-extract-resource-api
  name: Payments Canada Master Extract Resource API
  description: Master Extract Resource
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - master-extract-resource
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-master-extract-resource-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-report-api
  name: Payments Canada Report API
  description: The report API from Payments Canada — 1 operation(s) for report.
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - Report
  tags_raw:
  - report
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-report-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-single-credit-transfer-api
  name: Payments Canada single credit transfer API
  description: The single credit transfer API from Payments Canada — 1 operation(s) for single credit transfer.
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - single credit transfer
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-single-credit-transfer-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-single-credit-transfer-status-enquiry-api
  name: Payments Canada single credit transfer status enquiry API
  description: The single credit transfer status enquiry API from Payments Canada — 1 operation(s) for single credit transfer
    status enquiry.
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - single credit transfer status enquiry
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-single-credit-transfer-status-enquiry-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
- aid: payments-canada:payments-canada-update-extract-resource-api
  name: Payments Canada Update Extract Resource API
  description: Update Extract Resource
  humanURL: https://developer.payments.ca/rtr-sandbox-api/apis
  baseURL: https://api.payments.ca/rtr-sandbox
  tags:
  - update-extract-resource
  properties:
  - type: OpenAPI
    url: openapi/payments-canada-update-extract-resource-api-openapi.yml
  - type: Documentation
    url: https://developer.payments.ca/rtr-sandbox-api/apis
  - type: APIReference
    url: https://storage.googleapis.com/prod-apigee-bucket-swagger/index.html
  - type: Documentation
    url: https://developer.payments.ca/fif-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/fif-branch-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-extracts-api/apis
  - type: Documentation
    url: https://developer.payments.ca/ccin-lookup-api/apis
common:
- url: https://www.payments.ca/rss.xml
  type: BlogRSS
- type: CapabilityMap
  url: capabilities/payments-canada-capability-edges.yml
  name: Payments Canada Business Capability Map
- type: Overlay
  url: overlays/rtr-inbound-participant-payment-api-overlay.yaml
- type: Overlay
  url: overlays/rtr-inbound-csp-heartbeat-api-overlay.yaml
- type: Overlay
  url: overlays/rtr-interest-report-api-overlay.yaml
- type: Overlay
  url: overlays/rtr-balance-report-api-overlay.yaml
- type: Overlay
  url: overlays/fif-extracts-api-overlay.yaml
- type: Overlay
  url: overlays/fif-branch-api-overlay.yaml
- type: Overlay
  url: overlays/ccin-extracts-api-overlay.yaml
- type: Overlay
  url: overlays/ccin-lookup-api-overlay.yaml
- 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: X-MCPServerCandidate
  url: mcp/payments-canada-mcp.yml
  note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
    from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
    correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- 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

Payments Canada API — frequently asked questions

Does Payments Canada have an API?

Yes. APIs.io lists 12 APIs from Payments Canada, including Lynx Sandbox API, ACSS API and Payments Canada application level heartbeat API, and 9 more.

Is there an OpenAPI specification for the Payments Canada API?

Yes. APIs.io indexes 10 OpenAPI specifications for Payments Canada, each linked for download from this page.

How do I authenticate with the Payments Canada API?

Payments Canada documents its authentication (apiKey/oauth2 · 2 schemes). The details are profiled on APIs.io as Payments Canada Authentication.

Is the Payments Canada API ready for AI agents?

Payments Canada has a Kin Score of 42.4 out of 100 (developing) and an Agent Readiness score of 24.3 (agent-aware), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/payments-canada"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/payments-canada/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/payments-canada/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.