Skip to main content
POST
Criar transação

Authorizations

API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
product
string
required

Nome ou descrição do produto/serviço

Maximum string length: 255
amountCents
integer
required

Valor em centavos. Exemplo: 9900 = R$ 99,00

Required range: 1 <= x <= 100000000
clientName
string
required

Nome completo do cliente

Maximum string length: 255
clientEmail
string<email>
required

Email do cliente

Maximum string length: 255
clientDocument
string
required

CPF ou CNPJ do cliente (apenas números). Mínimo 11 dígitos.

Required string length: 11 - 20
clientPhone
string | null

Telefone do cliente. Exemplo: 11999999999

Maximum string length: 20
paymentMethod
enum<string>
default:PIX

Método de pagamento

Available options:
PIX,
CARD,
BOLETO

ID do link de pagamento associado (opcional)

installments
integer

Número de parcelas (apenas cartão de crédito)

Required range: 1 <= x <= 12
dueDate
string<date-time>

Data de vencimento (opcional)

metadata
object

Dados adicionais personalizados. Exemplo: { "orderId": "4836572", "source": "checkout-parceiro" }

trackingParams
object

Parâmetros de rastreamento UTM

postbackUrl
string<uri> | null

URL para receber notificação de mudança de status desta transação via HTTP POST. Enviado quando o status muda para COMPLETED ou FAILED. Inclui header X-Webhook-Signature com assinatura HMAC-SHA256 para validação.

Response

Transação criada com sucesso

message
string
transaction
object