Scotiabank Request for Payment API

openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation Request for Payment 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: Request for Payment
paths:
  /v1/payments/request-for-payment:
    post:
      operationId: sendRequestForPayment
      summary: Send Request for Payment
      description: Request a payment from another party via email with payment status tracking support.
      tags:
      - Request for Payment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestForPaymentRequest'
      responses:
        '201':
          description: Payment request sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestForPaymentResponse'
        '400':
          description: Bad request
components:
  schemas:
    RequestForPaymentRequest:
      type: object
      properties:
        amount:
          type: number
        payer_email:
          type: string
          format: email
        due_date:
          type: string
          format: date
        message:
          type: string
    RequestForPaymentResponse:
      type: object
      properties:
        request_id:
          type: string
        status:
          type: string
        created_at:
          type: string
          format: date-time
  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