Skip to main content

Resume Event

This endpoint is used to resume a paused event. Events that have configured asynchronous requests (request service configuration detailed in the Strategy) are paused after the request execution and wait for the resume API call.

Sending data on body response, this data will override the previous response data to be used in the event stack results. The previous data will continue in the stack but not as the response result, but as a cached attribute.

Resume events will be scheduled to be executed immediately.

InformationDataDescription
URL-Provided by boltPay squad
Endpoint/execution-event/{correlationId}/resumecorrelationId: Generated sid for the paused step. This could be found in the result of the Get Event request.
MethodPOST-
Body (Not required)application/jsonData that overrides the previous request response in the step stack results.

Request

POST {url}/execution-event/fcf58fe6-cbd7-4532-a30e-ca731311ef4e/resume

Headers: { Content-Type: application/json, Strategy-Secret: asdxcv123asdzxcv, Authorization: Bearer asd123asdfd123.asdasd123.asda13213 }

{
"fromCallback": true,
"name": "John McCain",
"recurringId": "rec_id_123456",
"paymentId": "pay_id_123456",
"quoteId": "quote_id_123456",
"orderId": "ord_id_123456",
"price": 150,
"amount": 150,
"leadId": "lead_id_1234",
"tax1": 1.45,
"formattedAmount": "150,00",
"totalAmount": 150.00,
"destination": "09123456789",
"planId": "plan_001",
"productId": "dpcs_001",
"partnerCode": "paymaya",
"referenceNumber": "ref_num_123456",
"policyNumber": "PHP02743856394",
"policyNumbers": "PHP02743856394,PHP02743856395"
}

Response

{
"sid": "d2ec0cc5-57eb-4791-a8f0-a9901a9f6967",
"instanceSid": "81521abf-8ace-4ba0-8a21-574484597b08",
"strategySid": "1ebbbead-49dc-4291-9f9c-41955f5a5520",
"status": "QUEUED",
"main": true,
"afterCancellation": false,
"task": "execute-installment",
"date": "2022-06-04T04:00:00.000Z",
"scheduledAt": "2021-08-30T16:32:17.335Z",
"scheduleDelta": -23974062665,
"attempt": 1,
"correlationId": "fcf58fe6-cbd7-4532-a30e-ca731311ef4e",
"createdAt": "2021-08-30T16:13:38.289Z",
"updatedAt": "2021-08-30T16:29:13.772Z"
}