Transações PIX

Criar cobrança PIX

Cria uma cobrança PIX e devolve o QR Code copia-e-cola.

Endpoint principal para gerar uma cobrança. O valor é em centavos; o campo `external_id` deve ser único por loja (idempotência). O webhook configurado no projeto é disparado quando o status muda para PAID.

Endpoint

POST /v1/payment-transaction/create

Base URL: https://vanillapag.com

Headers

HeaderValorObrigatório
Authorization* Basic PHN1YS1jaGF2ZS1kZS1hcGk+Ong= Required
Content-Type* application/json Required

Request body

5 campos obrigatórios, 1 opcional. Campos marcados com * são obrigatórios.

FieldTypeRequiredDescription
amount* integer Required Valor em centavos. Mínimo: 100 (R$ 1,00).
external_id* string Required Identificador único do pedido na sua loja.
customer.name* string Required Nome completo do cliente final.
customer.email* string Required E-mail do cliente final.
customer.document* string Required CPF (11 dígitos) ou CNPJ (14 dígitos).
postback_url string Optional Sobrescreve o webhook do projeto para esta cobrança.

Response

FieldTypeDescription
id string ID interno da transação.
status string Status inicial: sempre `PENDING`.
amount integer Valor cobrado em centavos.
qr_code string Payload PIX copia-e-cola.
qr_code_image string URL pública do QR Code em PNG.
expires_at string Data de expiração (ISO 8601).

Example

Request

{
  "amount": 1990,
  "external_id": "pedido-12345",
  "customer": {
    "name": "Cliente Exemplo",
    "email": "[email protected]",
    "document": "12345678901"
  }
}

Response

{
  "id": "tx_2sQfgT...",
  "status": "PENDING",
  "amount": 1990,
  "qr_code": "00020126410014BR.GOV.BCB.PIX...",
  "qr_code_image": "https://vanillapag.com/qr/tx_2sQfgT.png",
  "expires_at": "2026-05-27T17:30:00Z"
}