Skip to content

Latest commit

 

History

History
149 lines (112 loc) · 2.86 KB

api_docs.md

File metadata and controls

149 lines (112 loc) · 2.86 KB

注意

Get リクエスト以外は X-API-TOKEN が必要です。

GET /payment

これまでの支払い履歴を閲覧できます

クエリパラメータ

パラメータ名 型 必須 説明
limit integer 任意 取得する支払い履歴の一覧。デフォルトは 10。
offset integer 任意 オフセット。

レスポンス

[
  {
    "ID": 1,
    "Money": 110,
    "Payment": "PayPay",
    "CreatedAt": "2025-07-22T02:59:28.53506Z",
    "UpdatedAt": "2025-07-22T02:59:28.53506Z"
  },
  {
    "ID": 2,
    "Money": 220,
    "Payment": "PayPay",
    "CreatedAt": "2025-07-22T05:41:13.160653Z",
    "UpdatedAt": "2025-07-22T05:41:13.160653Z"
  }
]

GET /payment/:id

特定の支払い履歴を閲覧できます

レスポンス

{
  "ID": 1,
  "Money": 110,
  "Payment": "PayPay",
  "CreatedAt": "2025-07-22T02:59:28.53506Z",
  "UpdatedAt": "2025-07-22T02:59:28.53506Z"
}

POST /payment

支払い履歴を追加します

クエリパラメータ

パラメータ名 型 必須 説明
Money string 必須 支払額
Payment string 必須 支払い方法

レスポンス

{
  "ID": 2,
  "Money": 220,
  "Payment": "PayPay",
  "CreatedAt": "2025-07-22T05:41:13.160653Z",
  "UpdatedAt": "2025-07-22T05:41:13.160653Z"
}

PUT /payment/:id

支払い履歴を編集します

クエリパラメータ

パラメータ名 型 必須 説明
Money string 任意 支払額
Payment string 任意 支払い方法

レスポンス

{
  "ID": 1,
  "Money": 220,
  "Payment": "PayPay",
  "CreatedAt": "2025-07-22T02:59:28.53506Z",
  "UpdatedAt": "2025-07-22T05:46:21.484355757Z"
}

DELETE /payment/:id

支払い履歴を削除します

レスポンス

{
  "ID": 1,
  "Money": 220,
  "Payment": "PayPay",
  "CreatedAt": "2025-07-22T02:59:28.53506Z",
  "UpdatedAt": "2025-07-22T05:46:21.484355Z"
}

GET /balance

現在の残高状況を表示します

レスポンス

{
  "balance": 0,
  "total_money": 0,
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "2025-08-27T14:59:19.353133Z"
}

PUT /balance

現在の残高状況を更新します

クエリパラメータ

パラメータ名 型 必須 説明
Balance string 任意 残高

レスポンス

{
  "balance": 0,
  "total_money": 0,
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "2025-08-27T14:59:19.353133Z"
}