Sua conta
Consulta de saldo, dados para depósito, extrato, exportações e
encerramento da conta. As rotas são GET (exceto criar exportação e
encerrar a conta) no host
https://client.api.corpx.com, com os headers de
assinatura. O {accountId} é o da credencial.
Saldo
GET /v1/accounts/{accountId}/balance
available é o que você pode enviar. locked é o total retido (por
exemplo uma disputa MED); a resposta não lista cada retenção.
includeLocks é aceito por compatibilidade e não tem efeito.
409 account_not_ready significa que a conta ainda não tem contraparte no
liquidante — não é saldo zero. 409 account_not_entitled significa que o
serviço não foi habilitado; retry não resolve, fale com o banco.
Dados bancários
GET /v1/accounts/{accountId}/bank-account devolve COMPE, agência e número
para depósito TED ou transferência interna, sem depender de chave PIX.
Para receber TED, a contraparte digita o banco 681 (Compe), não o ISPB.
Extrato
GET /v1/accounts/{accountId}/statement
A resposta é sempre uma lista: items, totalElements, totalPages,
page, size, hasNext, hasPrevious. Paginação é zero-based
(page=0 é a primeira).
size é um teto, não uma promessa: avance com hasNext, não assuma
len(items) == size.
A ordem é pelo instante, com resolução de 1 segundo e sem desempate
garantido quando vários lançamentos caem no mesmo segundo. Prefira
order=asc, pagine até hasNext falso e deduplique por endToEndId ou
partnerId. Para crédito em tempo real, assine pix.in.completed,
pix.refund.received e transfer.internal.in.
Uma devolução PIX vem com reversal: true, partnerType: PIX_REFUND e
originalEndToEnd (o PIX devolvido). operation continua PIX. O PIX
original, depois da devolução, traz refundEndToEnd — inclusive numa
devolução parcial.
Cada item traz amount com sinal (negativo = débito), direction (IN /
OUT) e um par pagador/recebedor. O lado desta conta vem com nome,
documento e banco; a contraparte vem com nome e documento — agência, conta
e chave da outra ponta em geral não vêm no extrato. Para o payload
completo do PIX enviado, use
GET /v1/accounts/{accountId}/pix/payments/lookup.
Extrato avançado (caro)
GET /v1/accounts/{accountId}/statement/advanced filtra por chave PIX,
contraparte, faixa de valor, direção e status — campos que o liquidante
não filtra do lado dele. Cada chamada percorre o extrato página a
página. Serve para investigação pontual. Não use para polling. Para
acompanhar PIX que entra, assine o webhook pix.in.completed.
Conta com milhares de lançamentos no dia e só quer o fim dele? Use
order=desc com occurredAfter (RFC 3339 com fuso): a varredura começa
pelo mais recente e para ao cruzar o horário. Detalhes e a continuação por
tempo em Busca avançada no extrato.
Exportações
POST /v1/accounts/{accountId}/exports enfileira CSV, XLSX ou PDF.
Resposta 202. Consulte GET .../exports até COMPLETED e baixe em
GET .../exports/{exportId}/download (URL pré-assinada).
CSV/XLSX usam a janela pedida por inteiro. Os cabeçalhos são em português. Valor sai no padrão brasileiro (-1.234,56). A última coluna é Chave Pix.
Não inclui saldo após cada linha.
Saldo diário
GET /v1/accounts/{accountId}/daily-balance?startDate=2026-06-04&endDate=2026-06-05
devolve abertura (total / bloqueado / disponível) e fluxos do dia em
horário de Brasília. Janela máxima de 30 dias. Só há fechamentos a partir
de 2026-06-04.
Os fluxos vêm somados por tipo: Pix (pixIn, pixOut, pixBillingOut),
TED (tedIn, tedOut, tedBillingOut), transferência interna
(internalTransferIn, internalTransferOut, internalTransferBillingOut),
boleto (bankSlipOut), BRMT (stablecoinMint, stablecoinBurn) e
liquidação de cartões (cardSettlementIn para débito, crédito e
antecipação; cardSettlementOut para saídas). Todos os campos vêm sempre,
com 0 quando não houve movimento. A abertura de um dia é a abertura do
dia anterior mais as entradas, menos as saídas e as tarifas daquele dia.
Encerrar a conta
POST /v1/accounts/{accountId}/close, com Idempotency-Key. A credencial
precisa do escopo accounts.close; sem ele, 403 insufficient_scope.
Quando nenhum outro tenant opera a conta, o encerramento vai ao liquidante, que só encerra conta zerada: sem saldo disponível e sem saldo bloqueado. O saldo é conferido antes:
- saldo disponível diferente de zero: 422
account_has_balance— retire o saldo e repita; - disponível zerado com saldo bloqueado (por exemplo, retenção de MED):
422
account_has_locked_balance— espere a liberação e repita.
Nos dois casos a conta continua ativa e o corpo traz balance (total,
available, locked, currency). Com o saldo zerado, a resposta é 200
(accountId e message): o encerramento é pedido ao liquidante e a conta
passa a status=closed na mesma chamada. A conta bancária em si é
encerrada quando o liquidante processa o pedido.
Timeline de uma transação
Dois caminhos:
GET /v1/accounts/{accountId}/transactions/timeline?endToEndId=(ouidentifier) — exatamente um dos doisGET /v1/transactions/{transactionId}/timeline— pelopaymentId, id do parceiro, E2E outxiddo QR
A timeline reúne confirmações, webhooks enviados, tarifas, devoluções e ciclo de vida do QR.