Webhooks

Overview of Roqqett's webhooks that you can utilise

Payment 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:

Cart Completed

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

Example

{
  "eventType": "cart_completed",
  "cartId": "94c92315-53f0-4784-b40d-b7cc3e2f8c73",
  "merchantCartId": "UEhQU0VTU0lEPWU1aGs4YWNrZjJrZ3RpODg2bWNrNTBvYzcy",
  "paymentId": "d3579e67-f9f5-4bd8-9e32-a043c91fea24",
  "orderId":"6bcafe48-c6ff-11ec-9d64-0242ac120002",
  "dateTime": "2021-08-18 20:08:04"
}

Cart Cancelled

Is sent when the cart 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 /cart/{cartId}/cancel via HTTP POST.

Example

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

Cart Abandoned

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

Example

{
  "eventType": "cart_abandoned",
  "cartId": "eee06b8c-7d2f-4238-b519-c4f2666311f8",
  "merchantCartId": "UEhQU0VTU0lEPWU1aDk4N3dzOTg3YThkN2FzNTBvYzcy",
  "dateTime": "2021-08-18 20:08:04"
}

Webhook Authentication

Reconciliation webhooks

TBC

Refund webhooks

TBC


Any questions? Ask us via chat here (bottom right) or on our help center.

Did this page help you?