Account balance changed

This event occurs asynchronously when account balance changes due to any relevant account activity, such as credit or debit operations, which in turn impacts account limits. This event also occurs when blocking, unblocking, and transferring held funds.
Generated by: Block amount, Unblock held amount, Transfer held amount
More information: Hold funds, Account limits

Type: object
Domain: availables
Event: change_available
Version: 1

|
account_id required

Title: Account ID
Description: Account ID.
Type: integer

amount required

Title: Amount
Description: Amount by which the transaction impacted the account limits.
Type: number

id required

Title: ID
Description: For internal Pismo processing only.
Type: string
Format: uuid
Min length: 1
Max length: 38

operation_type required

Title: Operation type
Description: Defines if the transaction will impact the limit positively (CREDIT) or negatively (DEBIT).
Type: string
Min length: 1
Max length: 20

org_id required

Title: Organization ID
Description: Organization ID.
Type: string
Min length: 1
Max length: 52

tracking_id required

Title: Tracking ID
Description: Unique 36-character tracking ID of the transaction.
Type: string
Min length: 1
Max length: 44

updated_at required

Title: Updated at
Description: Timestamp when the limits were impacted in the local time zone of the platform database.
Type: string
Min length: 1
Max length: 27

amount_consider

Title: Amount considered in the transaction
Description: Amount by which to consider evaluating the transaction. For example, if this value is 100, but the transaction also has some associated fees, the platform can consider only 100 of principal amount to evaluate this transaction.
Type: number

available_credit_limit

Title: Available credit limit
Description: Initial available credit limit of the account.
Type: number

available_installment_limit

Title: Available installment limit
Description: Amount available for installments in the credit account.
Type: number

available_savings_account_limit

Title: Available savings account limit
Description: Available limit of the savings account.
Type: number

available_update_datetime

Title: Available update datetime
Description: Timestamp when the limits were updated in the UTC 0 time zone.
Type: string
Min length: 1
Max length: 21

available_withdraw_limit

Title: Available withdrawal limit
Description: Amount available for withdrawal in the credit account.
Type: number

caller

Title: Caller API
Description: API that called the Ledger API.
Type: string
Min length: 1
Max length: 255
Example:
p2ptransactions-api
network-transactions-api

considers

Type: array
Min length: 1
Max length: 255

impacts

Type: array
Min length: 1
Max length: 255

held_funds

Title: Held funds
Description: Held funds on the account. Usually, but not always, this occurs due to a legal action.
Type: number

limits

Title: Limits
Description: Show account limits.
Type: object

max_credit_limit

Title: Maximum credit limit
Description: Maximum credit limit approved for this account. Usually granted by a credit analysis.
Type: number

total_credit_limit

Title: Total credit limit
Description: Total credit limit as set by the user. This can be any value up to the max_credit_limit.
Type: number

total_installment_credit_limit

Title: Total installments credit limit
Description: Amount limit for installments in the credit account.
Type: number

total_overdraft_limit

Title: Overdraft limit
Description: Maximum limit for overdraft spending on the savings account.
Type: number

withdrawal_credit_limit

Title: Withdrawal credit limit
Description: Amount limit for withdrawal in credit programs. This value is calculated by multiplying total_credit_limit and Withdrawal limit percentage (defined for the program).
Type: number

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Account balance changed",
    "description": "This event occurs asynchronously when account balance changes due to any relevant account activity, such as credit or debit operations, which in turn impacts account limits. This event also occurs when blocking, unblocking, and transferring held funds. <br>Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-block' target='_blank'>Block amount</a>, <a href='https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-unblock' target='_blank'>Unblock held amount</a>, <a href='https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-transfer' target='_blank'>Transfer held amount</a> <br> More information: <a href='https://developers.pismo.io/pismo-docs/docs/hold-funds' target='_blank'>Hold funds</a>, <a href='https://developers.pismo.io/pismo-docs/docs/working-with-limits-objects' target='_blank'>Account limits</a>",
    "required": [
        "account_id",
        "amount",
        "id",
        "operation_type",
        "org_id",
        "tracking_id",
        "updated_at"
    ],
    "properties": {
        "account_id": {
            "title": "Account ID",
            "description": "Account ID.",
            "type": "integer",
            "minimum": 1,
            "maximum": 4294967295
        },
        "amount": {
            "title": "Amount",
            "description": "Amount by which the transaction impacted the account limits.",
            "type": "number",
            "minimum": 1,
            "maximum": 18446744073709551617
        },
        "id": {
            "title": "ID",
            "description": "For internal Pismo processing only.",
            "type": "string",
            "format": "uuid",
            "minLength": 1,
            "maxLength": 38
        },
        "operation_type": {
            "title": "Operation type",
            "description": "Defines if the transaction will impact the limit positively (CREDIT) or negatively (DEBIT).",
            "type": "string",
            "minLength": 1,
            "maxLength": 20
        },
        "org_id": {
            "title": "Organization ID",
            "description": "Organization ID.",
            "type": "string",
            "minLength": 1,
            "maxLength": 52
        },
        "tracking_id": {
            "title": "Tracking ID",
            "description": "Unique 36-character tracking ID of the transaction.",
            "type": "string",
            "minLength": 1,
            "maxLength": 44
        },
        "updated_at": {
            "title": "Updated at",
            "description": "Timestamp when the limits were impacted in the local time zone of the platform database.",
            "type": "string",
            "minLength": 1,
            "maxLength": 27
        },
        "amount_consider": {
            "title": "Amount considered in the transaction",
            "description": "Amount by which to consider evaluating the transaction. For example, if this value is 100, but the transaction also has some associated fees, the platform can consider only 100 of principal amount to evaluate this transaction.",
            "type": "number",
            "minimum": 1,
            "maximum": 18446744073709551617
        },
        "available_credit_limit": {
            "title": "Available credit limit",
            "description": "Initial available credit limit of the account.",
            "type": "number",
            "minimum": -18446744073709551617,
            "maximum": 18446744073709551617
        },
        "available_installment_limit": {
            "title": "Available installment limit",
            "description": "Amount available for installments in the credit account.",
            "type": "number",
            "minimum": -18446744073709551617,
            "maximum": 18446744073709551617
        },
        "available_savings_account_limit": {
            "title": "Available savings account limit",
            "description": "Available limit of the savings account.",
            "type": "number",
            "minimum": -18446744073709551617,
            "maximum": 18446744073709551617
        },
        "available_update_datetime": {
            "title": "Available update datetime",
            "description": "Timestamp when the limits were updated in the UTC 0 time zone.",
            "type": "string",
            "minLength": 1,
            "maxLength": 21
        },
        "available_withdraw_limit": {
            "title": "Available withdrawal limit",
            "description": "Amount available for withdrawal in the credit account.",
            "type": "number",
            "minimum": -18446744073709551617,
            "maximum": 18446744073709551617
        },
        "caller": {
            "title": "Caller API",
            "description": "API that called the Ledger API.",
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "examples": [
                "p2ptransactions-api",
                "network-transactions-api"
            ]
        },
        "considers": {
            "title": "Considers",
            "description": "Limits that are considered for evaluation in the transaction.",
            "type": "array",
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
            },
            "examples": [
                "[AvailableCreditLimit]",
                "[AvailableCreditLimit,AvailableSavingsAccountLimit]",
                "[OverdraftLimit]"
            ]
        },
        "impacts": {
            "title": "Impacts",
            "description": "Limits that will be impacted in the transaction.",
            "type": "array",
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
            },
            "examples": [
                "[AvailableCreditLimit]",
                "[AvailableCreditLimit,AvailableSavingsAccountLimit]",
                "[HeldFunds]"
            ]
        },
        "held_funds": {
            "title": "Held funds",
            "description": "Held funds on the account. Usually, but not always, this occurs due to a legal action.",
            "type": "number"
        },
        "limits": {
            "title": "Limits",
            "description": "Show account limits.",
            "type": "object",
            "properties": {
                "max_credit_limit": {
                    "title": "Maximum credit limit",
                    "description": "Maximum credit limit approved for this account. Usually granted by a credit analysis.",
                    "type": "number"
                },
                "total_credit_limit": {
                    "title": "Total credit limit",
                    "description": "Total credit limit as set by the user. This can be any value up to the max_credit_limit.",
                    "type": "number"
                },
                "total_installment_credit_limit": {
                    "title": "Total installments credit limit",
                    "description": "Amount limit for installments in the credit account.",
                    "type": "number"
                },
                "total_overdraft_limit": {
                    "title": "Overdraft limit",
                    "description": "Maximum limit for overdraft spending on the savings account.",
                    "type": "number"
                },
                "withdrawal_credit_limit": {
                    "title": "Withdrawal credit limit",
                    "description": "Amount limit for withdrawal in credit programs. This value is calculated by multiplying total_credit_limit and Withdrawal limit percentage (defined for the program).",
                    "type": "number"
                }
            }
        }
    }
}