跳到主要内容

Consulta de Conta de Liquidação

Este endpoint permite consultar os detalhes da conta de liquidação de um emissor — dados bancários (agência, conta, dígito), status e, quando a conta já está aberta, informações do titular e saldos.

Enquanto a conta ainda não foi aberta no BaaS, o endpoint retorna apenas os dados básicos com account_status: "pending". Após a abertura, a resposta inclui os campos adicionais do titular e de saldo.


Consulta de Conta de Liquidação (GET)

Request

ENDPOINT
/account_liquidation/issuer/ISSUER-KEY
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
ISSUER-KEYstringChave única do emissor (UUID v4).36

Response

STATUS
200
Response Body — conta aberta
{
"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 — conta pendente
{
"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

CampoTipoDescrição
issuer_keystringChave única do emissor.
tenant_keystringChave única do cliente dono da conta.
bank_account_keystringChave única da conta bancária no BaaS.
request_account_keystringChave única da solicitação de abertura da conta.
account_keystringChave única da conta no BaaS. Presente apenas quando a conta já foi aberta.
account_branchstringAgência da conta.
account_numberstringNúmero da conta.
account_digitstringDígito da conta.
account_statusstringStatus da conta. pending enquanto a abertura não foi concluída.
account_typestringTipo da conta no BaaS. Presente apenas quando a conta já foi aberta.
account_documentsarrayDocumentos associados à conta. Presente apenas quando a conta já foi aberta.
balancenumberSaldo disponível da conta. Presente apenas quando a conta já foi aberta.
blocked_balancenumberSaldo bloqueado da conta. Presente apenas quando a conta já foi aberta.
owner_document_numberstringCPF/CNPJ do titular da conta. Presente apenas quando a conta já foi aberta.
owner_namestringNome do titular da conta. Presente apenas quando a conta já foi aberta.
owner_person_keystringChave única do titular no BaaS. Presente apenas quando a conta já foi aberta.
created_atstringData de criação da conta. Presente apenas quando a conta já foi aberta.

Erros

HTTPCódigoQuando ocorre
404ACL000002 (IssuerAccountLiquidationNotFound)Não existe conta de liquidação para o emissor informado.
400ACL000003 (IssuerAccountLiquidationNotBelongToTenant)A conta de liquidação do emissor não pertence ao cliente que fez a requisição.