Scotiabank

Scotiabank Payment Tracking API

The Payment Tracking API from Scotiabank — 1 operation(s) for payment tracking.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.scotiabank.com/en.html
📖
GettingStarted
https://developer.scotiabank.com/content/scotiabank/developer/api/en/getting-started.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/openapi/scotiabank-payment-tracking-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/json-schema/scotiabank-transaction-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/json-structure/scotiabank-wire-payment-structure.json

Other Resources

🔗
DeveloperPortal
https://developer.scotiabank.com/en.html
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/rules/scotiabank-rules.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/json-ld/scotiabank-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/examples/scotiabank-initiate-wire-payment-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/scotiabank/refs/heads/main/vocabulary/scotiabank-vocabulary.yml

OpenAPI Specification

scotiabank-payment-tracking-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation Payment Tracking 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: Payment Tracking
paths:
  /v1/payments/track/{reference_id}:
    get:
      operationId: trackPayment
      summary: Track Payment
      description: Inquire on the status of a wire payment using its unique reference number (UETR). Powered by SWIFT GPI for real-time tracking.
      tags:
      - Payment Tracking
      parameters:
      - name: reference_id
        in: path
        required: true
        description: Unique End-to-End Transaction Reference (UETR)
        schema:
          type: string
      responses:
        '200':
          description: Payment tracking status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentTrackingResponse'
        '404':
          description: Payment not found
components:
  schemas:
    PaymentTrackingResponse:
      type: object
      properties:
        uetr:
          type: string
        status:
          type: string
        status_description:
          type: string
        events:
          type: array
          items:
            type: object
            properties:
              timestamp:
                type: string
                format: date-time
              status:
                type: string
              location:
                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