RTR Sandbox - Inbound Participant Payment API
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.
RTR Sandbox - Inbound Participant Payment 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, Payments, and ISO 20022. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, organized into 2 resource areas, and defines 6 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 - Inbound Participant Payment 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 2
Across 2 paths, the API surfaces 2 operations — 2 POST. They span 2 resource areas: single credit transfer, single credit transfer status enquiry. Each is listed below with its method, path, parameters, and response codes.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SyntaxError (1 property), PaymentStatusReport (1 property), IsoHeader (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.