Skip to main content
POST
Requer o header account com o código da conta. O link gerado é imediatamente ativo e pode ser compartilhado com clientes.
Para definir uma imagem no checkout, envie config.image com uma URL pública ou uma string base64. O servidor processa e armazena automaticamente. Se o processamento falhar, o link é criado normalmente e a resposta incluirá o campo image_warning.

Authorizations

Authorization
string
header
required

Token JWT obtido via POST /v1/login. Envie no header Authorization: Bearer <token>.

Headers

account
string
required

Código da conta à qual a operação se aplica

Example:

"acc_abc123xyz"

Body

application/json

O objeto client é opcional. Se omitido, os dados do pagador serão coletados no checkout. Se qualquer campo de client for enviado, os campos name, email, phone e document tornam-se obrigatórios.

items
object[]
required

Produtos ou serviços incluídos no link. Total mínimo (itens + frete) = R$ 5,00.

Minimum array length: 1
client
object
config
object | null

Configurações opcionais do link

Response

Link de pagamento criado com sucesso

mensagem
string
Example:

"Link de pagamento criado com sucesso"

erro
boolean
Example:

false

mensagenserro
string[]
Example:
codigoretorno
integer
Example:

201

id
string
Example:

"00000000-0000-0000-0000-000000000000"

data
object