Autenticação: Bearer JWT ou chave de API do vendedor (TokenAuth)
10, maximo 100).
Pre-requisitos
- A conta de vendedor deve existir — veja Cadastrar vendedor.
- O chamador precisa ter vinculo de acesso a conta, ou ser um superusuario. Veja Autenticacao e acesso.
- Um Plano de pagamento deve existir antes da criacao de qualquer link, mas a listagem simples retorna uma pagina vazia quando nao houver nenhum.
Parametros de caminho
UUID unificado da conta (o mesmo id usado nas rotas com escopo de vendedor).
Parametros de consulta
Busca textual (case-insensitive) sobre
name, reference e description.Numero da pagina (1-based).
Tamanho da pagina, limitado a
100.Resposta
Envelope padrao paginado.Total de links de checkout que correspondem ao filtro.
URL da proxima pagina, ou
null na ultima pagina.URL da pagina anterior, ou
null na primeira pagina.Lista de objetos de link de checkout (campos abaixo).
UUID do link de checkout.
UUID do Plano de pagamento usado por este link.
Nome exibido na pagina publica de pagamento.
Referencia externa livre (usada como identificador de referencia da cobranca na infraestrutura de processamento).
Descricao longa exibida na pagina de pagamento.
Valor total em BRL como valor decimal em reais (ex.:
"199.90"). Internamente multiplicado por 100 para obter centavos antes do envio. Inconsistencia conhecida com a convencao de centavos do restante da API.Data ISO-8601 (
YYYY-MM-DD) apos a qual o link nao deve mais ser pago.URL publica de pagamento no formato
${FRONTEND_BASE_URL}/pagar/{id}. Compartilhe esta URL com o comprador.Quantidade de pagamentos ja criados sob este link.
Erros
| Status | Quando |
|---|---|
401 | Token ou chave de API ausente/invalido. |
403 | Autenticado, mas sem vinculo de acesso para seller_id. |
404 | seller_id nao corresponde a nenhuma conta. |