Webhook

Evento de cobrança (pagamento)

​

Enviado para a callbackUrl quando o status de uma cobrança muda (ex.: confirmada). Responda 2xx rápido e trate idempotência pelo payload.id (pode haver reentrega).

Body
application/json
    • deliveryAttempt
      Type: integer

      Integer numbers.

    • eventType
      Type: stringenum

      Tipo do evento.

      values
      • payment.completed
      • payment.expired
      • payment.refunded
      • withdraw.completed
      • withdraw.failed
      • withdraw.canceled
    • payload
      Type: object ·
    • timestamp
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Responses
  • 200

    Recebido

Request Example for postpaymentStatus
{
  "eventType": "payment.completed",
  "deliveryAttempt": 1,
  "timestamp": "",
  "payload": {
    "id": "",
    "externalId": "TX-9931",
    "status": "PENDING",
    "amount": 1990,
    "paidAt": "",
    "payerName": "Maria Souza",
    "payerDocument": "***.456.789-**",
    "endToEndId": "E1234567890...",
    "merchantId": ""
  }
}
No Body

Recebido

PayerPix