Skip to main content
WEBHOOK
/
PAYMENT_PAID
{
  "event": "PAYMENT_PAID",
  "transaction": {
    "id": "12345",
    "shopId": "shop_001",
    "status": "PAID",
    "paidAt": "2025-03-19T15:30:45Z",
    "ip": "192.168.0.1",
    "TransactionItem": [
      {
        "id": "item_001",
        "name": "Tênis Nike",
        "quantity": 123,
        "price": 123,
        "total": 123
      }
    ],
    "TransactionShipping": {
      "id": "shipping_001",
      "street": "Av. Brasil",
      "streetNumber": "123",
      "complement": "Apto. 301",
      "neighborhood": "Centro",
      "city": "Belo Horizonte",
      "state": "MG",
      "country": "Brasil",
      "zipCode": "30130145"
    },
    "TransactionCard": {
      "id": "card_001",
      "holderName": "João Silva",
      "lastDigits": "1234",
      "brand": "Visa",
      "expirationMonth": 12,
      "expirationYear": 2025
    },
    "TransactionPix": {
      "id": "pix_001",
      "qrCode": "qr_code_example",
      "paymentStatus": "PAID"
    }
  },
  "Shop": {
    "id": "shop_001",
    "name": "Loja Exemplo",
    "email": "[email protected]",
    "domain": "lojaexemplo.com",
    "state": "MG",
    "country": "Brasil",
    "countryCode": "BR",
    "address1": "Rua Exemplo",
    "address2": "Apto 101",
    "zip": "30130145",
    "city": "Belo Horizonte",
    "phone": "+55 31 98834-1222",
    "documentNumber": "12345678000199",
    "companyName": "Loja Exemplo Ltda",
    "logoUrl": "https://example.com/logo.png",
    "neighborhood": "Centro",
    "addressNumber": "123"
  },
  "status": "PAYMENT_PAID",
  "paidAt": "2025-03-19T15:30:45Z",
  "ip": "192.168.0.1",
  "tracking": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "promo_summer_sale",
    "utmContent": "banner_ad",
    "utmTerm": "sneakers"
  }
}

Response

retorno do webhook

event
string

Tipo de evento

Example:

"PAYMENT_PAID"

transaction
object
Shop
object

Informações da loja

status
string

Status da transação

Example:

"PAYMENT_PAID"

paidAt
string | null

Data do pagamento (se realizado)

Example:

"2025-03-19T15:30:45Z"

ip
string | null

IP do cliente

Example:

"192.168.0.1"

tracking
object

Informações de rastreamento