Consulta um link de pagamento da empresa dona da chave de API

GET/v1/payment-links/{linkId}

https://integrate.api.kyvopay.com.br

cURL

curl -X GET https://integrate.api.kyvopay.com.br/v1/payment-links/{linkId} \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX"

Resposta200 OK

{
  "data": {
    "amount_centavos": "4990",
    "checkouts_started": 0,
    "collect_customer_data": false,
    "description": "Pedido #12345",
    "expires_at": "2026-01-01T12:30:00Z",
    "id": "01HZ8K3M5N",
    "max_sales": "string",
    "min_amount_centavos": "4990",
    "name": "Cliente Exemplo",
    "revenue_centavos": "4990",
    "sales_count": 0,
    "slug": "string",
    "starts_at": "2026-01-01T12:00:00Z",
    "status": "pending",
    "visits": 0
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Requisição

Parâmetros

linkIdstringobrigatório

Parâmetro de rota.

Precisa de ajuda? Fale com o suporte

{ "data": { "amount_centavos": "4990", "checkouts_started": 0, "collect_customer_data": false, "description": "Pedido #12345", "expires_at": "2026-01-01T12:30:00Z", "id": "01HZ8K3M5N", "max_sales": "string", "min_amount_centavos": "4990", "name": "Cliente Exemplo", "revenue_centavos": "4990", "sales_count": 0, "slug": "string", "starts_at": "2026-01-01T12:00:00Z", "status": "pending", "visits": 0 }, "error": { "code": "string", "details": {}, "message": "string" }, "request_id": "req_01HZ8K3M5N" }