Skip to main content

Get Instance

This endpoint gets the instance detail in the database, and some instance execution data is included in the response plus the instance detail saved in the instance request.

InformationDataDescription
URL-Provided by boltPay squad
Endpoint/execution-instance/{instanceSid}instanceSid: Generated sid sent in the create instance response.
MethodGET-

Request example

GET {url}/execution-instance/9ae5f1ff-8739-4fc6-a8d2-7643270b4a23

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

Response

{
"nextEvent": {
"date": "2024-06-29T12:00:00.000Z",
"sid": "143894d1-412b-4ee7-84ef-5768ae1eb60a"
},
"attributes": {
"recurringId": "REC1234",
"quoteId": "QUOTE1234",
"orderId": "ORDER1234",
"leadId": "LEAD1234",
"productId": "PRD1234",
"policyNumber": "PLICY1234"
},
"executionDay": 29,
"executionDate": "2024-06-29T12:00:00.000Z",
"startDate": "2024-06-29T12:00:00.000Z",
"cycle": 1,
"status": "ACTIVE",
"strategyId": "00000000-ffff-a1b2-c3d4-123qwe456rty",
"description": "Description example",
"sid": "9ae5f1ff-8739-4fc6-a8d2-7643270b4a23",
"updatedAt": "2024-05-29T14:27:23.899Z",
"createdAt": "2024-05-29T14:27:23.513Z"
}