Retrieve Reimbursement — Proposed Guide

Planned API — Reference Only

Retrieve Reimbursement: A retrieve operation would provide one reimbursement representation and its authorized references. The amount, currency and source…

Overview

A retrieve operation would provide one reimbursement representation and its authorized references. The amount, currency and source decisions should remain explainable.

Key concepts

Distinguish a reimbursement id from provider transaction identifiers and individual attempts. Each identifies a different record.

Implementation considerations

Do not infer settled funds from a successful retrieval response. Read the defined state and settlement evidence separately.

Proposed API behavior

GET /v1/reimbursements/{reimbursement_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
Name	Type	Description
reimbursement_idrequired	string	Stable fictional reimbursement 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/reimbursements/reimb_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": {
    "reimbursement_id": "reimb_example_123",
    "expense_id": "exp_example_123",
    "version": 1,
    "id": "reimb_example_123",
    "organization_id": "org_example_123",
    "expense_ids": [
      "exp_example_123"
    ],
    "amount_minor": 12550,
    "currency": "USD",
    "status": "draft"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Do not infer settled funds from a successful retrieval response. Read the defined state and settlement evidence separately.

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 retrieve reimbursement operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
Name	Type	Description
reimbursement_id	string	Stable fictional reimbursement 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.
expense_id	string	Stable fictional expense reference; not a secret and not evidence that a resource exists.
version	integer	Illustrative resource revision for detecting stale updates; no live concurrency contract is published.

List Reimbursements

Reimbursements & Payments

Create Reimbursement