PApaymongo
Instances

Get workflow instance details

Returns detailed information about a workflow execution instance, including all current step states.

get/v1/workflows/instances/{id}

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows/instances/{id}
  • Auth
    none required

Path parameters

idstring required

Instance ID

Headers

Organization-Idstring required

Organization ID

Response

Instance details

Example response

{
  "data": {
    "created_at": "2026-01-15 10:30:00+00:00",
    "error": "a workflow step failed",
    "error_code": "step_execution_failed",
    "error_detail": "a workflow step failed",
    "instance_id": "inst_abc123",
    "livemode": true,
    "organization_id": "org_abc123",
    "status": "running",
    "steps": [
      {
        "definition_path": "2.steps.0",
        "error": "a workflow step failed",
        "error_code": "step_execution_failed",
        "error_detail": "a workflow step failed",
        "started_at": "2026-01-15 10:30:00+00:00",
        "status": "completed",
        "step_name": "validate_amount",
        "terminated_at": "2026-01-15 10:31:00+00:00"
      }
    ],
    "terminated_at": "2026-01-15 10:31:00+00:00",
    "updated_at": "2026-01-15 10:30:00+00:00",
    "workflow_description": "Handles merchant payout disbursement",
    "workflow_id": "flow_abc123",
    "workflow_name": "Payout Workflow"
  }
}

Changes

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