Requests and Responses

Illustrative HTTP methods, request bodies and sample responses for the proposed API.

Proposed requests

GET is illustrated for reading resource lists; POST is illustrated for creating expenses and reports. These are specifications only, not implemented operations.

Static request body

# Reference only. Placeholder host and credential; do not run against production.
curl -X POST "https://api.remizen.example/v1/expenses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"user_id":"usr_example","amount":125,"currency":"USD","merchant":"Example merchant"}'

Example responses

{
  "id": "exp_example",
  "user_id": "usr_example",
  "amount": 125,
  "currency": "USD",
  "merchant": "Example merchant",
  "status": "draft"
}

Contract boundaries

Field names, validation, response envelopes and status codes may change before release. Do not treat these examples as a deployed schema.