Referência da API/Checkout público
POST

Inicia uma sessão de checkout pra um link de pagamento

Inicia uma sessão de checkout pra um link de pagamento

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": "cliente@example.com",
    "name": "Cliente Exemplo",
    "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"
}

Dica

Rota pública, usada pela página de checkout de quem está pagando. Não leva chave de API.

Requisição

Parâmetros

slugstringobrigatório

Trecho da URL pública do link.

Idempotency-Keystring

Chave de idempotência da operação.

Corpo

amount_centavosinteger

Valor em centavos. R$ 49,90 = 4990.

customerobject

Dados do cliente.

trackingobject

Parâmetros de rastreio da venda. Alimentam os plugins UTMify e Meta Pixel.

Precisa de ajuda? Fale com o suporte
© 2026 KyvoPay