Checkout Webhooks

Set up your webhooks endpoint in checkout configuration screen in the Roqqett portal (info / link). Once configured, the service will send webhook for about the final status of the checkout session

The following events are supported:

Checkout Completed

Is sent when the consumer has successfully completed payment. The request will additionally contain the payment Id.

Example

{
  "eventType": "checkout_completed",
  "checkoutSessionId": "94c92315-53f0-4784-b40d-b7cc3e2f8c73",
  "merchantCheckoutSessionId": "UEhQU0VTU0lEPWU1aGs4YWNrZjJrZ3RpODg2bWNrNTBvYzcy",
  "paymentId": "d3579e67-f9f5-4bd8-9e32-a043c91fea24",
  "dateTime": "2021-08-18 20:08:04"
}

Checkout Cancelled

Is sent when the checkout session has been cancelled, this could either be because the user has cancelled out of the process and returned to your checkout, or if your backend has specifically cancelled the session via a call to /checkout/{checkoutSessionId}/cancel via HTTP POST.

Example

{
  "eventType": "checkout_cancelled",
  "checkoutSessionId": "252e18db-e6d1-493f-9bc5-1952b1530b57",
  "merchantCheckoutSessionId": "441b9bd8-b942-4f96-8693-e4bf6df28368",
  "dateTime": "2021-08-18 20:08:04"
}

Checkout Abandoned

Is sent when the checkout session expires, which is currently 20 minutes after creation. If the user's payment is in a pending state at the expiry time, then the checkout will not be abandoned and when the bank subsequently confirms the payment is completed, a checkout_completed event will be sent. However, if the user's payment is rejected by the bank, then a checkout_abandoned will be sent.

Example

{
  "eventType": "checkout_abandoned",
  "checkoutSessionId": "eee06b8c-7d2f-4238-b519-c4f2666311f8",
  "merchantCheckoutSessionId": "UEhQU0VTU0lEPWU1aDk4N3dzOTg3YThkN2FzNTBvYzcy",
  "dateTime": "2021-08-18 20:08:04"
}

Did this page help you?