Checkout Notifications

The Create a Checkout Notification endpoint allows you to manually trigger a notification event for an existing checkout session. This is useful for resending payment confirmations, triggering downstream webhook consumers, or testing notification flows in your integration.

Notifications are sent for the checkout session identified by checkoutId. The session must exist and be retrievable via GET /v2/checkout/{checkoutId}.

How It Works

1

Identify the checkout session

Note the checkoutId of the session you want to trigger a notification for. See Checkout Sessions for how to retrieve session IDs.

2

Create the notification

Call POST /v2/checkout/{checkoutId}/notification. The request body specifies the notification type and any additional parameters required by your notification configuration.

3

Confirm delivery

A successful 2xx response confirms the notification was accepted for delivery. Check your notification endpoint or webhook consumer for receipt.

API Reference

Create a Checkout Notification

Create a Checkout Notification

post
/v2/checkout/{checkoutId}/notification
Authorizations
AuthorizationstringRequired

HTTP Basic authentication using entity credentials (username:password encoded in Base64).

Path parameters
checkoutIdstringRequired

Checkout ID

Body
Responses
post
/v2/checkout/{checkoutId}/notification
default

Successful

Last updated

Was this helpful?