Skip to main content
POST
Criar link de pagamento

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Chave de Idempotência.

Body

application/json
total
number

Valor total em centavos. Mínimo: R$ 5,00 (500 centavos). Se não informado, será calculado a partir dos produtos

Example:

100000

customerId
string

ID do cliente existente

Example:

"customer_123456"

customer
object

Dados do cliente para criar nova conta

successUrl
string

URL de redirecionamento em caso de sucesso

Example:

"https://example.com/success"

failedUrl
string

URL de redirecionamento em caso de falha

Example:

"https://example.com/failed"

needShipping
boolean

Se precisa de envio

Example:

false

notifyCustomer
boolean

Se deve notificar o cliente

Example:

true

devMode
boolean

Se está em modo desenvolvimento

Example:

false

externalId
string

ID externo para rastreamento da charge

Example:

"ext_123456"

items
object[]

Itens da cobrança (opcional)

Response

Link de pagamento já existe (resposta cacheada via idempotência)