API Reference/Public checkout
GET

Retrieve a checkout session

Retrieve a checkout session. See the request, response and integration notes.

GET/v1/public/checkout/{sessionId}
https://integrate.api.kyvopay.com.br
cURL
curl -X GET https://integrate.api.kyvopay.com.br/v1/public/checkout/{sessionId}
Resposta200 OK
{
  "data": {
    "amount_centavos": "4990",
    "expires_at": "2026-01-01T12:30:00Z",
    "id": "01HZ8K3M5N",
    "original_amount_centavos": "4990",
    "payment": {
      "id": "01HZ8K3M5N",
      "pix_copy_paste": "string",
      "pix_qr_code": "string",
      "public_id": "01HZ8K3M5N",
      "status": "pending"
    },
    "payment_id": "01HZ8K3M5N",
    "status": "pending"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Use this endpoint to retrieve a checkout session.

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.
Need help? Contact support
© 2026 KyvoPay