Docs
Referência da APIEstornos

Solicitar estorno

Pede o estorno **integral** e assíncrono de uma cobrança `Succeeded`. `202` confirma o pedido, não a devolução. O desfecho chega pelos webhooks `payment_intent.refunded` e `payment_intent.refund_failed`. A chave de idempotência vai no **corpo**.

POST
/api/v1/paymentintents/{id}/refund-requests

Pede o estorno integral e assíncrono de uma cobrança Succeeded. 202 confirma o pedido, não a devolução. O desfecho chega pelos webhooks payment_intent.refunded e payment_intent.refund_failed. A chave de idempotência vai no corpo.

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 requisição

application/json
  1. body
reason?string
idempotencyKey?string

Corpo da resposta

Pedido aceito. Com estorno já em andamento, devolve o mesmo refundId.

application/json
  1. response
refundId?string
status?string
Valores aceitos"requested""processing""pending_review"
Exemplo de requisição
curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/paymentintents/8b727267-bf39-48a4-91ea-eb0780cb48a9/refund-requests' \  -H 'Content-Type: application/json' \  -d '{  "reason": "Cancelamento solicitado pelo comprador",  "idempotencyKey": "estorno-pedido-1001-tentativa-1"}'
Exemplo de resposta
{  "refundId": "rfnd_EXEMPLO",  "status": "requested"}