Skip to main content
POST
Crie uma nova transação (venda) na plataforma. Você pode processar pagamentos via PIX, Cartão de Crédito, Cartão de Débito ou Boleto.

Autenticação

Este endpoint requer autenticação via API Keys:
string
required
Sua chave pública da API
string
required
Sua chave privada da API

Parâmetros do Body

integer
required
Valor da transação em centavos (ex: 10000 = R$ 100,00)
string
required
Método de pagamento. Valores possíveis: CREDIT_CARD, DEBIT_CARD, BOLETO, PIX, TRANSFER
object
required
Dados do cliente
string
required
Nome completo do cliente
string
required
Email do cliente
object
Documento do cliente (CPF ou CNPJ)
string
Tipo do documento: cpf ou cnpj
string
Número do documento
string
Telefone do cliente no formato 11999999999 (sem caracteres especiais)
object
Informações do cartão (obrigatório para CREDIT_CARD ou DEBIT_CARD)
string
Número do cartão (será tokenizado - apenas últimos 4 dígitos são armazenados)
string
Nome do portador do cartão (será tokenizado)
string
Mês de expiração no formato MM
string
Ano de expiração no formato YYYY
string
CVV do cartão (não é armazenado conforme PCI DSS)
integer
Número de parcelas (apenas para cartão de crédito)
object
Informações do PIX (obrigatório para PIX)
string
Chave PIX do recebedor
integer
Número de dias para expiração do PIX
object
Informações do boleto (obrigatório para BOLETO)
integer
Número de dias para expiração do boleto
array
required
Lista de itens da transação
string
required
Nome do produto
integer
required
Preço unitário em centavos
integer
required
Quantidade do item
boolean
required
Se o item é físico (true) ou digital (false)
integer
ID do produto (opcional)
string
ID do plano (opcional)
string
Nome do plano (opcional)
string
ID customizado do item (opcional)
object
Informações de entrega (obrigatório quando há itens físicos com tangible: true)
string
Rua
string
Número
string
Complemento
string
CEP
string
Bairro
string
Cidade
string
Estado (2 dígitos em maiúscula, ex: SP)
string
País (2 dígitos, ex: br)
object
Configuração de parcelas (apenas para cartão de crédito)
integer
Número de parcelas (1 a 12)
string
URL para receber notificações de mudança de status da venda
string
Origem da campanha (UTM Source). Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
string
Meio da campanha (UTM Medium). Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
string
Nome da campanha (UTM Campaign). Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
string
Conteúdo da campanha (UTM Content). Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
string
Termo da campanha (UTM Term). Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
string
Fonte personalizada. Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
string
Código de campanha personalizado. Funciona para qualquer método de pagamento (PIX, cartão, boleto, etc.)
object
Dados adicionais da venda (objeto JSON livre)

Códigos de Erro

Status HTTP