Create a refund

Create a refund. See the request, response and integration notes.

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": "order-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"
}

Authentication

X-API-Keystring · headerrequired

Use the ky_... key created under Integrations → API Keys in the KyvoPay dashboard.

Use this endpoint to create a refund. For safe retries, reuse the same idempotency key for the same business operation.

Request

Private endpoints require the X-API-Key header. Keep credentials on your backend and log the response request_id for diagnostics.

Response

Implementation notes

Validate required input before sending the request.
Store returned public identifiers without assuming their format.
Treat 4xx validation errors as non-retryable until the request is corrected.
Retry timeouts, 429 and temporary 5xx responses with exponential backoff.
Keep the idempotency key stable across retries.

Need help? Contact support