Skip to main content
WEBHOOK

Body

application/json

Represents an occurrence in the system that triggers the webhook, containing an identifier, event type, and relevant data.

id
string
required

Unique identifier for a webhook event

Required string length: 24 - 50
Pattern: ^evt_[a-zA-Z0-9]{20,}$
Example:

"evt_1234567890abcdef1234"

type
enum<string>
required

Type of webhook event

Available options:
payment_request.created,
payment_request.updated,
payment_request.paid
Example:

"payment_request.created"

data
object
required

A Payment Request represents a request for payment that can be shared via a link or sent to a banking app for authorization and Payment.

Example:

Response

200

Return a 200 status to indicate that the data was received successfully