Docs
Referência da APISaques

Cancelar saque

Cancela um saque ainda em análise. Idempotente. A devolução do valor ao saldo é assíncrona. Se o saque já foi aprovado, responde `409 withdrawal.cannot_cancel`.

POST
/api/v1/withdrawals/{id}/cancel

Cancela um saque ainda em análise. Idempotente. A devolução do valor ao saldo é assíncrona. Se o saque já foi aprovado, responde 409 withdrawal.cannot_cancel.

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

Saque cancelado.

application/json
  1. response
withdrawalId?string
Formatouuid
status?string
reversalTransactionId?null
Exemplo de requisição
curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/withdrawals/01932f5e-7c3a-7b21-9f4e-2d8c6a1b0e47/cancel'
Exemplo de resposta
{  "withdrawalId": "01932f5e-7c3a-7b21-9f4e-2d8c6a1b0e47",  "status": "cancelado",  "reversalTransactionId": null}

Tokenizar cartão POST

Troca os dados do cartão por um token reutilizável (`ctok_…`). Não cobra nada. Se o mesmo cartão já tem token ativo para o mesmo `customerId`, responde `200` com o token existente e `deduplicated: true`. Nesta rota o código de segurança é `cvv` (não `cvc`) e os erros usam o envelope `{code, message}`. Disponível no sandbox; confirme a habilitação em produção com a equipe de integração.

Consultar saque GET

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