Scotiabank Accounts API

openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation Accounts API
  description: The Scotia TranXact APIs provide corporate and commercial customers with programmatic access to Scotiabank's payment and cash management services. APIs are designed for integration with Treasury Management Systems (TMS), ERP platforms, and CRM systems. Covers wire payments, real-time payments via INTERAC e-Transfer, EFT payments, account balance and transaction retrieval, account validation, and payment track and trace.
  version: '1.0'
  contact:
    url: https://developer.scotiabank.com/en.html
servers:
- url: https://developer.api.scotiabank.com
  description: Scotiabank API Gateway
security:
- OAuth2: []
tags:
- name: Accounts
paths:
  /v1/accounts:
    get:
      operationId: listAccounts
      summary: List Accounts
      description: Retrieve a list of eligible deposit accounts for the authenticated customer.
      tags:
      - Accounts
      responses:
        '200':
          description: List of accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsListResponse'
        '401':
          description: Unauthorized
  /v1/accounts/{account_id}/balance:
    get:
      operationId: getAccountBalance
      summary: Get Account Balance
      description: Retrieve the current or prior day account balance. Supports retrieval of enriched balance data including opening and closing balances.
      tags:
      - Accounts
      parameters:
      - name: account_id
        in: path
        required: true
        description: Account identifier
        schema:
          type: string
      - name: date
        in: query
        required: false
        description: Date for prior-day balance (YYYY-MM-DD format, defaults to current day)
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Account balance details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalanceResponse'
  /v1/accounts/{account_id}/transactions:
    get:
      operationId: listAccountTransactions
      summary: List Account Transactions
      description: Retrieve enriched transaction data for an account. Data available for up to two years prior to the current date.
      tags:
      - Accounts
      parameters:
      - name: account_id
        in: path
        required: true
        description: Account identifier
        schema:
          type: string
      - name: from_date
        in: query
        required: false
        description: Start date for transactions (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: to_date
        in: query
        required: false
        description: End date for transactions (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          default: 50
      responses:
        '200':
          description: Account transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionsListResponse'
components:
  schemas:
    TransactionsListResponse:
      type: object
      properties:
        account_id:
          type: string
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
        total_count:
          type: integer
        page:
          type: integer
    AccountBalanceResponse:
      type: object
      properties:
        account_id:
          type: string
        date:
          type: string
          format: date
        opening_balance:
          type: number
        closing_balance:
          type: number
        available_balance:
          type: number
        currency:
          type: string
    AccountsListResponse:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/Account'
    Transaction:
      type: object
      properties:
        transaction_id:
          type: string
        date:
          type: string
          format: date
        amount:
          type: number
        credit_debit_indicator:
          type: string
          enum:
          - CREDIT
          - DEBIT
        description:
          type: string
        reference:
          type: string
        balance:
          type: number
    Account:
      type: object
      properties:
        account_id:
          type: string
        account_number:
          type: string
        account_type:
          type: string
        currency:
          type: string
        nickname:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.scotiabank.com/auth/token
          scopes:
            payments:write: Initiate payments
            payments:read: Read payment status
            accounts:read: Read account information