1. Transações
Vertex Pagamentos
  • Vertex - API de Pagamentos
    • Autenticação
    • Webhooks
    • Transações
      • Criar transação
        POST
      • Consultar transação
        GET
  • Purple WL - API de Transações
    • Se interessou na tecnologia?
  1. Transações

Criar transação

POST
/api/v1/public/payment/transaction
Cria uma cobrança PIX ou de cartão de crédito.
paymentMethod aceita pix, credit ou credit_card sem distinção de
maiúsculas/minúsculas. O servidor normaliza a moeda para letras maiúsculas
e usa BRL quando currency não é enviada.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Transação Pix
application/json
Transação criada
Bodyapplication/json

🟢200Transação Cartão
🟠400BadRequest
🟠401Unauthorized
🔴500InternalServerError
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/v1/public/payment/transaction' \
--header 'X-Client-Id;' \
--header 'X-Public-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 10000,
    "paymentMethod": "pix",
    "currency": "BRL",
    "pix": {
        "expiresInDays": 1
    },
    "customer": {
        "id": "7f64d5c0-2709-4cb0-8b45-08b25781c174",
        "country": "BR",
        "name": "Maria da Silva",
        "email": "maria@example.com",
        "document": {
            "number": "12345678909",
            "type": "cpf"
        },
        "phone": "5511999999999",
        "externalRef": "CAMPANHA-1"
    },
    "shipping": {
        "fee": 0,
        "address": {
            "street": "Avenida Paulista",
            "streetNumber": "1000",
            "complement": "Apto 12",
            "zipCode": "01310100",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "state": "SP",
            "country": "BR"
        }
    },
    "items": {
        "title": "Tênis Bonito",
        "unitPrice": 10000,
        "quantity": 1,
        "tangible": true,
        "externalRef": "TENBON-123"
    },
    "postbackUrl": "https://merchant.example.com/webhooks/transactions",
    "metadata": "metadata",
    "traceable": false,
    "ip": "127.0.0.1",
    "userAgent": "userAgent",
    "trackingSessionId": "trackingSessionId",
    "tracking": {
        "src": "string",
        "sck": "string",
        "utm_source": "string",
        "utm_campaign": "string",
        "utm_medium": "string",
        "utm_content": "string",
        "utm_term": "string",
        "fbp": "string",
        "fbc": "string",
        "fbclid": "string",
        "ttp": "string",
        "ttclid": "string",
        "event_id": "string",
        "event_source_url": "string",
        "referrer": "string"
    }
}'
Response Response Example
200 - PIX criado
{
    "id": "ch_01JXYZ123",
    "amount": "3.00",
    "currency": "BRL",
    "installments": 1,
    "paymentMethod": "pix",
    "status": "pending",
    "externalRef": "pedido-123",
    "createdAt": "2026-08-20T14:30:00-03:00",
    "customer": {
        "name": "Maria da Silva",
        "email": "maria@example.com",
        "phone": "5511999999999",
        "document": {
            "number": "12345678909",
            "type": "cpf"
        }
    },
    "card": null,
    "pix": {
        "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
        "brcode": "00020101021226850014br.gov.bcb.pix...",
        "end2EndId": null
    }
}
Modificado em 2026-09-02 19:47:32
Página anterior
Webhooks
Próxima página
Consultar transação
Built with