Docs
Referência da APISaques

Consultar saque

Devolve o estado atual de um saque. Saque de outra conta responde `404`, igual a um inexistente.

GET
/api/v1/withdrawals/{id}

Devolve o estado atual de um saque. Saque de outra conta responde 404, igual a um inexistente.

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

id*string
Formatouuid

Corpo da resposta

O saque.

application/json
  1. response
id?string
Formatouuid
status?WithdrawalStatus
Valores aceitos"processando""transferido""rejeitado""cancelado""devolvido""expirado""falha"
amount?integer

Centavos.

currencyCode?string
pixKeyType?string

Grafia de resposta; difere da grafia do pedido.

Valores aceitos"CPF""CNPJ""EMAIL""PHONE""EVP"
pixKey?string

Mascarada.

createdAt?string
Formatodate-time
pixEndToEndId?|

Preenchido em transferido.

transferredAt?|
Formatodate-time
rejectedAt?|

Preenchido em rejeitado e expirado.

Formatodate-time
rejectionReason?string|null
rejectionSource?|
Valores aceitos"operator""merchant""system""bank_return"null
failedAt?|
Formatodate-time
failureCode?|

Informativo. Não monte lógica sobre o valor.

failureMessage?|

Informativo.

Exemplo de requisição
curl -X GET 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/withdrawals/01932f5e-7c3a-7b21-9f4e-2d8c6a1b0e47'
Exemplo de resposta
{  "id": "01932f5e-7c3a-7b21-9f4e-2d8c6a1b0e47",  "status": "transferido",  "amount": 25000,  "currencyCode": "BRL",  "pixKeyType": "CNPJ",  "pixKey": "************81",  "createdAt": "2026-11-02T14:58:03.412718Z",  "pixEndToEndId": "E00000000202611021508Ab12Cd34Ef5",  "transferredAt": "2026-11-02T15:08:41.090233Z",  "rejectedAt": null,  "rejectionReason": null,  "rejectionSource": null,  "failedAt": null,  "failureCode": null,  "failureMessage": null}