Links de pagamento

Buscar link de pagamento

Retorna os detalhes completos de uma página de pagamento, incluindo produtos e formas de pagamento aceitas.

O identificador aceita diferentes prefixos: cha_ (cobrança), cs_ (sessão), price_ (preço) e pl_ (payment link). A autenticação é opcional — o checkout pode ser consultado publicamente.

GET/v1/checkouts/:id

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string · header · required

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

checkouts/read

Path Parameters

Name	Type	Required	Description
id	string	Required	ID do checkout / payment link (ex: pl_xxx) - required

← Anterior

Listar links de pagamento

Atualizar link de pagamento

const url = 'https://sandbox.validapay.com.br/v1/checkouts/:id';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200

{
  "id": "pl_xxx",
  "status": "ACTIVE",
  "priceId": "price_xxx"
}

404404

{
    "error": {
        "message": "Checkout não encontrado",
        "code": "CHECKOUT_NOT_FOUND",
        "details": null,
        "timestamp": "2026-07-14T21:39:36.322Z"
    }
}

← Anterior

Listar links de pagamento

Atualizar link de pagamento