API Reference/Payments
POST
Cancel a payment
Cancel a payment. See the request, response and integration notes.
POST
/v1/payments/{public_id}/cancelhttps://integrate.api.kyvopay.com.br
cURL
curl -X POST https://api.kyvopay.com.br/v1/payments/pay_ABC123/cancel \
-H "X-API-Key: kyvo_test_SUA_CHAVE"Authentication
X-API-Keystring · headerrequiredUse the ky_... key created under Integrations → API Keys in the KyvoPay dashboard.
Use this endpoint to cancel a payment. For safe retries, reuse the same idempotency key for the same business operation.
Request
Note
Private endpoints require the X-API-Key header. Keep credentials on your backend and log the response request_id for diagnostics.
Response
The response uses the standard data, error and request_id envelope.
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.