Account balance history generated
Type: object
Domain: account-balances
Event: balance_history
Version: 1
external_account_id required
Title: External account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string or null
Min length: 1
Max length: 60
Example:
5acb57cd-a99e-4de9-aea0-9f52021a945b
account_id required
Title: Account unique identifier
Type: integer
Example:
10
book_balance required
Title: Book balance
Description: The effective account balance.
Type: number
Example:
100.3
value_dated_balance
Title: Value dated balance
Description: Value dated balance results from recalculating credit or debit interest based on the back value date. By default, it is initialized with the book balance value.
Type: number
Example:
100.3
available_balance required
Title: Available balance
Description: The balance that is available for transactions, including credit balance and credit limit.
Type: number
Example:
100.3
uncleared_funds required
Title: Uncleared funds
Description: The balance of funds that got posted on the account but haven't been cleared/confirmed.
Type: number
Example:
100.3
earmarked_balance required
Title: Earmarked balance
Description: The credit balance on hold and thus removed from the available balance, but kept in the book balance.
Type: number
Example:
50.15
credit_balance required
Title: Credit balance
Description: The balance of credit transactions posted into the account.
Type: number
Example:
50.15
debit_balance required
Title: Debit balance
Description: The outstanding balance from debit transactions after all credit balance is used. (Values larger than zero imply usage of a credit limit).
Type: number
Example:
50.15
overdraft_limit required
Title: Overdraft limit
Description: The value for maximum amount approved for overdraft spending on the account.
Type: number
Example:
100.3
date
Title: Balance date
Description: The business date of the balance. (deprecated)
Type: string
Format: date
Example:
2023-02-06
business_date required
Title: Balance date
Description: The business date of the balance.
Type: string
Format: date
Example:
2023-02-06
cycle_closing_datetime required
Title: Balance date
Description: The cycle closing datetime indicates the datetime when the daily balance has closed in UTC 0.
Type: string
Min length: 1
Max length: 24
Example:
2023-02-01T22:07:00.000Z
tracking_id
Title: Tracking ID
Description: Tracking ID of Balance History (Issued only for Back Value or Back Business Dated Transaction)
Type: string or null
Example:
0a50c88a-ade8-4bcc-a639-9a0b0f11e244
trigger_reason
Title: Trigger reason
Description: The trigger reason indicates which operation caused the event to be generated.
Type: string
Example:
BACK_BUSINESS_DATED_OPERATION
BACK_VALUE_DATED_OPERATION
BACK_VALUE_AND_BUSINESS_DATED_OPERATION
CYCLE_CLOSING
trigger_datetime
Title: Trigger datetime
Description: Timestamp when a back-business date, back-value date or cycle closing operations was processed
Type: string
Example:
2024-04-30T22:16:00.000Z
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Account balance history generated",
"required": [
"external_account_id",
"account_id",
"available_balance",
"debit_balance",
"credit_balance",
"earmarked_balance",
"book_balance",
"uncleared_funds",
"overdraft_limit",
"business_date",
"cycle_closing_datetime"
],
"properties": {
"external_account_id": {
"type": [
"string",
"null"
],
"title": "External account identifier",
"description": "A custom account ID string that uniquely identifies the account within your organization.",
"minLength": 1,
"maxLength": 60,
"examples": [
"5acb57cd-a99e-4de9-aea0-9f52021a945b"
]
},
"account_id": {
"type": "integer",
"title": "Account unique identifier",
"minimum": 1,
"maximum": 99999999999,
"examples": [
10
]
},
"book_balance": {
"type": "number",
"title": "Book balance",
"description": "The effective account balance.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
100.3
]
},
"value_dated_balance": {
"type": "number",
"title": "Value dated balance",
"description": "Value dated balance results from recalculating credit or debit interest based on the back value date. By default, it is initialized with the book balance value.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
100.3
]
},
"available_balance": {
"type": "number",
"title": "Available balance",
"description": "The balance that is available for transactions, including credit balance and credit limit.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
100.3
]
},
"uncleared_funds": {
"type": "number",
"title": "Uncleared funds",
"description": "The balance of funds that got posted on the account but haven't been cleared/confirmed.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
100.3
]
},
"earmarked_balance": {
"type": "number",
"title": "Earmarked balance",
"description": "The credit balance on hold and thus removed from the available balance, but kept in the book balance.",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
50.15
]
},
"credit_balance": {
"type": "number",
"title": "Credit balance",
"description": "The balance of credit transactions posted into the account.",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
50.15
]
},
"debit_balance": {
"type": "number",
"title": "Debit balance",
"description": "The outstanding balance from debit transactions after all credit balance is used. (Values larger than zero imply usage of a credit limit).",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
50.15
]
},
"overdraft_limit": {
"type": "number",
"title": "Overdraft limit",
"description": "The value for maximum amount approved for overdraft spending on the account.",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
100.3
]
},
"date": {
"type": "string",
"title": "Balance date",
"description": "The business date of the balance. (deprecated)",
"deprecated": true,
"format": "date",
"examples": [
"2023-02-06"
]
},
"business_date": {
"type": "string",
"title": "Balance date",
"description": "The business date of the balance.",
"format": "date",
"examples": [
"2023-02-06"
]
},
"cycle_closing_datetime": {
"type": "string",
"title": "Balance date",
"description": "The cycle closing datetime indicates the datetime when the daily balance has closed in UTC 0.",
"minLength": 1,
"maxLength": 24,
"examples": [
"2023-02-01T22:07:00.000Z"
]
},
"tracking_id": {
"type": [
"string",
"null"
],
"title": "Tracking ID",
"description": "Tracking ID of Balance History (Issued only for Back Value or Back Business Dated Transaction)",
"examples": [
"0a50c88a-ade8-4bcc-a639-9a0b0f11e244"
]
},
"trigger_reason": {
"type": "string",
"title": "Trigger reason",
"description": "The trigger reason indicates which operation caused the event to be generated.",
"examples": [
"BACK_BUSINESS_DATED_OPERATION",
"BACK_VALUE_DATED_OPERATION",
"BACK_VALUE_AND_BUSINESS_DATED_OPERATION",
"CYCLE_CLOSING"
]
},
"trigger_datetime": {
"type": "string",
"title": "Trigger datetime",
"description": "Timestamp when a back-business date, back-value date or cycle closing operations was processed",
"examples": [
"2024-04-30T22:16:00.000Z"
]
}
}
}
{
"external_account_id": "5acb57cd-a99e-4de9-aea0-9f52021a945b",
"account_id": 10,
"book_balance": 100.3,
"value_dated_balance": 100.3,
"available_balance": 100.3,
"uncleared_funds": 100.3,
"earmarked_balance": 50.15,
"credit_balance": 50.15,
"debit_balance": 50.15,
"overdraft_limit": 100.3,
"date": "2023-02-06",
"business_date": "2023-02-06",
"cycle_closing_datetime": "2023-02-01T22:07:00.000Z",
"tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
"trigger_reason": "BACK_BUSINESS_DATED_OPERATION",
"trigger_datetime": "2024-04-30T22:16:00.000Z"
}
Updated 1 day ago