Pular para o conteúdo principal
POST
Criar link de pagamento

Autorizações

x-api-key
string
header
obrigatório

API Key da organização

Corpo

application/json
products
object[]
obrigatório

Lista de produtos do link (mínimo 1). Cada item pode ser um produto existente (via externalId) ou um produto inline (via name e value).

Minimum array length: 1
paymentMethods
enum<string>[]
obrigatório

Métodos de pagamento aceitos pelo link (mínimo 1).

Minimum array length: 1
Opções disponíveis:
PIX_IN,
CARD,
BOLETO
customer
object

Cliente vinculado ao link (opcional). Quando informado (fullName e document), os dados já vêm preenchidos na página de checkout.

idempotency
string

Identificador único por organização. Evita criar o mesmo link duas vezes; uma segunda chamada com o mesmo valor retorna erro 409.

Minimum string length: 1
callbackOnSuccess
string<uri>

URL para redirecionar o pagador após o pagamento ser confirmado.

callbackOnError
string<uri>

URL para redirecionar o pagador em caso de erro ou cancelamento.

paymentLimit
integer

Número máximo de pagamentos aceitos pelo link. Use 0 ou omita para não limitar (ilimitado).

Intervalo obrigatório: x >= 0
recurrent
boolean

Habilita a recorrência: o pagamento com cartão salva o token do cartão para cobranças automáticas futuras. Exige CARD em paymentMethods.

Resposta

Requisição processada com sucesso

Requisição processada com sucesso

response
object
obrigatório

Dados retornados pela operação; null quando não há conteúdo.

message
string
obrigatório

Mensagem que descreve o resultado.