Approval Status — Proposed Guide
Planned API — Reference OnlyApproval Status: Status would summarize where a review currently stands while preserving the underlying decisions. Pending, approved and rejected refer to…
Overview
Status would summarize where a review currently stands while preserving the underlying decisions. Pending, approved and rejected refer to the review, not payment settlement.
Key concepts
Distinguish assigned, awaiting additional review and terminal outcomes. Expose the current review version.
Implementation considerations
A client should not treat an unknown status as successful. Historical decisions may remain valid even when the current request is revised.
Proposed API behavior
GET /v1/approvals/{approval_id} is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.
| Name | Type | Description |
|---|---|---|
| approval_idrequired | string | Stable fictional approval reference; not a secret and not evidence that a resource exists. |
No additional request fields are illustrated; this is not a finalized contract.
Static example requests
# Proposed request text only; this reserved host is not a live API.
curl -X GET 'https://api.remizen.example/v1/approvals/apr_example_123' \
-H 'Authorization: Bearer YOUR_API_KEY'Fictional response example
Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.
{
"data": {
"approval_id": "apr_example_123",
"version": 1,
"id": "approvals_example_123",
"organization_id": "org_example_123"
},
"meta": {
"request_id": "req_example_123",
"reference_only": true
}
}Illustrative error case
Review this failure case in context: A client should not treat an unknown status as successful. Historical decisions may remain valid even when the current request is revised.
Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.
{
"error": {
"code": "validation_error",
"message": "The proposed approval status operation requires review of its input or authorization.",
"request_id": "req_example_123"
}
}Proposed data types
| Name | Type | Description |
|---|---|---|
| approval_id | string | Stable fictional approval reference; not a secret and not evidence that a resource exists. |
| status | string | Proposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success. |
| version | integer | Illustrative resource revision for detecting stale updates; no live concurrency contract is published. |