Skip to main content

Order Events

Notification payload​

An order management notification will always hold the same payload.

{
  "eventType": "com.ledyer.order.{EVENT_NAME}",
  "merchantId": "ac_1xWqkk1aaIbxCJsoseRhSd0OJyD",
  "orderId": "or_29kCutBzwAXQ9JRW1tMhcUeImyg",
  "reference": "or_29kNetBzwAXQ9XYW1tMhcUeImyg",
  "storeId": "9702420072"
}

Events​

Ledyer will post notifications for the following events.

info

For security reasons, a notification will not contain any details about the order itself. To handle eventually out of order notifications you should react to a notification by fetching the current payment status using the get payment status API.

Cancel​

com.ledyer.order.cancel

The order has been cancelled.

Create​

com.ledyer.order.create

An order has been created by the end customer. The order is authorized by Ledyer. Once this is received an order should already exists in merchant's system. If not a fallback must exist to create one.

Full capture​

com.ledyer.order.full_capture

The order has been fully captured.

Full refund​

com.ledyer.order.full_refund

The order has been fully refunded.

Partial capture​

com.ledyer.order.part_capture

The order has been partially captured.

Partial refund​

com.ledyer.order.part_refund

The order has been partially refunded.

Ready for capture​

com.ledyer.order.ready_for_capture

The order has been processed by Ledyer and can be captured. Could be used to update the status of the order in the ERP-system.

Retry schedule​

Ledyer Payments 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.