Stitch · Schema

Stitch Bank Account

A bank account linked by a user through the Stitch open banking platform.

AfricaFinancial DataOpen BankingPaymentsUnified APISouth AfricaNigeria

Properties

Name Type Description
id string Unique account identifier.
name string Account holder name.
accountNumber string Bank account number.
bankId string Bank identifier code.
availableBalance object Available balance for transactions.
currentBalance object Current (ledger) balance including pending transactions.
View JSON Schema on GitHub

JSON Schema

stitch-bank-account-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.stitch.money/schema/bank-account",
  "title": "Stitch Bank Account",
  "description": "A bank account linked by a user through the Stitch open banking platform.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique account identifier."
    },
    "name": {
      "type": "string",
      "description": "Account holder name.",
      "examples": ["John Smith", "Acme Corp"]
    },
    "accountNumber": {
      "type": "string",
      "description": "Bank account number."
    },
    "bankId": {
      "type": "string",
      "description": "Bank identifier code.",
      "examples": ["absa", "fnb", "standard_bank", "capitec", "nedbank"]
    },
    "availableBalance": {
      "$ref": "#/definitions/MoneyAmount",
      "description": "Available balance for transactions."
    },
    "currentBalance": {
      "$ref": "#/definitions/MoneyAmount",
      "description": "Current (ledger) balance including pending transactions."
    }
  },
  "required": ["id", "accountNumber", "bankId"],
  "definitions": {
    "MoneyAmount": {
      "type": "object",
      "properties": {
        "quantity": { "type": "string", "description": "Amount as decimal string." },
        "currency": { "type": "string", "enum": ["ZAR", "NGN"] }
      }
    }
  }
}