Docs
Referência da APISaldo e extrato

Consultar comprovante de lançamento

Detalhe de um lançamento. Hoje só Pix recebido tem comprovante; os demais respondem `422 Statement.DetailNotAvailable`, definitivo.

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

Detalhe de um lançamento. Hoje só Pix recebido tem comprovante; os demais respondem 422 Statement.DetailNotAvailable, definitivo.

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.

entryId*string

Corpo da resposta

Comprovante.

application/json
  1. response
id?string
accountNumber?string
type?string

Enum aberto.

pix?

Omitido quando não se aplica.

Exemplo de requisição
curl -X GET 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/bank-accounts/29600685/statement/stme-AAECAwQFBgc'
Exemplo de resposta
{  "id": "string",  "accountNumber": "string",  "type": "pix_cashin",  "pix": {    "endToEndId": "string",    "payer": {      "name": "string",      "document": "string",      "bankName": "string",      "agency": "string",      "accountNumber": "string"    },    "payee": {      "name": "string",      "document": "string",      "bankName": "string",      "agency": "string",      "accountNumber": "string"    }  }}

Solicitar saque POST

Cria um pedido de saque por Pix para a chave de destino cadastrada da conta. O valor é reservado no saldo e o pedido entra em análise. `201` confirma o pedido, não o envio do Pix. `amount` é inteiro em centavos, como nas cobranças: `25000` é R$ 250,00. Decimal ou texto recebem `400 withdrawal.validation_failed`. No sandbox, o Pix de saída é simulado.

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