Sua conta

Consulta de saldo, dados para depósito, extrato e exportações. Todas as rotas são GET (exceto criar exportação) no host https://client.api.corpx.com, com os headers de assinatura. O {accountId} é o da credencial.

Saldo

GET /v1/accounts/{accountId}/balance

curl -X GET "https://client.api.corpx.com/v1/accounts/$ACCOUNT_ID/balance" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Request-Timestamp: $TS" \
  -H "X-Content-SHA256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" \
  -H "X-Request-Signature: $SIG"

{
  "accountId": "6ff57bc1-e4a9-403b-be62-42378b8aafd7",
  "total": 18254.17,
  "locked": 500.00,
  "available": 17754.17,
  "currency": "BRL",
  "updatedAt": "2026-02-05T22:00:00Z"
}

available é o que você pode enviar. locked é valor retido (por exemplo uma disputa MED). Passe ?includeLocks=true para ver cada retenção.

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.

{
  "accountId": "6ff57bc1-e4a9-403b-be62-42378b8aafd7",
  "holderDocument": "62452650000125",
  "holderName": "Example Company LTDA",
  "bankCode": "681",
  "bankIspb": "50871921",
  "bankName": "MT Bank",
  "branch": "0001",
  "accountNumber": "8339086",
  "status": "active"
}

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.

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).

{
  "type": "statement",
  "startDate": "2026-05-01",
  "endDate": "2026-05-07",
  "format": "csv"
}

CSV/XLSX usam a janela pedida por inteiro. A última coluna é pixKey. 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.

Timeline de uma transação

Dois caminhos:

• GET /v1/accounts/{accountId}/transactions/timeline?endToEndId= (ou identifier) — exatamente um dos dois
• GET /v1/transactions/{transactionId}/timeline — pelo paymentId, id do parceiro, E2E ou txid do QR

A timeline reúne confirmações, webhooks enviados, tarifas, devoluções e ciclo de vida do QR.