Skip to content
EDME-GO
Developers

Cancel policy

Cancels a sandbox policy and returns the resulting lifecycle state.

POST/api/sandbox/policy/{policy_ref}/cancel

Cancels a sandbox policy and returns the resulting lifecycle state.

Request fields for Cancel policy
FieldTypeRequiredNotes
reasonenumYespartner_request, trip_cancelled or duplicate_issue.

Request

POST /api/sandbox/policy/pol_sbx_9f42kq/cancel
Content-Type: application/json

{ "reason": "partner_request" }

Response

{
  "ok": true,
  "mode": "uat_gateway",
  "request_id": "req_9ab30c71",
  "data": {
    "policy_ref": "pol_sbx_9f42kq",
    "status": "cancelled",
    "cancellation": { "reason": "partner_request", "refund_state": "assessed" }
  },
  "meta": { "sandbox": true }
}
  • Cancelling an already-cancelled policy returns not_allowed with HTTP 409.