Connexis Cash Balances API

The Balances API from Connexis Cash — 1 operation(s) for balances.

Specifications

OpenAPI Specification

connexis-cash-balances-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: BNP Paribas Connexis Cash - STET PSD2 Account Information (AISP) Accounts Balances API
  description: 'PSD2 Account Information Service (AISP) for BNP Paribas Connexis Cash,

    exposed by BNP Paribas CIB and aligned to the French STET PSD2 standard

    (1.4.0.47, Full-AISP "A1" model). Authentication uses OAuth 2.0

    Authorization Code in production (Client Credentials in sandbox) and

    requires a QWAC for TLS. The mock sandbox returns simulated data only.

    '
  version: 1.4.0
  contact:
    name: BNP Paribas CIB Developer Portal
    url: https://developers.cib.bnpparibas.com/index.php/api-docs/account-information-psd2-stet-mock
servers:
- url: https://psd2.api.cib.bnpparibas.com/gb-account-information-psd2-stet
  description: BNP Paribas CIB - PSD2 STET AISP (production / mock)
security:
- oauth2:
  - aisp
tags:
- name: Balances
paths:
  /v1/accounts/{accountResourceId}/balances:
    get:
      tags:
      - Balances
      summary: Retrieve balances for an account
      parameters:
      - in: path
        name: accountResourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account balances
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/BalanceList'
components:
  schemas:
    BalanceList:
      type: object
      properties:
        balances:
          type: array
          items:
            $ref: '#/components/schemas/Balance'
    Balance:
      type: object
      properties:
        name:
          type: string
        balanceAmount:
          type: object
          properties:
            amount:
              type: string
            currency:
              type: string
        balanceType:
          type: string
        referenceDate:
          type: string
          format: date
        lastChangeDateTime:
          type: string
          format: date-time
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.cib.bnpparibas.com/oauth2/v1/authorize
          tokenUrl: https://api.cib.bnpparibas.com/oauth2/v1/token
          scopes:
            aisp: Account Information Service
        clientCredentials:
          tokenUrl: https://api.cib.bnpparibas.com/oauth2/v1/token
          scopes:
            aisp: Account Information Service (sandbox)