Docs
Referência da APISaques

Solicitar saque

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.

POST
/api/v1/withdrawals

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.

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.

Cabeçalhos

Idempotency-Key*string

10 a 200 caracteres, única por pedido de saque. Alternativa ao campo idempotencyKey do corpo; o cabeçalho tem precedência.

Tamanho10 <= length <= 200

Corpo da requisição

application/json
  1. body
accountId*string

Conta de origem, entregue no credenciamento.

Formatouuid
amount*integer

Valor em centavos. 25000 é R$ 250,00. Mínimo 100 (R$ 1,00).

Intervalo100 <= value
currencyCode*string
pixKeyType*PixKeyTypeRequest

Tipo da chave no pedido. Chave aleatória é Random; EVP é recusado.

Valores aceitos"CPF""CNPJ""Email""Phone""Random"
pixKey*string

Chave Pix de destino. Precisa ser a cadastrada como destino de saque.

beneficiaryName?string|null
beneficiaryDocument?|

CPF ou CNPJ do titular cadastrado.

idempotencyKey?string
Tamanho10 <= length <= 200

Corpo da resposta

Repetição idempotente. Devolve o saque original com o status atual.

application/json
  1. response
withdrawalId?string
Formatouuid
status?WithdrawalStatus
Valores aceitos"processando""transferido""rejeitado""cancelado""devolvido""expirado""falha"
Exemplo de requisição
curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/withdrawals' \  -H 'Idempotency-Key: saque-2026-11-02-000123' \  -H 'Content-Type: application/json' \  -d '{  "accountId": "3f6b2c1e-8d4a-4b7f-9e21-5a0c7d9e1b42",  "amount": 25000,  "currencyCode": "BRL",  "pixKeyType": "CNPJ",  "pixKey": "11222333000181"}'
Exemplo de resposta
{  "withdrawalId": "01932f5e-7c3a-7b21-9f4e-2d8c6a1b0e47",  "status": "transferido"}