Docs
Referência da APISaldo e extrato

Consultar extrato bancário

Saldo no provedor, total agendado e movimentações de uma conta bancária vinculada à sua conta ou a um recebedor seu. `accountNumber` é o número da conta no provedor, não o `accountId` do saldo. Valores em centavos. Paginação por cursor: a ausência de `nextCursor` é o único sinal de fim. Sem conta bancária vinculada, responde `404 Statement.BankAccountNotFound`.

GET
/api/bank-accounts/{accountNumber}/statement

Saldo no provedor, total agendado e movimentações de uma conta bancária vinculada à sua conta ou a um recebedor seu. accountNumber é o número da conta no provedor, não o accountId do saldo. Valores em centavos. Paginação por cursor: a ausência de nextCursor é o único sinal de fim. Sem conta bancária vinculada, responde 404 Statement.BankAccountNotFound.

Autenticação

ApiKey
headerAuthorization<token>

A chave de API crua, sem prefixo: kpa_test_sk_… no sandbox e kpa_live_sk_… em produção. Use apenas no servidor.

Parâmetros de rota

accountNumber*string

Número da conta do recebedor, sem dígito verificador.

Parâmetros de consulta

from?string

Início do período, ISO 8601 com fuso.

Formatodate-time
to?string

Fim do período, ISO 8601 com fuso.

Formatodate-time
limit?integer

Itens por página. Acima de 200 é reduzido para 200.

Intervalovalue <= 200
Padrão50
cursor?string

nextCursor da página anterior. Quando presente, from, to e limit são ignorados.

Corpo da resposta

Página do extrato.

application/json
  1. response
accountNumber?string
merchantId?string

Recebedor dono da conta.

Formatouuid
period?
currentBalance?

Valor inteiro em centavos e moeda.

scheduled?

Valor inteiro em centavos e moeda.

entries?array<>
hasMore?boolean
nextCursor?string

Ausente na última página.

Exemplo de requisição
curl -X GET 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/bank-accounts/29600685/statement'
Exemplo de resposta
{  "accountNumber": "29600685",  "merchantId": "a3b2c1d0-5e6f-4a7b-8c9d-0e1f2a3b4c5d",  "period": {    "from": "2026-10-01T00:00:00-03:00",    "to": "2026-10-31T23:59:59-03:00"  },  "currentBalance": {    "amount": 183427,    "currency": "BRL"  },  "scheduled": {    "amount": 0,    "currency": "BRL"  },  "entries": [    {      "id": "stme-AAECAwQFBgc",      "postedAt": "2026-10-30T18:32:05-03:00",      "direction": "credit",      "amount": {        "amount": 14990,        "currency": "BRL"      },      "description": "Crédito PIX Maria Souza"    }  ],  "hasMore": true,  "nextCursor": "stmc-eyJvIjoyfQ"}