Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
simulate-event

Simulate webhook event

Simulates a webhook event. In the JSON request body, specify a sample payload. <br/> You need to subscribe to the following webhook events for Pay upon Invoice:<br/><table><thead><tr><th>Event</th><th>Trigger</th></tr></thead><tbody><tr><td><code>PAYMENT.CAPTURE.COMPLETED</code></td><td>A payment capture completes.</td></tr><tr><td><code>PAYMENT.CAPTURE.DENIED</code></td><td>A payment capture is denied.</td></tr><tr><td><code>CHECKOUT.PAYMENT-APPROVAL.REVERSED</code></td><td>PayPal reverses a payment capture.</td></tr></tbody></table>

post/v1/notifications/simulate-event

Request body

webhook_idstring

The ID of the webhook. If omitted, the URL is required.

urlstring uri

The URL for the webhook endpoint. If omitted, the webhook ID is required.

event_typestring required

The event name. Specify one of the subscribed events. For each request, provide only one event.

resource_versionstring

The identifier for event type ex: 1.0/2.0 etc.

Response

A successful request returns the HTTP 202 Accepted status code and a JSON response body that shows details for the mock event.

idstring

The ID of the webhook event notification.

create_timestring date-time

The date and time when the webhook event notification was created, in Internet date and time format.

resource_typestring

The name of the resource related to the webhook notification event.

event_versionstring

The event version in the webhook notification.

event_typestring

The event that triggered the webhook event notification.

summarystring

A summary description for the event notification.

resource_versionstring

The resource version in the webhook notification.

resourceResource

The resource that triggered the webhook event notification.