Scotiabank Wire Payments API

openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation Wire 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: Wire Payments
paths:
  /v1/payments/wire:
    post:
      operationId: initiateWirePayment
      summary: Initiate Wire Payment
      description: Initiate a secure one-time wire transfer between two accounts in the same currency (CAD or USD), domestically within Canada and the U.S., or internationally. Powered by the SWIFT GPI-enabled network with UETR for real-time tracking.
      tags:
      - Wire Payments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WirePaymentRequest'
      responses:
        '201':
          description: Wire payment initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WirePaymentResponse'
        '400':
          description: Bad request - invalid payment details
        '401':
          description: Unauthorized - authentication required
        '422':
          description: Unprocessable entity - business rule violation
  /v1/payments/wire/{payment_id}:
    get:
      operationId: getWirePayment
      summary: Get Wire Payment
      description: Retrieve the status and details of a wire payment by payment ID.
      tags:
      - Wire Payments
      parameters:
      - name: payment_id
        in: path
        required: true
        description: Wire payment identifier
        schema:
          type: string
      responses:
        '200':
          description: Wire payment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WirePaymentResponse'
        '404':
          description: Payment not found
components:
  schemas:
    WirePaymentResponse:
      type: object
      properties:
        payment_id:
          type: string
        uetr:
          type: string
          description: Unique End-to-End Transaction Reference (SWIFT GPI)
        status:
          type: string
          enum:
          - PENDING
          - PROCESSING
          - COMPLETED
          - FAILED
        created_at:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
    WirePaymentRequest:
      type: object
      required:
      - amount
      - currency
      - debit_account
      - credit_account
      properties:
        amount:
          type: number
          description: Payment amount
        currency:
          type: string
          enum:
          - CAD
          - USD
          description: Payment currency
        debit_account:
          type: object
          properties:
            account_number:
              type: string
            institution_number:
              type: string
            transit_number:
              type: string
        credit_account:
          type: object
          properties:
            account_number:
              type: string
            bank_code:
              type: string
            country:
              type: string
            name:
              type: string
        remittance_information:
          type: string
          description: Payment reference or memo
        value_date:
          type: string
          format: date
  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