API Reference/Public checkout
POST
Pay a checkout session
Pay a checkout session. See the request, response and integration notes.
POST
/v1/public/checkout/{sessionId}/payhttps://integrate.api.kyvopay.com.br
cURL
curl -X POST https://integrate.api.kyvopay.com.br/v1/public/checkout/{sessionId}/payResposta200 OK
{
"data": {
"amount_centavos": "4990",
"id": "01HZ8K3M5N",
"pix_copy_paste": "string",
"pix_qr_code": "string",
"public_id": "01HZ8K3M5N",
"status": "pending"
},
"error": {
"code": "string",
"details": {},
"message": "string"
},
"request_id": "req_01HZ8K3M5N"
}Use this endpoint to pay a checkout session. 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
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.