API references
Search documentation... ⌘K
API references
<h2>Payment completed</h2> <p>This event is triggered whenever a payment status transitioned to either <code>SUCCESSFUL</code> or <code>FAILED</code>.</p>
Event signature
Event: payment_completed
POST <webhook_endpoint_destination_url> HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Webhook-Signature: <signature>
{
event_id: string,
event: string,
payment_id: string,
status: string,
}
Attributes
Attribute Description
event_id
string

The unique identifier for the event

event
string

The event name that triggered the webhook. Indicates the type of payment state change that occurred.

Possible values:
  • payment_completed
payment_id
string

Unique identifier for the payment. This is the payment's UID that can be used to reference the payment in API calls.

status
string

Current status of the payment.

Possible values:
  • SUCCESSFUL
  • FAILED