Skip to main content
POST
Criar link de pagamento

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Body

application/json
title
string
required

Título do link

Required string length: 3 - 255
product_type
enum<string>
required

Tipo do produto

Available options:
physical,
digital
allowed_payment_methods
enum<string>[]
required

Métodos de pagamento aceitos

Minimum array length: 1
Available options:
credit_card,
debit_card,
pix,
boleto
submerchant_id
string<uuid>

ID do submerchant. Quando informado, a cobrança gerada será processada com split para o submerchant.

description
string

Descrição

Maximum string length: 1000
amount
integer

Valor em centavos. Se omitido, o comprador poderá informar o valor.

Required range: x >= 1
currency
string
default:BRL

Código da moeda

Required string length: 3
max_installments
integer
default:1

Máximo de parcelas

Required range: 1 <= x <= 24
expires_at
string<date-time>

Data de expiração (ISO 8601)

max_uses
integer

Limite de usos

Required range: x >= 1
metadata
object

Dados adicionais

redirect_url
string<uri>

URL para redirecionar o comprador apos o pagamento ser confirmado

Maximum string length: 2048
primary_color
string

Cor primária do checkout em hexadecimal (ex: #FF5733)

summary_panel_color
string

Cor do painel de resumo em hexadecimal

merchant_logo_url
string<uri>

URL do logo do merchant no checkout

Response

Link criado com sucesso

success
boolean
Example:

true

message
string
data
object