Docs
Referência da APISaldo e extrato

Consultar saldo

Saldo da conta interna, por tipo: `Available` (livre para saque), `Blocked`, `PendingSettlement`, `Reserved` e `PendingWithdrawal`. `amount` é inteiro na menor unidade da moeda da conta (BRL ou USD). O `accountId` precisa pertencer à conta da chave; outra conta responde `404`. Sujeito à lista de IPs da conta, como os saques. Guia: /docs/saques/saldo.

GET
/api/v1/balance

Saldo da conta interna, por tipo: Available (livre para saque), Blocked, PendingSettlement, Reserved e PendingWithdrawal. amount é inteiro na menor unidade da moeda da conta (BRL ou USD). O accountId precisa pertencer à conta da chave; outra conta responde 404. Sujeito à lista de IPs da conta, como os saques. Guia: /docs/saques/saldo.

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 consulta

accountId*string

UUID da conta de saldo, entregue no credenciamento. O mesmo do saque.

Formatouuid
balanceType?string

Filtra um tipo de saldo. Maiúsculas e minúsculas são indiferentes.

Valores aceitos"Available""Blocked""PendingSettlement""Reserved""PendingWithdrawal"

Corpo da resposta

Saldo por tipo. Um tipo sem registro pode faltar; trate como zero.

application/json
  1. response
accountId*string
Formatouuid
balances*array<>
Exemplo de requisição
curl -X GET 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/balance?accountId=3f6b2c1e-8d4a-4b7f-9e21-5a0c7d9e1b42'
Exemplo de resposta
{  "accountId": "3f6b2c1e-8d4a-4b7f-9e21-5a0c7d9e1b42",  "balances": [    {      "balanceType": "Available",      "amount": 10550,      "currencyCode": "BRL",      "updatedAt": "2026-11-03T12:00:00Z"    },    {      "balanceType": "Blocked",      "amount": 1200,      "currencyCode": "BRL",      "updatedAt": "2026-11-03T12:00:00Z"    },    {      "balanceType": "PendingWithdrawal",      "amount": 150,      "currencyCode": "BRL",      "updatedAt": "2026-11-03T12:00:00Z"    }  ]}

Consultar extrato bancário GET

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

Evento de cobrança Webhook

Enviado à `postbackUrl` da cobrança quando ela chega a um desfecho. Responda **exatamente 200** depois de gravar o evento. Até três tentativas, com cerca de 60 segundos entre elas. Verifique `X-DM-Signature` (HMAC-SHA256 de `t + "." + corpo cru`).