Skip to main content
WEBHOOK

Event Types

  • CHECKOUT_SESSION.CREATED - A new hosted checkout session has been created

Sample Payload

Checkout Session Created

This event is sent once, when you create the session, and it is the only checkout session event. sessionId is the checkoutId returned when you created the checkout. expiresAt is when the checkout stops accepting payment, 24 hours after you create it by default. Track the payment with Transaction Events, and find the session’s deposit with List Transactions and ?reference= set to the merchantReference.

Body

application/json
id
string<uuid>
required

Unique ID of this event. Every delivery attempt of the same event carries the same id, so use it to ignore a delivery you have already processed.

Example:

"8f14e45f-ceea-4e7a-9f1d-6b1c2a3d4e5f"

event
enum<string>
required

Identifies which checkout session event occurred

Available options:
CHECKOUT_SESSION.CREATED
Example:

"CHECKOUT_SESSION.CREATED"

createdAt
string<date-time>
required

When Afriex created the event. Retries keep this value, and the signature covers it, so you can reject a delivery that is older than you expect.

Example:

"2026-04-24T09:13:33.883Z"

data
object
required

Details of the checkout session

Response

Acknowledge receipt. Return any 2xx status code quickly. Response body is ignored.