Payment Link Webhook Documentation

Overview

The Payment Link webhook provides real-time notifications for payment link events, including payment confirmations and status updates. This webhook is essential for maintaining up-to-date information about your payment link transactions.

Webhook Configuration

Webhook Type

Type: PAYMENT_LINK_INBOUND
Events: Payment confirmations and status updates
Endpoint: Your registered webhook URL

Registration

To receive Payment Link webhooks, you must register a webhook endpoint using the Webhook API:

Webhook Events

Payment Confirmation Event

Triggered when a payment link is successfully paid.

Status Update Event

Triggered when a payment link status changes (expired, cancelled, etc.).

Webhook Payload Structure

The webhook payload follows the PaymentLinkMessageClientRequest format and includes the following fields:

{
  "paymentLinkUuid": "c1fac1de-b4f8-4dfe-bdbd-bd0ce9b4c919",
  "paymentDate": "2024-01-15T10:30:00.000Z",
  "paymentMethod": "PIX",
  "paymentId": "astra250123160327254lnk003102r2rcZ",
  "paymentReceipt": "457856445",
  "amount": 100.00,
  "userReference": "order-12345"
}

Payload Fields

Field	Type	Description
`paymentLinkUuid`	string	Unique identifier of the payment link
`paymentDate`	string	ISO 8601 timestamp of the payment
`paymentMethod`	string	Payment method used (CREDIT_CARD, PIX)
`paymentId`	string	Transaction identifier for the payment
`paymentReceipt`	string	Payment receipt identifier (NSU for credit card, EndToEnd for PIX)
`amount`	number	Payment amount
`userReference`	string	Client's reference identifier (if provided during link creation)

Event Types

Payment Events

Credit Card Payment Confirmation

{
  "paymentLinkUuid": "c1fac1de-b4f8-4dfe-bdbd-bd0ce9b4c919",
  "paymentDate": "2024-01-15T10:30:00.000Z",
  "paymentMethod": "CREDIT_CARD",
  "paymentId": "astra250123160327254lnk003102r2rcZ",
  "paymentReceipt": "457856445",
  "amount": 100.00,
  "userReference": "order-12345"
}

PIX Payment Confirmation

{
  "paymentLinkUuid": "c1fac1de-b4f8-4dfe-bdbd-bd0ce9b4c919",
  "paymentDate": "2024-01-15T10:30:00.000Z",
  "paymentMethod": "PIX",
  "paymentId": "astra250123160327254lnk003102r2rcZ",
  "paymentReceipt": "E12345678202401151030123456789",
  "amount": 100.00,
  "userReference": "order-12345"
}

This webhook documentation ensures reliable integration with Payment Link events for real-time payment processing.