Skip to content

Approval Status — Proposed Guide

Planned API — Reference Only

Approval 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.

Proposed path parameters
NameTypeDescription
approval_idrequiredstringStable 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, non-executing request examples
# 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

200 (proposed example)Static response fixture

Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.

JSON
{
  "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.

422 (illustrative; final error contracts are undecided)Proposed error fixture

Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.

JSON
{
  "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

Illustrative field dictionary
NameTypeDescription
approval_idstringStable fictional approval reference; not a secret and not evidence that a resource exists.
statusstringProposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.
versionintegerIllustrative resource revision for detecting stale updates; no live concurrency contract is published.