find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

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

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Payment Capacity Balance Report API
  description: These APIs calls the C&S system to generate an balance report.
  version: 1.1.0
servers:
- url: https://api.payments.ca/rtr-sandbox
  description: Sandbox Environment
tags:
- name: Report
paths:
  /payment-capacity-balance-report:
    post:
      tags:
      - Report
      description: This service can be used by the Participants to retrieve the Balance Report. Message format - ISO 20022 camt.003.001.07 with BAH ISO 20022 head.001.001.02
      parameters:
      - $ref: '#/components/parameters/x-jws-signature'
      - $ref: '#/components/parameters/traceability-id'
      requestBody:
        content:
          application/vnd.api.v1+json:
            schema:
              $ref: '#/components/schemas/BalanceRequest'
        required: true
      security:
      - oAuth:
        - client_credentials
      responses:
        '200':
          description: ISO 20022 camt.004.001.08 (or) ISO 20022 admi.002.001.01, with BAH - ISO 20022 head.001.001.02
          content:
            application/vnd.api.v1+json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
          headers:
            x-jws-signature:
              $ref: '#/components/parameters/x-jws-signature'
            traceability-id:
              $ref: '#/components/parameters/traceability-id'
        '401':
          description: Unauthorized
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          headers:
            traceability-id:
              $ref: '#/components/parameters/traceability-id'
      summary: Create payment capacity balance report
      x-summary-source: derived
      operationId: postPaymentCapacityBalanceReport
      x-operation-id-source: derived
components:
  schemas:
    BalanceResponse:
      type: object
      oneOf:
      - type: object
        properties:
          return_account:
            $ref: '#/components/schemas/ReturnAccountV08'
        required:
        - return_account
      - type: object
        properties:
          message_reject:
            $ref: '#/components/schemas/MessageReject'
        required:
        - message_reject
      properties:
        business_application_header:
          $ref: '#/components/schemas/BusinessApplicationHeaderV02'
      required:
      - business_application_header
    MessageReject:
      $ref: iso_models/admi_002.yaml#/components/schemas/MessageReject
    BalanceRequest:
      type: object
      properties:
        get_account:
          $ref: '#/components/schemas/GetAccountV07'
        business_application_header:
          $ref: '#/components/schemas/BusinessApplicationHeaderV02'
      required:
      - get_account
      - business_application_header
    GetAccountV07:
      $ref: iso_models/camt_003.yaml#/components/schemas/GetAccountV07
    ReturnAccountV08:
      $ref: iso_models/camt_004.yaml#/components/schemas/ReturnAccountV08
    BusinessApplicationHeaderV02:
      $ref: iso_models/head_002.yaml#/components/schemas/BusinessApplicationHeaderV02
  parameters:
    x-jws-signature:
      in: header
      name: x-jws-signature
      description: JSON Web Signature (JWS) of the payload
      schema:
        type: string
        minLength: 1
        example: eyJjcml0IjpbImlhdCJdLCJpYXQiOjE2MzcyNzIxMzUyNTIsImFsZyI6IlJTMjU2Iiwia2lkIjoic2lnbi1rZXktY2EwMDAwMDEtMDAxIn0.V7skMzl3rUZK7N5pYVlicNt3TWXNBZyX-rtNV7n5rOc.hBDcIL9ptXWfOsg2pRSTy5dzFsowqjvE0G8dglODTSFpRM-iL1khjomuaYx_LnZV_lTnwkfMHknLdJuG5ucM7gpTZ98a1egjTcQisWHRO0fCr-sxqZXusGIB-hgAnB16Fn9UtdNdzsl447C0c3sSmytYn6eeMu5c6RWVrq-xB5KD9_JGexpyTw3IBvXavpd7h7QgnNzmcdWjV0yVXh74x4gmD8hTSbRkv54MYzap2BSFXLgxCwOrS7Jw0tQzCcP8a7gcOunO9Zr3ArgH-4Ur0VRWxIH4GaDksCBKdx1JdXFUToqG5Ben-FNyAzxkVxtuuwYMCbT1I3-8mCoj7nTtYw
      required: true
    traceability-id:
      in: header
      name: traceability-id
      description: Unique Id that can be used to trace the request.
      schema:
        type: string
        format: uuid
        example: 93334d98-e1d0-4158-a1f7-302b22af4f6d
      required: true
  securitySchemes:
    oAuth:
      type: oauth2
      description: This API uses OAuth 2 with the implicit grant flow. (The access token expires in 5 minutes)
      flows:
        clientCredentials:
          tokenUrl: https://api.payments.ca/accesstoken
          scopes:
            client_credentials: Required to get credentials for the API call