Skip to main content
POST
Criar Transação

Authorizations

Authorization
string
header
required

Bearer Token gerado em Configurações > Tokens de API.

Body

application/json
amount
integer
required

Valor em centavos (mínimo: 500 = R$ 5,00).

Required range: x >= 500
Example:

1000

client_name
string
required

Nome completo do pagador.

Example:

"João Silva"

client_email
string<email>
required

E-mail válido do pagador.

Example:

"joao@email.com"

client_doc
string
required

CPF ou CNPJ (apenas números ou formatado).

Example:

"123.456.789-00"

client_phone
string

Telefone do pagador.

Example:

"(11) 99999-9999"

webhook_url
string<uri>

URL para receber notificações de status.

ip
string

IP do cliente. Se não enviado, é capturado automaticamente.

metadata
object

Objeto JSON com dados extras (máximo 20 chaves).

utms
object

Objeto com parâmetros UTM de rastreamento.

items
object[]

Itens que compõem o pedido (máximo 50), para descrever o que está sendo vendido. Campo opcional e retrocompatível: requisições sem items continuam funcionando como antes. Os itens são puramente descritivos — não criam produtos na plataforma. O valor cobrado é sempre o amount da transação; a soma dos itens não altera a cobrança. Recomendamos que a soma de price × quantity seja igual ao amount.

Maximum array length: 50

Response

Transação criada

status
string
Example:

"success"

data
object