Scotiabank

opencollection: 1.0.0
info:
  name: Scotiabank Scotia TranXact APIs
  version: '1.0'
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://developer.api.scotiabank.com/auth/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Wire Payments
    type: folder
  items:
  - info:
      name: Initiate Wire Payment
      type: http
    http:
      method: POST
      url: https://developer.api.scotiabank.com/v1/payments/wire
      body:
        type: json
        data: '{}'
    docs: 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.
  - info:
      name: Get Wire Payment
      type: http
    http:
      method: GET
      url: https://developer.api.scotiabank.com/v1/payments/wire/:payment_id
      params:
      - name: payment_id
        value: ''
        type: path
        description: Wire payment identifier
    docs: Retrieve the status and details of a wire payment by payment ID.
- info:
    name: Real-Time Payments
    type: folder
  items:
  - info:
      name: Initiate Real-Time Payment
      type: http
    http:
      method: POST
      url: https://developer.api.scotiabank.com/v1/payments/realtime
      body:
        type: json
        data: '{}'
    docs: Send a real-time business payment via INTERAC e-Transfer for business. Supports payments up to $25,000 per transaction.
- info:
    name: Request for Payment
    type: folder
  items:
  - info:
      name: Send Request for Payment
      type: http
    http:
      method: POST
      url: https://developer.api.scotiabank.com/v1/payments/request-for-payment
      body:
        type: json
        data: '{}'
    docs: Request a payment from another party via email with payment status tracking support.
- info:
    name: EFT Payments
    type: folder
  items:
  - info:
      name: Create EFT Payment
      type: http
    http:
      method: POST
      url: https://developer.api.scotiabank.com/v1/payments/eft
      body:
        type: json
        data: '{}'
    docs: Create and submit an Electronic Funds Transfer (EFT) payment. Supports batch EFT file submission.
  - info:
      name: Get EFT Payment
      type: http
    http:
      method: GET
      url: https://developer.api.scotiabank.com/v1/payments/eft/:payment_id
      params:
      - name: payment_id
        value: ''
        type: path
    docs: Retrieve the status and details of an EFT payment.
  - info:
      name: Update EFT Payment
      type: http
    http:
      method: PATCH
      url: https://developer.api.scotiabank.com/v1/payments/eft/:payment_id
      params:
      - name: payment_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update or recall/reverse an EFT payment before processing.
  - info:
      name: Delete EFT Payment
      type: http
    http:
      method: DELETE
      url: https://developer.api.scotiabank.com/v1/payments/eft/:payment_id
      params:
      - name: payment_id
        value: ''
        type: path
    docs: Delete an EFT payment before processing.
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: List Accounts
      type: http
    http:
      method: GET
      url: https://developer.api.scotiabank.com/v1/accounts
    docs: Retrieve a list of eligible deposit accounts for the authenticated customer.
  - info:
      name: Get Account Balance
      type: http
    http:
      method: GET
      url: https://developer.api.scotiabank.com/v1/accounts/:account_id/balance
      params:
      - name: account_id
        value: ''
        type: path
        description: Account identifier
      - name: date
        value: ''
        type: query
        description: Date for prior-day balance (YYYY-MM-DD format, defaults to current day)
    docs: Retrieve the current or prior day account balance. Supports retrieval of enriched balance data including opening
      and closing balances.
  - info:
      name: List Account Transactions
      type: http
    http:
      method: GET
      url: https://developer.api.scotiabank.com/v1/accounts/:account_id/transactions
      params:
      - name: account_id
        value: ''
        type: path
        description: Account identifier
      - name: from_date
        value: ''
        type: query
        description: Start date for transactions (YYYY-MM-DD)
      - name: to_date
        value: ''
        type: query
        description: End date for transactions (YYYY-MM-DD)
      - name: page
        value: ''
        type: query
      - name: page_size
        value: ''
        type: query
    docs: Retrieve enriched transaction data for an account. Data available for up to two years prior to the current date.
- info:
    name: Account Validation
    type: folder
  items:
  - info:
      name: Validate Account
      type: http
    http:
      method: POST
      url: https://developer.api.scotiabank.com/v1/accounts/validate
      body:
        type: json
        data: '{}'
    docs: Verify the validity of an account number format and indicate the likelihood of account ownership match for Scotiabank
      accounts.
- info:
    name: Payment Tracking
    type: folder
  items:
  - info:
      name: Track Payment
      type: http
    http:
      method: GET
      url: https://developer.api.scotiabank.com/v1/payments/track/:reference_id
      params:
      - name: reference_id
        value: ''
        type: path
        description: Unique End-to-End Transaction Reference (UETR)
    docs: Inquire on the status of a wire payment using its unique reference number (UETR). Powered by SWIFT GPI for real-time
      tracking.
bundled: true