Criar link de pagamento

Endpoint para criar um novo link de pagamento.

Links de pagamento continuam suportados e são parte do fluxo padrão.

Para integrações Server-to-Server, a forma mais direta e recomendada de criar um pagamento é /api/v1/direct/payment.

💾 Estrutura de Dados

Headers

  • Content-type: application/json
  • Authorization: Bearer <JWT_TOKEN>

Body (JSON)

PropriedadeTipoObrigatórioDescriçãoValor (exemplo)
amountNumberSimValor do link de pagamento300.50
descriptionStringSimDescrição breve sobre o link de pagamento-
checkoutDomainStringNãoDomínio próprio (do seller) em que o checkout do link será servido. Se omitido, o domínio ativo do seller é resolvido automaticamente. Use GET /api/v1/payment-links/available-domains para listar os domínios disponíveis.loja.seudominio.com

🌐 Domínio do checkout

O campo url retornado aponta para o domínio próprio do seller (ex.: https://loja.seudominio.com/checkout/link-xxxx), e não para o domínio da plataforma. Basta usar o url da resposta para direcionar o comprador — não monte a URL manualmente.

  • O seller precisa ter um domínio próprio ativo configurado. Sem domínio ativo, o url não é publicável e o checkout público é bloqueado.
  • Se o seller tiver mais de um domínio, informe qual usar em checkoutDomain.
  • Este requisito vale apenas para links de pagamento (checkout hospedado). O fluxo POST /api/v1/direct/payment (cobrança direta no seu próprio site) não exige domínio.

Sem domínio próprio ativo

Se o seller não tiver um domínio próprio ativo, a criação do link é recusada com 400:

{
  "message": "Domínio de checkout obrigatório.",
  "action": "Conecte um domínio próprio ativo a uma das suas lojas para criar links de pagamento."
}

O link não é criado porque ele nasceria inutilizável: o checkout hospedado só é servido no domínio próprio do seller. Conecte o domínio (painel → Checkout → Domínio) e aguarde ficar ativo (DNS + SSL).

Isto vale apenas para links de pagamento. POST /api/v1/direct/payment (cobrança direta no seu próprio site) continua funcionando sem domínio — nesse fluxo o checkout é o seu, não o nosso.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json