API Reference/Public checkout
POST

Start a public checkout session

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

POST/v1/public/links/{slug}/checkout
https://integrate.api.kyvopay.com.br
cURL
curl -X POST https://integrate.api.kyvopay.com.br/v1/public/links/{slug}/checkout \
  -H "Content-Type: application/json" \
  -d '{
  "amount_centavos": 4990,
  "customer": {
    "document": "12345678909",
    "email": "customer@example.com",
    "name": "Example Customer",
    "phone": "11999999999"
  },
  "tracking": {
    "event_source_url": "string",
    "fbc": "string",
    "fbp": "string",
    "ip": "string",
    "sck": "string",
    "src": "string",
    "user_agent": "string",
    "utm_campaign": "string",
    "utm_content": "string",
    "utm_medium": "string",
    "utm_source": "string",
    "utm_term": "string"
  }
}'
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 start a public 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.
Need help? Contact support
© 2026 KyvoPay