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

Webhooks

Webhook e postback#

O webhook configurado na empresa e o postback informado na criação da transação recebem o mesmo body. O sistema envia esse body quando ocorre um evento da transação.

Exemplo de body: PIX#

{
  "eventId": "9f1d9a0c-7d36-5a57-b635-2d67f23d6a30",
  "event": "transaction.paid",
  "data": {
    "id": "txn_123456",
    "amount": "100.00",
    "currency": "BRL",
    "installments": 1,
    "paymentMethod": "pix",
    "status": "paid",
    "externalRef": "pedido_987",
    "createdAt": "2026-11-06T12:00:00Z",
    "updatedAt": "2026-11-06T12:05:00Z",
    "paidAt": "2026-11-06T12:05:00Z",
    "customer": {
      "id": "123",
      "externalRef": "cliente_456",
      "name": "Nome do cliente",
      "email": "cliente@exemplo.com",
      "phone": "5511999999999",
      "birthdate": "1995-04-10T00:00:00Z",
      "createdAt": "2026-11-06T12:00:00Z",
      "document": {
        "number": "12345678900",
        "type": "cpf"
      },
      "address": {
        "street": "Rua Exemplo",
        "streetNumber": "100",
        "complement": "Apto 1",
        "zipCode": "01000000",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
      }
    },
    "card": null,
    "pix": {
      "qrcode": "conteudo-do-qrcode",
      "brcode": "codigo-copia-e-cola",
      "end2EndId": "identificador-do-pix"
    }
  }
}

Exemplo de dados para cartão#

Em transações com cartão, paymentMethod será normalmente credit_card, pix será null e card poderá conter:
{
  "id": "id-do-cartao",
  "brand": "visa",
  "holderName": "NOME DO TITULAR",
  "lastDigits": "1234",
  "expirationMonth": 12,
  "expirationYear": 2030
}

Campos do body#

CampoDescrição
eventIdIdentificador estável do evento enviado.
eventNome do evento, como transaction.paid.
data.idIdentificador da transação.
data.amountValor da transação como texto decimal, por exemplo "100.00".
data.currencyMoeda da transação, normalmente BRL.
data.installmentsQuantidade de parcelas.
data.paymentMethodMeio de pagamento, como pix ou credit_card.
data.statusStatus público da transação.
data.externalRefReferência externa da transação, quando informada.
data.createdAtData de criação da transação, quando disponível.
data.updatedAtData da última atualização, quando disponível.
data.paidAtData de pagamento, quando disponível.
data.customerDados do cliente, quando disponíveis.
data.cardDados públicos do cartão ou null.
data.pixDados do PIX ou null.
Dentro de customer, o sistema pode enviar id, externalRef, name, email, phone, birthdate, createdAt, document e address.
Dentro de customer.document, os campos são number e type.
Dentro de customer.address, os campos são street, streetNumber, complement, zipCode, neighborhood, city, state e country.
Campos opcionais sem valor podem ser omitidos do JSON. card e pix são enviados mesmo quando não se aplicam ao meio de pagamento; nesse caso, o valor é null.

Eventos e status enviados#

Evento (event)Status (data.status)Quando representa
transaction.createdpendingA transação foi criada.
transaction.pendingpendingA transação está pendente.
transaction.processingprocessingA transação está em processamento.
transaction.paidpaidA transação foi paga com sucesso.
transaction.failedfailedA transação falhou ou foi rejeitada.
transaction.canceledcanceledA transação foi cancelada.
transaction.refundedrefundedA transação foi reembolsada.
transaction.chargebackchargebackA transação teve estorno ou pré-estorno.
transaction.created e transaction.pending são eventos diferentes, mas ambos enviam data.status como pending.
Modificado em 2026-11-06 22:54:39
Página anterior
Autenticação
Próxima página
Criar transação
Built with