Account balance changed
Type: object
Domain: account-balances
Event: balance_change
Version: 1
id required
Title: Unique identifier
Description: Unique Balance Change Integrity identifier.
Type: string
Format: uuid
Min length: 1
Max length: 36
Example:
744d9708-f217-4db2-8c9a-f211b5636370
ledger_balance required
Title: Ledger balance
Description: The effective account ledger balance.
Type: number
Example:
110.0
value_dated_balance required
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:
70.0
available_balance required
Title: Available balance
Description: The balance that is available for transactions, including credit balance and credit limit.
Type: number
Example:
50.0
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:
40.0
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:
20.0
credit_balance required
Title: Credit balance
Description: The balance of credit transactions posted into the account.
Type: number
Example:
50.0
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:
null
overdraft_limit required
Title: Overdraft limit
Description: The value for maximum amount approved for overdraft spending on the account.
Type: number
Example:
null
operation_amount required
Title: Operation amount impacted in transaction
Type: number
Example:
10.7
balance_update_datetime required
Title: Balance update datetime
Description: The balance integrity update datetime in UTC 0.
Type: string
Min length: 1
Max length: 25
Example:
2023-02-06T08:54:926078Z
posting_date required
Title: Transaction posting balance date
Description: The business date of the balance. In the balance-change event, thebusiness_daterefers to the current business cycle date, it's the valid date determined bycycle_closing_time config. Note that the date may not be the same as the current date.
the balance-history event is used to check the updated balances from previous dates for backdated transactions, the balance-change event reflects the current account balance.
Type: string
Format: date
Example:
2023-02-06
business_date required
Title: Balance business date
Description: The business date sent on the payment request. If not sent, it will be the same value as the posting_date.
Type: string
Format: date
Example:
2023-02-06
account_id required
Title: Account unique identifier
Type: integer
Example:
10
external_account_id required
Title: External account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string
Min length: 1
Max length: 60
Example:
5acb57cd-a99e-4de9-aea0-9f52021a945b
operation_type required
Title: Operation type
Description: The type of operation that changed the account balance.
It can assume the values:
CREDIT: When the change occurred because a credit was made.
DEBIT: When the change occurred because a debit was made.
LIMIT_INCREASE: When the overdraft limit for the account was increased.
LIMIT_DECREASE: When the overdraft limit for the account was decreased.
ACCOUNT_CREATION: When the account was created.
Type: string
Min length: 1
Max length: 20
Example:
CREDIT
DEBIT
LIMIT_INCREASE
LIMIT_DECREASE
ACCOUNT_CREATION
currency_code required
Title: Represents a 3-letter alphabetic code, conforming to the ISO 4217 standard, which corresponds to the currency utilized in the account balance
Type: string
Min length: 1
Max length: 3
Example:
USD
GBP
BRL
division_id
Title: Division unique identifier
Description: Unique ID used to identify the division within your organization.
Type: string
Max length: 36
Example:
1d22e668-a857-4455-aee7-dbe888f4bf2b
program_id
Title: Program unique identifier
Description: Program ID to which the account belongs within your organization.
Type: integer
Max length: 11
Example:
15
book_balance
Title: Book balance
Description: The effective account balance.
Type: number
Example:
70.0
tracking_id
Title: Tracking unique identifier
Description: A unique 50 character long identification for the transaction.
Type: string
Min length: 1
Max length: 75
Example:
UK1-ea6f491a-98a8-4f34-939c-44d704aa2119
change_available_event_id
Title: Change available event identifier
Description: Unique Available Integrity identifier. this UUID is generated by Ledger.
Type: string
Format: uuid
Min length: 1
Max length: 36
Example:
744d9708-f217-4db2-8c9a-f211b5636370
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Account balance changed",
"required": [
"id",
"account_id",
"operation_type",
"operation_amount",
"balance_update_datetime",
"business_date",
"external_account_id",
"ledger_balance",
"available_balance",
"debit_balance",
"credit_balance",
"earmarked_balance",
"uncleared_funds",
"overdraft_limit",
"posting_date",
"value_dated_balance",
"currency_code"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Unique identifier",
"description": "Unique Balance Change Integrity identifier.",
"minLength": 1,
"maxLength": 36,
"examples": [
"744d9708-f217-4db2-8c9a-f211b5636370"
]
},
"ledger_balance": {
"type": "number",
"title": "Ledger balance",
"description": "The effective account ledger balance.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
110.0
]
},
"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": [
70.0
]
},
"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": [
50.0
]
},
"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": [
40.0
]
},
"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": [
20.0
]
},
"credit_balance": {
"title": "Credit balance",
"description": "The balance of credit transactions posted into the account.",
"type": "number",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
50.0
]
},
"debit_balance": {
"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",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
0.0
]
},
"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": [
0.0
]
},
"operation_amount": {
"title": "Operation amount impacted in transaction",
"type": "number",
"minimum": 0,
"maximum": 18446744073709551617,
"examples": [
10.7
]
},
"balance_update_datetime": {
"type": "string",
"title": "Balance update datetime",
"description": "The balance integrity update datetime in UTC 0.",
"minLength": 1,
"maxLength": 25,
"examples": [
"2023-02-06T08:54:926078Z"
]
},
"posting_date": {
"type": "string",
"title": "Transaction posting balance date",
"description": "The business date of the balance. In the balance-change event, the `business_date` refers to the current business cycle date, it's the valid date determined by `cycle_closing_time config`. Note that the date may not be the same as the current date.\n\nthe balance-history event is used to check the updated balances from previous dates for backdated transactions, the balance-change event reflects the current account balance.",
"format": "date",
"examples": [
"2023-02-06"
]
},
"business_date": {
"type": "string",
"title": "Balance business date",
"description": "The business date sent on the payment request. If not sent, it will be the same value as the posting_date.",
"format": "date",
"examples": [
"2023-02-06"
]
},
"account_id": {
"title": "Account unique identifier",
"type": "integer",
"minimum": 1,
"maximum": 99999999999,
"examples": [
10
]
},
"external_account_id": {
"title": "External account identifier",
"description": "A custom account ID string that uniquely identifies the account within your organization.",
"type": "string",
"minLength": 1,
"maxLength": 60,
"examples": [
"5acb57cd-a99e-4de9-aea0-9f52021a945b"
]
},
"operation_type": {
"title": "Operation type",
"description": "The type of operation that changed the account balance.\n\nIt can assume the values: \n\nCREDIT: When the change occurred because a credit was made. \n\nDEBIT: When the change occurred because a debit was made. \n\nLIMIT_INCREASE: When the overdraft limit for the account was increased. \n\nLIMIT_DECREASE: When the overdraft limit for the account was decreased. \n\nACCOUNT_CREATION: When the account was created.",
"type": "string",
"minLength": 1,
"maxLength": 20,
"examples": [
"CREDIT",
"DEBIT",
"LIMIT_INCREASE",
"LIMIT_DECREASE",
"ACCOUNT_CREATION"
]
},
"currency_code": {
"type": "string",
"title": "Represents a 3-letter alphabetic code, conforming to the ISO 4217 standard, which corresponds to the currency utilized in the account balance",
"minLength": 1,
"maxLength": 3,
"examples": [
"USD",
"GBP",
"BRL"
]
},
"division_id": {
"type": "string",
"title": "Division unique identifier",
"description": "Unique ID used to identify the division within your organization.",
"maxLength": 36,
"examples": [
"1d22e668-a857-4455-aee7-dbe888f4bf2b"
]
},
"program_id": {
"type": "integer",
"title": "Program unique identifier",
"maxLength": 11,
"description": "Program ID to which the account belongs within your organization.",
"examples": [
15
]
},
"book_balance": {
"type": "number",
"title": "Book balance",
"description": "The effective account balance.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
70.0
]
},
"tracking_id": {
"type": "string",
"title": "Tracking unique identifier",
"description": "A unique 50 character long identification for the transaction.",
"minLength": 1,
"maxLength": 75,
"examples": [
"UK1-ea6f491a-98a8-4f34-939c-44d704aa2119"
]
},
"change_available_event_id": {
"title": "Change available event identifier",
"description": "Unique Available Integrity identifier. this UUID is generated by Ledger.",
"type": "string",
"format": "uuid",
"minLength": 1,
"maxLength": 36,
"examples": [
"744d9708-f217-4db2-8c9a-f211b5636370"
]
}
}
}
{
"id": "744d9708-f217-4db2-8c9a-f211b5636370",
"ledger_balance": 110.0,
"value_dated_balance": 70.0,
"available_balance": 50.0,
"uncleared_funds": 40.0,
"earmarked_balance": 20.0,
"credit_balance": 50.0,
"debit_balance": 0.0,
"overdraft_limit": 0.0,
"operation_amount": 10.7,
"balance_update_datetime": "2023-02-06T08:54:926078Z",
"posting_date": "2023-02-06",
"business_date": "2023-02-06",
"account_id": 10,
"external_account_id": "5acb57cd-a99e-4de9-aea0-9f52021a945b",
"operation_type": "CREDIT",
"currency_code": "USD",
"division_id": "1d22e668-a857-4455-aee7-dbe888f4bf2b",
"program_id": 15,
"book_balance": 70.0,
"tracking_id": "UK1-ea6f491a-98a8-4f34-939c-44d704aa2119",
"change_available_event_id": "744d9708-f217-4db2-8c9a-f211b5636370"
}
Updated 21 days ago