Reference · Transfers
Read transfer status
Follow one transfer along the stage ladder, from accepted to a terminal stage.
GET/v1/transfers/{transferRef}/status
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
- TransferStatusRead
Parameters
Sharp edges
- The API has no event feed yet; progression is observed by reading. The Boundaries room states this plainly.
Wire receipt
Captured from the real gateway by the scenario suite; nothing here is composed by hand.
The payout rests at awaiting_finality until the rail confirms; the record states the wait plainly.
Request
GET /v1/transfers/0711bf24-340d-3933-90ef-528668e2bf5f/status Authorization: Bearer ak_test_…
Response · 200
{
"status": 200,
"body": {
"value": {
"transferRef": "0711bf24-340d-3933-90ef-528668e2bf5f",
"status": "awaiting_finality",
"isTerminal": false,
"isSuccessful": false,
"reason": "finality_missing",
"revision": 0,
"fees": {
"status": "not_required",
"reason": "no_configured_fee",
"totals": [],
"lines": []
}
},
"freshness": "Current",
"visibility": "Full",
"evidence": []
},
"evidence": []
}captured 2026-07-11 · gateway 0.1.0 · Money moves · Read the ladder
Refused requests
Refusals are stated as plainly as capabilities; these were captured live, the same way.
The record states the refusal as plainly as any success: the reservation was denied, and nothing moved.
Request
GET /v1/transfers/a2acbd92-21e4-3342-9006-3ff695be5458/status Authorization: Bearer ak_test_…
Response · 200
{
"status": 200,
"body": {
"value": {
"transferRef": "a2acbd92-21e4-3342-9006-3ff695be5458",
"status": "reservation_denied",
"isTerminal": true,
"isSuccessful": false,
"reason": "reservation_denied",
"revision": 1,
"fees": {
"status": "not_required",
"reason": "no_configured_fee",
"totals": [],
"lines": []
}
},
"freshness": "Current",
"visibility": "Full",
"evidence": []
},
"evidence": []
}captured 2026-07-11 · gateway 0.1.0 · The gate holds · Read the denial
See also
generated from openapi.json · gateway 0.1.0 · sandbox
