Reference · Endpoints
Read a programmable endpoint
Read one endpoint's posture: what it will accept, what it will refuse, and why.
GET/v1/programmable-endpoints/{endpointRef}
Authorization: Bearer ak_test_… · Application API key
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
Wire receipt
Captured from the real gateway by the scenario suite; nothing here is composed by hand.
Read the endpoint you created; the projection carries its posture across every dimension.
Request
GET /v1/programmable-endpoints/14fd5416-ef87-3487-9132-2c49f5884884 Authorization: Bearer ak_test_…
Response · 200
{
"status": 200,
"body": {
"value": {
"organisationRef": "00000000-0000-0000-0000-000000000001",
"appRef": "00000000-0000-0000-0000-000000000002",
"environmentRef": "00000000-0000-0000-0000-000000000003",
"result": {
"kind": "found",
"endpoint": {
"template": "customer_balance_internal",
"accountRef": "f420a7a0-db4c-39e4-b9de-a76aa76a1ea7",
"endpointRef": "14fd5416-ef87-3487-9132-2c49f5884884",
"holdingRef": "018f605c-ef4d-31a0-87be-60ac7467610c",
"ownerRef": "00000000-0000-0000-0000-000000008401",
"ownerKind": "business-entity",
"unit": {
"kind": "fiat",
"currency": "NGN"
},
"ledgerPartition": "customer_liability",
"ledgerNormalSide": "credit_normal",
"capabilityPosture": {
"receive": "internal_only",
"send": "disabled",
"lifecycle": "permanent",
"drain": "no_drain",
"backing": "internal_ledger",
"purpose": "customer_balance",
"gas": "no_gas",
"liquidity": "no_liquidity"
},
"locators": [],
"lifecycleGuard": {
"stateVersion": 1,
"fingerprint": "fp:endpoint-lifecycle-guard:4cc4fd68dc3d0866037984c9508c4f6383376db99b8d6bafed5852167b9f891e"
}
},
"replacementLineage": {
"predecessorEndpointRef": null,
"successorEndpointRef": null
},
"thresholdSettlementLifecycle": null,
"transientDrainLifecycle": null,
"endpointRef": null
}
},
"freshness": "Current",
"visibility": "Full",
"evidence": [
{
"receiptRef": "52331759-c721-3496-ad47-99bbe5e7855b",
"source": "VaeRuntime"
},
{
"receiptRef": "00000000-0000-0000-0000-0000000000c9",
"source": "SecurityIdentity"
},
{
"receiptRef": "00000000-0000-0000-0000-0000000000cb",
"source": "SecurityIdentity"
}
]
},
"evidence": [
{
"receiptRef": "52331759-c721-3496-ad47-99bbe5e7855b"
},
{
"receiptRef": "00000000-0000-0000-0000-0000000000c9"
},
{
"receiptRef": "00000000-0000-0000-0000-0000000000cb"
}
]
}captured 2026-07-13 · gateway 0.1.0 · First credit · Read the endpoint
See also
generated from openapi.json · gateway 0.1.0 · sandbox