Check account balance

This endpoint is used to query the bank account balance.

Params (Query Params)

ParameterValueDescriptionExample
account_branch_identifierNumberThis field should be filled with the branch number you wish to inquire about. Branch numbers always consist of 4 digits.Ex: 0000
account_numberNumberIn this field, you should fill in the bank account number you wish to inquire about. A bank account number does not have a specific pattern and may vary in length depending on the financial institution. (Example: Accounts registered with SaQ.Digital typically have 6 characters).Ex: 000000

Headers

ParameterTypeDescriptionExample
AuthorizationStringBearer + Access_tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Response Details

{
    "worked": true,
    "amount": 15.4,
    "amount_blocked": 0.0,
    "amount_schedule": 0.0,
    "last_update": "2024-04-11T13:46:00.447",
    "account_branch": "xxxx",
    "account_number": "xxxxxx"
}

FieldDescription
workedReturns true or false, confirming whether the query was successfully returned or not
amountThis field returns the available balance in the bank account.
amount_blockedThis field returns the blocked balance in the bank account.
amount_scheduleThis field returns the value/balance of scheduled transfers and/or payments in the bank account.
last_updateThis field returns the last update (Data/Time) regarding the balances in the bank account.
account_branchReturns the information of the consulted originating branch (The same information sent in the body).
account_numberReturns the information of the consulted originating account (The same information sent in the body).
Language
Click Try It! to start a request and see the response here!