Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CCIN Extracts API

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.

CCIN Extracts API is one of 10 APIs that Payments Canada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CCIN and Reference Data. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, organized into 2 resource areas, and defines 3 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://api.payments.ca.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.payments.ca
Resource Areas
2

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. They span 2 resource areas: master-extract-resource, update-extract-resource. Each is listed below with its method, path, parameters, and response codes.

master-extract-resource 1

Master Extract Resource

GET
/api/v1/extracts/master
Retrieve the master extract
getMasterExtractUsingGET 7 params → 200
update-extract-resource 1

Update Extract Resource

GET
/api/v1/extracts/updated
Get the Update Extract for the most recent cycle
getUpdateExtractUsingGET 7 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Master_Extract_Record (20 properties), Update_Extract_Record (18 properties), Value_Changed (2 properties). Each schema is shown below with its type and property counts.

Master_Extract_Record
object
20 properties
Update_Extract_Record
object
18 properties
Value_Changed
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ccin-extracts-api-openapi.yml Raw ↑

Other APIs Payments Canada publishes across the network.

RTR Sandbox - Inbound Participant Payment API
RTR Sandbox - Inbound Exchange Heartbeat API
RTR Sandbox - Interest Report API
RTR Sandbox - Payment Capacity Balance Report API
Lynx Sandbox API
ACSS API
FIF Extracts API
FIF Branch API
CCIN Lookup API