Skip to main content

Settlement Account Query

This endpoint allows you to query the details of an issuer's settlement account — banking data (branch, account, digit), status and, when the account is already open, owner information and balances.

While the account has not yet been opened in the BaaS, the endpoint returns only the basic data with account_status: "pending". After the opening, the response includes the additional owner and balance fields.


Settlement Account Query (GET)

Request

ENDPOINT
/account_liquidation/issuer/ISSUER-KEY
METHOD
GET

Path Params

FieldTypeDescriptionCharacters
ISSUER-KEYstringUnique key of the issuer (UUID v4).36

Response

STATUS
200
Response Body — open account
{
"issuer_key": "23d933e9-88ba-4291-a6a4-33f025ab361f",
"tenant_key": "5e3045af-8be8-4cbd-9aab-9e15c4e92154",
"bank_account_key": "8f2a6f10-3c43-4a3b-9f5e-2a9a1d4be0c1",
"request_account_key": "1c0a2e54-77a8-4f0e-8d8e-6f2b9b3c1d22",
"account_key": "46804f32-101e-4702-8fbc-c2dbc4c2caec",
"account_branch": "0001",
"account_number": "1234567",
"account_digit": "8",
"account_status": "opened",
"account_type": "payment_account",
"account_documents": [],
"balance": 12345.67,
"blocked_balance": 0.0,
"owner_document_number": "12345678000190",
"owner_name": "Emissor Exemplo LTDA",
"owner_person_key": "9b1f3c77-5a2d-4e8f-b6a0-3d2c1e0f9a88",
"created_at": "2026-01-15T12:34:56"
}
Response Body — pending account
{
"issuer_key": "23d933e9-88ba-4291-a6a4-33f025ab361f",
"tenant_key": "5e3045af-8be8-4cbd-9aab-9e15c4e92154",
"bank_account_key": "8f2a6f10-3c43-4a3b-9f5e-2a9a1d4be0c1",
"request_account_key": "1c0a2e54-77a8-4f0e-8d8e-6f2b9b3c1d22",
"account_branch": "0001",
"account_number": "1234567",
"account_digit": "8",
"account_status": "pending"
}

Response Body Params

FieldTypeDescription
issuer_keystringUnique key of the issuer.
tenant_keystringUnique key of the client that owns the account.
bank_account_keystringUnique key of the bank account in the BaaS.
request_account_keystringUnique key of the account opening request.
account_keystringUnique key of the account in the BaaS. Present only once the account has been opened.
account_branchstringAccount branch.
account_numberstringAccount number.
account_digitstringAccount digit.
account_statusstringAccount status. pending while the opening has not been completed.
account_typestringAccount type in the BaaS. Present only once the account has been opened.
account_documentsarrayDocuments associated with the account. Present only once the account has been opened.
balancenumberAvailable balance of the account. Present only once the account has been opened.
blocked_balancenumberBlocked balance of the account. Present only once the account has been opened.
owner_document_numberstringCPF/CNPJ of the account owner. Present only once the account has been opened.
owner_namestringName of the account owner. Present only once the account has been opened.
owner_person_keystringUnique key of the owner in the BaaS. Present only once the account has been opened.
created_atstringAccount creation date. Present only once the account has been opened.

Errors

HTTPCodeWhen it occurs
404ACL000002 (IssuerAccountLiquidationNotFound)There is no settlement account for the informed issuer.
400ACL000003 (IssuerAccountLiquidationNotBelongToTenant)The issuer's settlement account does not belong to the client that made the request.