Skip to main content
POST
Criar link de pagamento

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Parâmetros de caminho

productID
string<uuid>
obrigatório

ID do produto.

Corpo

application/json

Opcional. Um link não precisa de configuração; envie corpo só para definir para onde o pagador vai depois, ou para vender uma oferta. As URLs precisam ser absolutas http(s).

successUrl
string | null

Para onde o pagador vai depois de pagar, com ?status=success&invoice=… anexado.

Maximum string length: 2048
cancelUrl
string | null

Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto.

Maximum string length: 2048
productVersionId
string<uuid> | null

Vende uma versão publicada específica em vez da padrão. É assim que um preço promocional chega ao comprador: a versão é publicada com default: false e só um link que a indique consegue vendê-la. Omita para vender a versão padrão. Recusado se a versão não for uma versão publicada deste produto.

Resposta

Link criado.

Um link de pagamento reutilizável e revogável, ligado a um produto. Quem tem o link pode abrir o checkout; ele é feito para ser copiado e compartilhado.

id
string<uuid>
productId
string<uuid>
token
string

Token público do link, parte da url.

url
string

O endereço para mandar ao pagador. Use este valor em vez de montar a URL.

productVersionId
string<uuid> | null

A versão do produto que o link vende, fixada na criação. Publicar uma nova versão não altera o preço de um link já emitido. Quando null, o link vende a versão publicada mais recente no momento do pagamento.

active
boolean

false depois de revogado.

revokedAt
string<date-time> | null

Quando o link foi revogado.

createdAt
string<date-time>
successUrl
string | null

Para onde o pagador vai depois de pagar, com ?status=success&invoice=… anexado.

cancelUrl
string | null

Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto; também é o destino com ?status=error quando a cobrança expira no checkout embutido.