Scotiabank Real-Time Payments API

openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation Real-Time Payments 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: Real-Time Payments
paths:
  /v1/payments/realtime:
    post:
      operationId: initiateRealtimePayment
      summary: Initiate Real-Time Payment
      description: Send a real-time business payment via INTERAC e-Transfer for business. Supports payments up to $25,000 per transaction.
      tags:
      - Real-Time Payments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealtimePaymentRequest'
      responses:
        '201':
          description: Real-time payment initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealtimePaymentResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
components:
  schemas:
    RealtimePaymentResponse:
      type: object
      properties:
        payment_id:
          type: string
        status:
          type: string
        created_at:
          type: string
          format: date-time
    RealtimePaymentRequest:
      type: object
      required:
      - amount
      - recipient_email
      properties:
        amount:
          type: number
          maximum: 25000
          description: Payment amount (max $25,000)
        recipient_email:
          type: string
          format: email
          description: Recipient email address for INTERAC e-Transfer
        message:
          type: string
          description: Payment message
        debit_account_number:
          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