Reference · Endpoints

Read effective operation readiness

Inspect which operation families the endpoint can perform now and the customer-safe reason code behind each posture.

GET/v1/programmable-endpoints/{endpointRef}/effective-operation-readiness

Authorization: Bearer ak_test_… · Application API key

Try it

This read needs refs from objects you hold; the docs' own refs live in the exhibition, not your bench. Compose it in the playground against your own world.

Key capabilities

ProgrammableEndpointRead

Parameters

endpointRefpath · required

Contract notes

readinessSemanticseffective operation readiness · not final admission

authorityapplication_api_key

publicProjectioncustomer_safe_readiness

resultKindsfound · not_found · not_programmable_endpoint

operationFamiliesreceive_funds · send_funds · internal_transfer_destination · policy_drain

policyDrainVisibilityreadiness_only_no_public_execution

reasonCodesready · endpoint_inactive · runtime_state_missing · operation_not_supported · configuration_missing · configuration_rejected · endpoint_unavailable

disallowedResponseFieldsactorPrincipalRef · policyFingerprint · runtimeStateVersion · runtimePosture · controls · requiredAction · accountsRole · detail

Sharp edges

Readiness explains the current posture; it does not reserve admission for a later command.
Policy drain is visible here for diagnosis, but it is not a public Application API execution surface.
The projection omits internal controls, required actions, policy fingerprints, runtime versions, and raw reason detail.

Wire receipt

Captured from the real gateway by the scenario suite; nothing here is composed by hand.

Inspect the operation families the new endpoint can perform before probing its lifecycle guard.

Request

GET /v1/programmable-endpoints/184dac2f-5c2c-3c3d-bd6f-5f1c83f33348/effective-operation-readiness
Authorization: Bearer ak_test_…

Response · 200

{
  "status": 200,
  "body": {
    "value": {
      "organisationRef": "41a1d9f8-e50b-4e1c-8daa-14afcb683453",
      "appRef": "e591e8dd-a950-40f7-a852-15fb96359274",
      "environmentRef": "96222014-531b-429d-bc91-77298cb2a01e",
      "result": {
        "kind": "found",
        "endpoint": {
          "template": "customer_balance_collection_child",
          "accountRef": "6d47b17f-49f8-3102-9948-a677d4e2fd3d",
          "endpointRef": "184dac2f-5c2c-3c3d-bd6f-5f1c83f33348",
          "holdingRef": "02e9675e-ba02-3b44-a1bc-097f08ad261b",
          "ownerRef": "8ddcfc18-fbf6-4402-82f2-0acf572286b0",
          "ownerKind": "business-entity",
          "unit": {
            "kind": "fiat",
            "currency": "NGN"
          },
          "ledgerPartition": "customer_liability",
          "ledgerNormalSide": "credit_normal",
          "capabilityPosture": {
            "receive": "external_and_internal",
            "send": "outbound_enabled",
            "lifecycle": "permanent",
            "drain": "no_drain",
            "backing": "collection_child",
            "purpose": "customer_balance",
            "gas": "no_gas",
            "liquidity": "no_liquidity"
          },
          "collectionRef": "49c174c8-9691-5e60-9993-0126d7d7c1d3",
          "parentEndpointRef": "b560562a-7416-5a6c-a0ea-1379a3926e99",
          "locators": [
            {
              "locatorRef": "9de6a89f-0486-525a-9902-4652da02b67b",
              "form": "nigerian_bank_account",
              "display": "082:1000000001:Alpine Sandbox Customer"
            }
          ]
        },
        "operationFamilies": [
          {
            "family": "receive_funds",
            "status": "ready",
            "reasonCodes": [
              "ready"
            ]
          },
          {
            "family": "send_funds",
            "status": "ready",
            "reasonCodes": [
              "ready"
            ]
          },
          {
            "family": "internal_transfer_destination",
            "status": "ready",
            "reasonCodes": [
              "ready"
            ]
          },
          {
            "family": "policy_drain",
            "status": "blocked",
            "reasonCodes": [
              "operation_not_supported"
            ]
          }
        ],
        "reasonCodes": []
      }
    },
    "freshness": "Current",
    "visibility": "Full",
    "evidence": [
      {
        "receiptRef": "3aadcee6-568a-3b4b-8fa2-5857ff5fd50f",
        "source": "VaeRuntime"
      },
      {
        "receiptRef": "d9409298-37dd-3235-91f3-8bfe9d98d9fd",
        "source": "SecurityIdentity"
      },
      {
        "receiptRef": "09017e81-7665-3dc7-99fe-ba4a24919466",
        "source": "SecurityIdentity"
      }
    ]
  },
  "evidence": [
    {
      "receiptRef": "3aadcee6-568a-3b4b-8fa2-5857ff5fd50f"
    },
    {
      "receiptRef": "d9409298-37dd-3235-91f3-8bfe9d98d9fd"
    },
    {
      "receiptRef": "09017e81-7665-3dc7-99fe-ba4a24919466"
    }
  ]
}