balance

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
id	string
object	string
live_mode	boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
created_at	string
updated_at	string
amount	integer	The balance amount.
currency	object	The currency of the balance.
balance_type	string	The specific type of balance reported. One of `opening_ledger`, `closing_ledger`, `current_ledger`, `opening_available`, `opening_available_next_business_day`, `closing_available`, `current_available`
vendor_code	string	The code used by the bank when reporting this specific balance.
vendor_code_type	string	The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`,
as_of_date	string	The date on which the balance became true for the account.
as_of_time	string	The time on which the balance became true for the account.
value_date	string	The date on which the balance becomes available.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/balance",
  "title": "balance",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "amount": {
      "type": "integer",
      "description": "The balance amount."
    },
    "currency": {
      "$ref": "#/components/schemas/currency",
      "description": "The currency of the balance."
    },
    "balance_type": {
      "type": "string",
      "enum": [
        "closing_available",
        "closing_ledger",
        "current_available",
        "current_ledger",
        "opening_available",
        "opening_available_next_business_day",
        "opening_ledger",
        "other",
        "previously_closed_book"
      ],
      "description": "The specific type of balance reported. One of `opening_ledger`, `closing_ledger`, `current_ledger`, `opening_available`, `opening_available_next_business_day`, `closing_available`, `current_available`, 'previously_closed_book', or `other`."
    },
    "vendor_code": {
      "type": "string",
      "description": "The code used by the bank when reporting this specific balance."
    },
    "vendor_code_type": {
      "type": "string",
      "nullable": true,
      "description": "The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`, `swift`, or `us_bank`."
    },
    "as_of_date": {
      "type": "string",
      "nullable": true,
      "format": "date",
      "description": "The date on which the balance became true for the account."
    },
    "as_of_time": {
      "type": "string",
      "nullable": true,
      "format": "time",
      "description": "The time on which the balance became true for the account."
    },
    "value_date": {
      "type": "string",
      "nullable": true,
      "format": "date",
      "description": "The date on which the balance becomes available."
    }
  },
  "additionalProperties": false,
  "minProperties": 13,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "amount",
    "currency",
    "balance_type",
    "vendor_code",
    "vendor_code_type",
    "as_of_date",
    "as_of_time",
    "value_date"
  ]
}