Scotiabank · Schema

Scotiabank Transaction

Schema for a Scotiabank account transaction record

BankingFinancePaymentsCanadaOpen Banking

Properties

Name	Type	Description
transaction_id	string	Unique transaction identifier
account_id	string	Account identifier
date	string	Transaction date (YYYY-MM-DD)
value_date	string	Value date when funds are available
amount	number	Transaction amount (absolute value)
currency	string	Transaction currency
credit_debit_indicator	string	Whether the transaction is a credit or debit to the account
description	string	Enriched transaction description
reference	string	Transaction reference number
category	string	Transaction category (enriched)
counterparty_name	string	Name of the counterparty
counterparty_account	string	Counterparty account number
balance	number	Account balance after the transaction
payment_type	string	Type of payment transaction
uetr	string	Unique End-to-End Transaction Reference for wire payments

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/scotiabank/json-schema/scotiabank-transaction-schema.json",
  "title": "Scotiabank Transaction",
  "description": "Schema for a Scotiabank account transaction record",
  "type": "object",
  "properties": {
    "transaction_id": {
      "type": "string",
      "description": "Unique transaction identifier"
    },
    "account_id": {
      "type": "string",
      "description": "Account identifier"
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "Transaction date (YYYY-MM-DD)"
    },
    "value_date": {
      "type": "string",
      "format": "date",
      "description": "Value date when funds are available"
    },
    "amount": {
      "type": "number",
      "description": "Transaction amount (absolute value)",
      "minimum": 0
    },
    "currency": {
      "type": "string",
      "enum": ["CAD", "USD"],
      "description": "Transaction currency"
    },
    "credit_debit_indicator": {
      "type": "string",
      "enum": ["CREDIT", "DEBIT"],
      "description": "Whether the transaction is a credit or debit to the account"
    },
    "description": {
      "type": "string",
      "description": "Enriched transaction description"
    },
    "reference": {
      "type": "string",
      "description": "Transaction reference number"
    },
    "category": {
      "type": "string",
      "description": "Transaction category (enriched)"
    },
    "counterparty_name": {
      "type": "string",
      "description": "Name of the counterparty"
    },
    "counterparty_account": {
      "type": "string",
      "description": "Counterparty account number"
    },
    "balance": {
      "type": "number",
      "description": "Account balance after the transaction"
    },
    "payment_type": {
      "type": "string",
      "enum": ["WIRE", "EFT", "INTERAC", "INTERNAL", "FEE", "INTEREST"],
      "description": "Type of payment transaction"
    },
    "uetr": {
      "type": "string",
      "description": "Unique End-to-End Transaction Reference for wire payments"
    }
  },
  "required": ["transaction_id", "date", "amount", "credit_debit_indicator"]
}