API Reference/Public checkout
GET

Retrieve a public payment link

Retrieve a public payment link. See the request, response and integration notes.

GET/v1/public/links/{slug}
https://integrate.api.kyvopay.com.br
cURL
curl -X GET https://integrate.api.kyvopay.com.br/v1/public/links/{slug}
Resposta200 OK
{
  "data": {
    "amount_centavos": "4990",
    "business_display_name": "string",
    "collect_customer_data": false,
    "description": "Pedido #12345",
    "min_amount_centavos": "4990",
    "payment_link_id": "01HZ8K3M5N",
    "slug": "string",
    "title": "string",
    "tracking_plugins": "string"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Use this endpoint to retrieve a public payment link.

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