Scotiabank EFT Payments API

openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation EFT 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: EFT Payments
paths:
  /v1/payments/eft:
    post:
      operationId: createEFTPayment
      summary: Create EFT Payment
      description: Create and submit an Electronic Funds Transfer (EFT) payment. Supports batch EFT file submission.
      tags:
      - EFT Payments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EFTPaymentRequest'
      responses:
        '201':
          description: EFT payment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EFTPaymentResponse'
        '400':
          description: Bad request
  /v1/payments/eft/{payment_id}:
    get:
      operationId: getEFTPayment
      summary: Get EFT Payment
      description: Retrieve the status and details of an EFT payment.
      tags:
      - EFT Payments
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: EFT payment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EFTPaymentResponse'
    patch:
      operationId: updateEFTPayment
      summary: Update EFT Payment
      description: Update or recall/reverse an EFT payment before processing.
      tags:
      - EFT Payments
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: EFT payment updated
    delete:
      operationId: deleteEFTPayment
      summary: Delete EFT Payment
      description: Delete an EFT payment before processing.
      tags:
      - EFT Payments
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: EFT payment deleted
components:
  schemas:
    EFTPaymentResponse:
      type: object
      properties:
        payment_id:
          type: string
        file_id:
          type: string
        status:
          type: string
        created_at:
          type: string
          format: date-time
    EFTPaymentRequest:
      type: object
      properties:
        payment_type:
          type: string
          enum:
          - CREDIT
          - DEBIT
        amount:
          type: number
        debit_account:
          type: string
        credit_account:
          type: string
        effective_date:
          type: string
          format: date
        transaction_code:
          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