Autenticação: Bearer JWT ou chave de API do vendedor (TokenAuth)
link retornado na resposta e a pagina de pagamento visivel ao cliente; o mesmo link pode ser pago por varios compradores — cada pagamento bem-sucedido gera um pagamento de venda online (veja Listar pagamentos do checkout) e uma transacao.
Validacoes aplicadas:
- O
seller_iddeve corresponder a um vendedor existente. - A conta unificada e resolvida automaticamente e registrada na linha.
Pre-requisitos
- A conta de vendedor deve existir.
- Um Plano de pagamento deve existir para este vendedor — seu UUID e obrigatorio no corpo.
- O chamador precisa de vinculo de acesso para
seller_id.
Parametros de caminho
UUID unificado da conta.
Corpo da requisicao
UUID do Plano de pagamento que define metodos aceitos (credito/PIX/boleto), limites de parcelas e regras de taxa/juros do boleto.
Nome exibido na pagina publica de pagamento. Maximo 255 caracteres.
Referencia externa livre. Maximo 100 caracteres. Encaminhada como identificador de referencia da transacao na infraestrutura de processamento.
Descricao longa exibida na pagina de pagamento.
Valor total em BRL como valor decimal em reais (
"199.90"). O sistema multiplica 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 ser pago.Resposta
201 Created com o novo link de checkout.
UUID do novo link de checkout.
URL publica de pagamento:
${FRONTEND_BASE_URL}/pagar/{id}. Compartilhe com o comprador.Eco do UUID do plano de pagamento informado.
Sempre
0 na criacao.Erros
| Status | Quando |
|---|---|
400 | Validacao do corpo falhou — por exemplo payment_plan desconhecido, campo obrigatorio ausente, ou Seller not found. |
401 | Credenciais ausentes ou invalidas. |
403 | Autenticado, mas sem vinculo de acesso para seller_id. |