Synctera · Schema

account_base

FinTechBaaSBankingPaymentsCard IssuingKYC

Properties

Name	Type	Description
access_status	object
account_number	string	Account number
account_number_masked	string	The response will contain the bank fintech ID (3 or 6 digits) plus the last 4 digits, with the digits in between replaced with * characters. Shadow mode account numbers will not be masked.
account_purpose	string	Purpose of the account
account_type	object
application_id	string	The application ID for this account.
balances	array	A list of balances for account based on different type
bank_routing	string	Bank routing number
creation_time	string	Account creation timestamp in RFC3339 format
currency	string	Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD
customer_ids	array	A list of the customer IDs of the account holders.
customer_type	object
exchange_rate_type	string	Exchange rate type
iban	string	International bank account number
id	string	Account ID
is_account_pool	boolean	Account is investment (variable balance) account or a multi-balance account pool. Default false
is_ach_enabled	boolean	A flag to indicate whether ACH transactions are enabled.
is_card_enabled	boolean	A flag to indicate whether card transactions are enabled.
is_p2p_enabled	boolean	A flag to indicate whether P2P transactions are enabled.
is_wire_enabled	boolean	A flag to indicate whether wire transactions are enabled.
last_updated_time	string	Timestamp of the last account modification in RFC3339 format
metadata	object	User provided account metadata
nickname	string	User provided account nickname
status	object
swift_code	string	SWIFT code

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/account_base",
  "title": "account_base",
  "properties": {
    "access_status": {
      "$ref": "#/components/schemas/account_access_status"
    },
    "account_number": {
      "description": "Account number",
      "maxLength": 50,
      "readOnly": true,
      "type": "string"
    },
    "account_number_masked": {
      "description": "The response will contain the bank fintech ID (3 or 6 digits) plus the last 4 digits, with the digits in between replaced with * characters. Shadow mode account numbers will not be masked.",
      "example": "123*****6789",
      "maxLength": 50,
      "readOnly": true,
      "type": "string"
    },
    "account_purpose": {
      "description": "Purpose of the account",
      "example": "This account for the account holder's salary deposit.",
      "type": "string"
    },
    "account_type": {
      "$ref": "#/components/schemas/account_type"
    },
    "application_id": {
      "description": "The application ID for this account.\n",
      "format": "uuid",
      "type": "string"
    },
    "balances": {
      "description": "A list of balances for account based on different type",
      "items": {
        "$ref": "#/components/schemas/balance"
      },
      "readOnly": true,
      "type": "array"
    },
    "bank_routing": {
      "description": "Bank routing number",
      "maxLength": 9,
      "readOnly": true,
      "type": "string"
    },
    "creation_time": {
      "description": "Account creation timestamp in RFC3339 format",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "currency": {
      "description": "Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD",
      "example": "SVC",
      "pattern": "^[A-Z]{3}$",
      "type": "string"
    },
    "customer_ids": {
      "description": "A list of the customer IDs of the account holders.",
      "items": {
        "format": "uuid",
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "customer_type": {
      "$ref": "#/components/schemas/customer_type"
    },
    "exchange_rate_type": {
      "description": "Exchange rate type",
      "example": "M, INTERBANK, CUST",
      "maxLength": 10,
      "type": "string"
    },
    "iban": {
      "description": "International bank account number",
      "maxLength": 34,
      "type": "string"
    },
    "id": {
      "description": "Account ID",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "is_account_pool": {
      "description": "Account is investment (variable balance) account or a multi-balance account pool. Default false",
      "type": "boolean"
    },
    "is_ach_enabled": {
      "description": "A flag to indicate whether ACH transactions are enabled.",
      "readOnly": true,
      "type": "boolean"
    },
    "is_card_enabled": {
      "description": "A flag to indicate whether card transactions are enabled.",
      "readOnly": true,
      "type": "boolean"
    },
    "is_p2p_enabled": {
      "description": "A flag to indicate whether P2P transactions are enabled.",
      "readOnly": true,
      "type": "boolean"
    },
    "is_wire_enabled": {
      "description": "A flag to indicate whether wire transactions are enabled.",
      "readOnly": true,
      "type": "boolean"
    },
    "last_updated_time": {
      "description": "Timestamp of the last account modification in RFC3339 format",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "metadata": {
      "description": "User provided account metadata",
      "type": "object"
    },
    "nickname": {
      "description": "User provided account nickname",
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/status"
    },
    "swift_code": {
      "description": "SWIFT code",
      "maxLength": 11,
      "minLength": 8,
      "type": "string"
    }
  },
  "type": "object"
}