Skip to main content

Session events

These events are triggered when certain things happen to order sessions. A notification in itself will never contain any sensitive data, just the name of the notification and the id of the the order session. Ledyer expects every merchant to have an open endpoint to which it can post notifications. Once a notification has been received, Ledyer expects the merchant to make an authorized request to get order session API to get the latest information about the order session.

tip

If you only need to update the order session status in your ERP system, consider using the payment status API instead of the get order session API.

Events

Ledyer will post notifications for the following events.

Awaiting Signatory

com.ledyer.checkout.session.awaiting_signatory

The session has been delegated to a signatory and is awaiting their approval.


Notification dashboard

The notification dashboard can be used to add endpoints, configure which events you want to subscribe to, debug delivery, as well as inspect and replay past notifications.

The dashboard can be accessed through the Settings page -> Notifications in Ledyer Merchant

Notification payload

A notification will always hold the same payload.

{
"eventType": "com.ledyer.checkout.session.{EVENT_NAME}",
"merchantId": "ac_1xWqkk1aaIbxCJsoseRhSd0OJyD",
"sessionId": "se_29kCutBzwAXQ9JRW1tMhcUeImyg",
"storeId": "9702420072"
}

Retry schedule

Ledyer Checkout will notify the provided notification endpoint multiple times in case of a non 200 OK response. Each notification message is attempted based on this schedule (delay for each step):

Immediately, 5 seconds, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours, 10 hours

It is also possible to manually retry each message at any time from the notification dashboard.