Instances

Get wait states for an instance

Returns the wait_event steps currently pending on a workflow instance.

get/v1/workflows/instances/{id}/wait_states

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows/instances/{id}/wait_states
  • Auth
    HTTP basic

Path parameters

idstring required

Instance ID

Headers

Organization-Idstring required

Organization ID

Response

Wait states

Example response

{
  "data": [
    {
      "definition_path": "0.then.1",
      "description": "Waiting for payment confirmation",
      "event_name": "payment.paid",
      "instance_id": "inst_abc123",
      "status": "waiting",
      "step_index": 2,
      "timeout_at": "2026-01-15 11:30:00+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.