RTR Sandbox - Payment Capacity Balance Report API
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.
RTR Sandbox - Payment Capacity Balance Report 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 Real-Time Rail, Clearing and Settlement, and ISO 20022. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 1 operation across 1 path, and defines 44 schemas. It is described by OpenAPI 3.0.3, at version 1.1.0.
Requests are made against a single base URL, https://api.payments.ca/rtr-sandbox.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
RTR Sandbox - Payment Capacity Balance Report API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oAuth) using the clientCredentials flow, exposing 1 scope.
oAuth— This API uses OAuth 2 with the implicit grant flow. (The access token expires in 5 minutes)
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are BalanceRequest (2 properties), BalanceResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payments Canada 9
Other APIs Payments Canada publishes across the network.