Solicita o reembolso de um pagamento confirmado

POST/v1/refunds

https://integrate.api.kyvopay.com.br

cURL

curl -X POST https://integrate.api.kyvopay.com.br/v1/refunds \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_centavos": 4990,
  "idempotency_key": "pedido-12345",
  "payment_public_id": "01HZ8K3M5N",
  "reason": "string"
}'

Resposta200 OK

{
  "data": {
    "amount_centavos": "4990",
    "failure_reason": "string",
    "id": "01HZ8K3M5N",
    "payment_id": "01HZ8K3M5N",
    "provider_refund_id": "01HZ8K3M5N",
    "public_id": "01HZ8K3M5N",
    "reason": "string",
    "status": "pending"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Requisição

Corpo

amount_centavosinteger

Valor em centavos. R$ 49,90 = 4990.

idempotency_keystring

Chave de idempotência. Repetir a chamada com a mesma chave devolve o resultado original em vez de criar de novo.

payment_public_idstringobrigatório

—

reasonstring

Motivo informado.

Precisa de ajuda? Fale com o suporte