pokepay_partner_ruby_sdk 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef55822676f9f2e427fd76e1434e510c90491a72d57ce38d0be9c6f9f271936b
-  data.tar.gz: a48fb9effd3ae012dc51d9efc19021088d8d01e6c3eab08745beb5b6e6fbef6d
+  metadata.gz: b31b44c25482290e71f6ddb114c700f2502dd19bae3a6f4c7a0dbf125f034af7
+  data.tar.gz: d37c5c6a38ef8e22ff542ef38402924ef1614c8231ff4b1b5410a55e727a600e
 SHA512:
-  metadata.gz: dce0a61b071729c5b85af8035d7e1cc767d5eb99b55da16a0126c344aba7b8fee5a17a70994d8284bc3fe02910cceda320ff646dcba3aea2230c908a57906cdb
-  data.tar.gz: 2f4f017ff5a6fa72c2dcce10155ec211f9db9f4ca00f8f8f28914502fb85a4721564c014c27efee938889aeeffc3de999e6e4f4bf0bd6e72cd854a05f7c07919
+  metadata.gz: 135694919952fad3d174fd466f20350d8411c615b691368b30e01820bc25be8054597f247ba12b5fa08a6c6a003102e75ba03fb95c06b6843ec88e8465701be8
+  data.tar.gz: a4492393069d894ac2a35d9a77056376c401db1dc206e29bff3322b04b0706d0e5912b1864514b1247b89ede94c543a4cd32dcce600170ccee7a17437f0ea077

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pokepay_partner_ruby_sdk (0.1.4)
+    pokepay_partner_ruby_sdk (0.1.9)
       inifile (~> 3.0.0)
       json (~> 2.3.0)
       openssl (~> 2.1.2)
@@ -11,7 +11,7 @@ GEM
   specs:
     inifile (3.0.0)
     ipaddr (1.2.2)
-    json (2.3.0)
+    json (2.3.1)
     minitest (5.14.0)
     openssl (2.1.2)
       ipaddr

data/docs/index.md

@@ -1,5 +1,4 @@
 # Partner API SDK for Ruby
-
 ## Installation
 
 rubygemsからインストールすることができます。
@@ -140,287 +139,1528 @@ response.code
 response.body
 # => {"type"=>"invalid_parameters", "message"=>"Invalid parameters", "errors"=>{"invalid"=>["message"]}}
 ```
-
 <a name="api-operations"></a>
 ## API Operations
 
+- [ListTransactions](#list-transactions): 取引履歴を取得する
+- [CreateTransaction](#create-transaction): チャージする(廃止予定)
+- [CreateTopupTransaction](#create-topup-transaction): チャージする
+- [CreatePaymentTransaction](#create-payment-transaction): 支払いする
+- [CreateTransferTransaction](#create-transfer-transaction): 個人間送金
+- [CreateExchangeTransaction](#create-exchange-transaction): 
+- [GetTransaction](#get-transaction): 取引情報を取得する
+- [ListTransfers](#list-transfers): 
+- [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
+- [ListBills](#list-bills): 支払いQRコード一覧を表示する
+- [CreateBill](#create-bill): 支払いQRコードの発行
+- [UpdateBill](#update-bill): 支払いQRコードの更新
+- [CreateCashtray](#create-cashtray): Cashtrayを作る
+- [GetCashtray](#get-cashtray): Cashtrayの情報を取得する
+- [CancelCashtray](#cancel-cashtray): Cashtrayを無効化する
+- [UpdateCashtray](#update-cashtray): Cashtrayの情報を更新する
+- [GetAccount](#get-account): ウォレット情報を表示する
+- [UpdateAccount](#update-account): ウォレット情報を更新する
+- [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
+- [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
+- [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーウォレットを追加する
+- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
+- [ListShops](#list-shops): 店舗一覧を取得する
+- [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
+- [CreateShopV2](#create-shop-v): 新規店舗を追加する
+- [GetShop](#get-shop): 店舗情報を表示する
+- [UpdateShop](#update-shop): 店舗情報を更新する
+- [ListUserAccounts](#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
+- [GetPrivateMoneys](#get-private-moneys): マネー一覧を取得する
+- [GetPrivateMoneyOrganizationSummaries](#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
+- [BulkCreateTransaction](#bulk-create-transaction): CSVファイル一括取引
 ### Transaction
+<a name="list-transactions"></a>
+#### 取引履歴を取得する
+取引一覧を返します。
+```ruby
+response = $client.send(Pokepay::Request::ListTransactions.new(
+                          from: "2018-02-24T20:24:55.000000+09:00",             # 開始日時
+                          to: "2020-10-22T04:47:28.000000+09:00",               # 終了日時
+                          page: 1,                                              # ページ番号
+                          per_page: 50,                                         # 1ページ分の取引数
+                          shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",      # 店舗ID
+                          customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  # エンドユーザーID
+                          customer_name: "太郎",                                  # エンドユーザー名
+                          terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  # 端末ID
+                          transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
+                          organization_code: "pocketchange",                    # 組織コード
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
+                          is_modified: true,                                    # キャンセルフラグ
+                          types: ["topup", "payment"]                           # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
+))
+```
 
-<a name="get-transaction"></a>
-#### 取引情報を取得する
+---
+`from`  
+抽出期間の開始日時です。
+
+フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+
+---
+`to`  
+抽出期間の終了日時です。
+
+フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+`shop_id`  
+店舗IDです。
+
+フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
+
+---
+`customer_id`  
+エンドユーザーIDです。
+
+フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
+
+---
+`customer_name`  
+エンドユーザー名です。
+
+フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
+
+---
+`terminal_id`  
+端末IDです。
+
+フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
+
+---
+`transaction_id`  
+取引IDです。
+
+フィルターとして使われ、指定された取引のみ一覧に表示されます。
+
+---
+`organization_code`  
+組織コードです。
+
+フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
+
+---
+`private_money_id`  
+マネーIDです。
+
+フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
+
+---
+`is_modified`  
+キャンセルフラグです。
 
+これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
+
+---
+`types`  
+取引の種類でフィルターします。
+
+以下の種類を指定できます。
+
+1. topup
+   店舗からエンドユーザーへの送金取引(チャージ)
+
+2. payment
+   エンドユーザーから店舗への送金取引(支払い)
+
+3. exchange-outflow
+　　他マネーへの流出
+
+4. exchange-inflow
+   他マネーからの流入
+
+---
+成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
+<a name="create-transaction"></a>
+#### チャージする(廃止予定)
+チャージ取引を作成します。このAPIは廃止予定です。以降は `CreateTopupTransaction` を使用してください。
 ```ruby
-response = client.send(Pokepay::Request::GetTransaction.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # 取引ID
-                         ))
+response = $client.send(Pokepay::Request::CreateTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          money_amount: 313,
+                          point_amount: 3912,
+                          point_expires_at: "2023-04-30T21:00:37.000000+09:00", # ポイント有効期限
+                          description: "S"
+))
+```
+
+---
+`point_expires_at`  
+ポイントをチャージした場合の、付与されるポイントの有効期限です。
+省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
 
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+<a name="create-topup-transaction"></a>
+#### チャージする
+チャージ取引を作成します。
+```ruby
+response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # shop_id: 店舗ID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # customer_id: エンドユーザーのID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
+                          money_amount: 5960,                                   # マネー額
+                          point_amount: 6566,                                   # ポイント額
+                          point_expires_at: "2020-06-09T20:49:01.000000+09:00", # ポイント有効期限
+                          description: "初夏のチャージキャンペーン"                          # 取引履歴に表示する説明文
+))
 ```
 
-成功したときは以下のプロパティを含む `Pokepay::Response::Transaction` オブジェクトをレスポンスとして返します。
+---
+`shop_id`  
+店舗IDです。
 
-- id (String): 取引ID
-- type (String): 取引種別 (チャージ=topup, 支払い=payment)
-- is_modified (真理値): 返金された取引かどうか
-- sender (Pokepay::Response::User): 送金者情報
-- receiver (Pokepay::Response::User): 受取者情報
-- sender_account (Pokepay::Response::Account): 送金口座情報
-- receiver_account (Pokepay::Response::Account): 受取口座情報
-- amount (Numeric): 決済総額 (マネー額 + ポイント額)
-- money_amount (Numeric): 決済マネー額
-- point_amount (Numeric): 決済ポイント額
-- done_at (Time): 取引日時
-- description (String): 取引説明文
+送金元の店舗を指定します。
 
-`sender` と `receiver` は `Pokepay::Response::User` のオブジェクトです。 以下にプロパティを示します。
+---
+`customer_id`  
+エンドユーザーIDです。
 
-- id (String): ユーザー (または店舗) ID
-- name (String): ユーザー (または店舗) 名
-- is_merchant (真理値): 店舗ユーザーかどうか
+送金先のエンドユーザーを指定します。
 
-`senderAccount` と `receiverAccount` は `Pokepay::Response::Account` のオブジェクトです。以下にプロパティを示します。
+---
+`private_money_id`  
+マネーIDです。
 
-- id (String): 口座ID
-- name (String): 口座名
-- is_suspended (真理値): 口座が凍結されているかどうか
-- private_money (Pokepay::Response::PrivateMoney): 設定マネー情報
+マネーを指定します。
 
-`privateMoney` は `Pokepay::Response::PrivateMoney` のオブジェクトです。以下にプロパティを示します。
+---
+`bear_point_shop_id`  
+ポイント支払時の負担店舗IDです。
 
-- id (String): マネーID
-- name (String): マネー名
-- unit (String): マネー単位 (例: 円)
-- is_exclusive (真理値): 会員制のマネーかどうか
-- description (String): マネー説明文
-- max_balance (Numeric): 口座の上限金額
-- transfer_limit (Numeric): マネーの取引上限額
-- type (String): マネー種別 (自家型=own, 第三者型=third-party)
-- expiration_type (String): 有効期限種別 (チャージ日時起算=static, 最終利用日時起算=last-update)
+ポイント支払い時に実際お金を負担する店舗を指定します。
 
-#### チャージする
+---
+`money_amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`point_amount`  
+ポイント額です。
+
+送金するポイント額を指定します。
+
+---
+`point_expires_at`  
+ポイントをチャージした場合の、付与されるポイントの有効期限です。
+省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+<a name="create-payment-transaction"></a>
+#### 支払いする
+支払取引を作成します。
+支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
 
 ```ruby
-response = client.send(Pokepay::Request::CreateTopupTransaction.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",   # 店舗ID
-                         "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",   # エンドユーザーのID
-                         "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",   # 送るマネーのID
-                         {
-                           "money_amount" => 100,                  # チャージマネー額
-                           "point_amount" => 200,                  # チャージするポイント額 (任意)
-                           "description" => "チャージテスト"          # 取引履歴に表示する説明文 (任意)
-                         }))
+response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # shop_id: 店舗ID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # customer_id: エンドユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          5274,                                                 # amount: 支払い額
+                          description: "たい焼き(小倉)"                               # 取引履歴に表示する説明文
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` を持つレスポンスオブジェクトを返します。  
-プロパティは [取引情報を取得する](#get-transaction) を参照してください。
+---
+`shop_id`  
+店舗IDです。
 
-#### 支払いする
+送金先の店舗を指定します。
+
+---
+`customer_id`  
+エンドユーザーIDです。
+
+送金元のエンドユーザーを指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
+
+---
+`amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+<a name="create-transfer-transaction"></a>
+#### 個人間送金
+エンドユーザー間での送金取引(個人間送金)を作成します。
+個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
 
 ```ruby
-response = client.send(Pokepay::Request::CreatePaymentTransaction.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
-                         "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy", # エンドユーザーのID
-                         "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz", # 支払うマネーのID
-                         100,                                    # 支払い額
-                         {
-                           "description"  => "たい焼き(小倉)"      # 取引履歴に表示する説明文 (任意)
-                         }))
+response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # sender_id: 送金元ユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # receiver_id: 受取ユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          9429,                                                 # amount: 送金額
+                          description: "たい焼き(小倉)"                               # 取引履歴に表示する説明文
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` オブジェクトをレスポンスとして返します。  
-プロパティは [取引情報を取得する](#get-transaction) を参照してください。
+---
+`sender_id`  
+エンドユーザーIDです。
+
+送金元のエンドユーザー(送り主)を指定します。
+
+---
+`receiver_id`  
+エンドユーザーIDです。
+
+送金先のエンドユーザー(受け取り人)を指定します。
+
+---
+`private_money_id`  
+マネーIDです。
 
-#### チャージ用QRコードを読み取ることでチャージする
+マネーを指定します。
 
-チャージ用QRコードを解析すると次のようなURLになります(URLは環境によって異なります)。
+---
+`amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+<a name="create-exchange-transaction"></a>
+#### 
+```ruby
+response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          3501,
+                          description: "ruJxi1ST1WXtfeKSzrq1Zc5Ju53UYOCwl5C8rEq5yNfh8NoRe5rX0rVCmpqdlLHNNlbdnW1ooZFRDSiyltrhPzNi7jenj4X3xdXKxR7POl5XLEB6rdcoyFq3Dy2RXyPUA"
+))
+```
+成功したときは[Transaction](#transaction)オブジェクトを返します
+<a name="get-transaction"></a>
+#### 取引情報を取得する
+取引を取得します。
+```ruby
+response = $client.send(Pokepay::Request::GetTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # transaction_id: 取引ID
+))
+```
+
+---
+`transaction_id`  
+取引IDです。
+
+フィルターとして使われ、指定した取引IDの取引を取得します。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+<a name="list-transfers"></a>
+#### 
+```ruby
+response = $client.send(Pokepay::Request::ListTransfers.new(
+                          from: "2017-11-27T11:10:27.000000+09:00",
+                          to: "2022-07-13T10:00:27.000000+09:00",
+                          page: 9517,
+                          per_page: 651,
+                          shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          shop_name: "gOIxNaz33MDlMm45c417ClVPZadCz21oTLg0Zh082rSUmgTJgltXUvopMAE6nKVgCC79b4Ei190OQ71CLczodkHUHlo8UiDVjyL8K2mxNxSNDBAB21jRDnDfUt4YgIyZaTsiHOmcCShoExxXDzwmu0NmtxroKVUk7sDu4lw8ZxL5",
+                          customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          customer_name: "oBCUmbexHlOYPdRDRXfcFEKebPAHiatKRmL7K8IMJIBW1vB1RC8WQ75Zq2CPEph5LyiHrKKZHYeA6KMsRSBkbfNhFwjSSUkqouGV2ULftf3KLiOm",
+                          transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+                          is_modified: true,
+                          transaction_types: ["topup", "transfer", "exchange"],
+                          transfer_types: ["exchange", "payment"]
+))
+```
+成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
+### Check
+店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
+
+チャージQRコードを解析すると次のようなURLになります(URLは環境によって異なります)。
 
 `https://www-sandbox.pokepay.jp/checks/xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx`
 
-この `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージ用QRコードのIDです。
-これを以下のようにエンドユーザIDと共に渡すことでチャージ取引が作られます。
+QRコードを読み取る方法以外にも、このURLリンクを直接スマートフォン(iOS/Android)上で開くことによりアプリが起動して取引が行われます。(注意: 上記URLはsandbox環境であるため、アプリもsandbox環境のものである必要があります) 上記URL中の `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージQRコードのIDです。
+
+<a name="create-topup-transaction-with-check"></a>
+#### チャージQRコードを読み取ることでチャージする
+通常チャージQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
+
+エンドユーザーから受け取ったチャージ用QRコードのIDをエンドユーザーIDと共に渡すことでチャージ取引が作られます。
 
 ```ruby
-response = client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
-                         "xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx", # チャージ用QRコードのID
-                         "yyyyyyyy-yyyy-yyyyyyyyy-yyyyyyyyyyyy"  # エンドユーザーのID
-                         ))
+response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # check_id: チャージ用QRコードのID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # customer_id: エンドユーザーのID
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` オブジェクトをレスポンスとして返します。  
-プロパティは [取引情報を取得する](#get-transaction) を参照してください。
+---
+`check_id`  
+チャージ用QRコードのIDです。
 
-#### 取引履歴を取得する
+QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
+
+---
+`customer_id`  
+エンドユーザーIDです。
 
+送金先のエンドユーザーを指定します。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+### Bill
+支払いQRコード
+<a name="list-bills"></a>
+#### 支払いQRコード一覧を表示する
+支払いQRコード一覧を表示します。
 ```ruby
-response = client.send(Pokepay::Request::ListTransactions.new(
-                         {
-                           # ページング
-                           "page"     => 1,
-                           "per_page" => 50,
+response = $client.send(Pokepay::Request::ListBills.new(
+                          page: 532,                                            # ページ番号
+                          per_page: 218,                                        # 1ページの表示数
+                          bill_id: "WM",                                        # 支払いQRコードのID
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
+                          organization_code: "--9",                             # 組織コード
+                          description: "test bill",                             # 取引説明文
+                          created_from: "2016-02-26T19:01:25.000000+09:00",     # 作成日時(起点)
+                          created_to: "2021-01-22T10:47:37.000000+09:00",       # 作成日時(終点)
+                          shop_name: "bill test shop1",                         # 店舗名
+                          shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",      # 店舗ID
+                          lower_limit_amount: 4942,                             # 金額の範囲によるフィルタ(下限)
+                          upper_limit_amount: 1563,                             # 金額の範囲によるフィルタ(上限)
+                          is_disabled: true                                     # 支払いQRコードが無効化されているかどうか
+))
+```
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページに表示する支払いQRコードの数です。
+
+---
+`bill_id`  
+支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
+
+---
+`private_money_id`  
+支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
+
+---
+`organization_code`  
+支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
+
+---
+`description`  
+支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
+
+---
+`created_from`  
+支払いQRコードの作成日時でフィルターします。
+
+これ以降に作成された支払いQRコードのみ一覧に表示されます。
+
+---
+`created_to`  
+支払いQRコードの作成日時でフィルターします。
+
+これ以前に作成された支払いQRコードのみ一覧に表示されます。
+
+---
+`shop_name`  
+支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
+
+---
+`shop_id`  
+支払いQRコードを作成した店舗IDでフィルターします。
 
-                           # フィルタオプション (すべて任意)
-                           # 期間指定 (ISO8601形式の文字列)
-                           "from" => "2019-01-01T00:00:00+09:00",
-                           "to"   => "2019-07-30T18:13:39+09:00",
+---
+`lower_limit_amount`  
+支払いQRコードの金額の下限を指定してフィルターします。
 
-                           # 検索オプション
-                           "customer_id"    => "xxxxxxxxxxxxxxxxx", # エンドユーザーID
-                           "customer_name"  => "福沢",              # エンドユーザー名
-                           "transaction_id" => "24bba30c......",    # 取引ID
-                           "shop_id"        => "456a820b......",    # 店舗ID
-                           "terminal_id"    => "d8023185......",    # 端末ID
-                           "organization"   => "pocketchange",      # 組織コード
-                           "private_money_id" => "9ff644fc......",  # マネーID
-                           "is_modified"    => true,                # キャンセルされた取引のみ検索するか
-                           # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
-                           "types"          => ["topup", "payment"],
-                         }))
+---
+`upper_limit_amount`  
+支払いQRコードの金額の上限を指定してフィルターします。
+
+---
+`is_disabled`  
+支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
+
+---
+成功したときは[PaginatedBills](#paginated-bills)オブジェクトを返します
+<a name="create-bill"></a>
+#### 支払いQRコードの発行
+支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
+```ruby
+response = $client.send(Pokepay::Request::CreateBill.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: 支払いマネーのマネーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # shop_id: 支払い先(受け取り人)の店舗ID
+                          amount: 3512,                                         # 支払い額
+                          description: "test bill"                              # 説明文(アプリ上で取引の説明文として表示される)
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` を `rows` に含むページングオブジェクトを返します。  
-詳細は [ページング](#paging) を参照してください。
+---
+`amount`  
+支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
 
-### Customer
+---
+成功したときは[Bill](#bill)オブジェクトを返します
+<a name="update-bill"></a>
+#### 支払いQRコードの更新
+支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
+```ruby
+response = $client.send(Pokepay::Request::UpdateBill.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # bill_id: 支払いQRコードのID
+                          amount: 2045,                                         # 支払い額
+                          description: "test bill",                             # 説明文
+                          is_disabled: true                                     # 無効化されているかどうか
+))
+```
+
+---
+`bill_id`  
+更新対象の支払いQRコードのIDです。
+
+---
+`amount`  
+支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+---
+`description`  
+支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
+
+---
+`is_disabled`  
+支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
+
+---
+成功したときは[Bill](#bill)オブジェクトを返します
+### Cashtray
+Cashtrayは支払いとチャージ両方に使えるQRコードで、店舗ユーザとエンドユーザーの間の主に店頭などでの取引のために用いられます。
+Cashtrayによる取引では、エンドユーザーがQRコードを読み取った時点で即時取引が作られ、ユーザに対して受け取り確認画面は表示されません。
+Cashtrayはワンタイムで、一度読み取りに成功するか、取引エラーになると失効します。
+また、Cashtrayには有効期限があり、デフォルトでは30分で失効します。
+
+<a name="create-cashtray"></a>
+#### Cashtrayを作る
+Cashtrayを作成します。
+
+エンドユーザーに対して支払いまたはチャージを行う店舗の情報(店舗ユーザーIDとマネーID)と、取引金額が必須項目です。
+店舗ユーザーIDとマネーIDから店舗ウォレットを特定します。
 
-#### 新規エンドユーザー口座を追加する
+その他に、Cashtrayから作られる取引に対する説明文や失効時間を指定できます。
 
 ```ruby
-response = client.send(Pokepay::Request::CreateCustomerAccount.new(
-                         "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",    # マネーのID
-                         {
-                           "user_name" => "ポケペイ太郎",             #  ユーザー名 (任意)
-                           "account_name" => "ポケペイ太郎のアカウント" # アカウント名 (任意)
-                         }))
+response = $client.send(Pokepay::Request::CreateCashtray.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # shop_id: 店舗ユーザーID
+                          1828,                                                 # amount: 金額
+                          description: "たい焼き(小倉)",                              # 取引履歴に表示する説明文
+                          expires_in: 3161                                      # 失効時間(秒)
+))
 ```
 
-成功したときは以下のプロパティを持つ `Pokepay::Response::AccountWithUser` のオブジェクトをレスポンスとして返します。
+---
+`private_money_id`  
+取引対象のマネーのIDです(必須項目)。
+
+---
+`shop_id`  
+店舗のユーザーIDです(必須項目)。
+
+---
+`amount`  
+マネー額です(必須項目)。
+正の値を与えるとチャージになり、負の値を与えると支払いとなります。
+
+---
+`description`  
+Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
+アプリや管理画面などの取引履歴に表示されます。デフォルトでは空文字になります。
+
+---
+`expires_in`  
+Cashtrayが失効するまでの時間を秒単位で指定します(任意項目、デフォルト値は1800秒(30分))。
+
+---
+成功したときは[Cashtray](#cashtray)オブジェクトを返します
+<a name="get-cashtray"></a>
+#### Cashtrayの情報を取得する
+Cashtrayの情報を取得します。
+
+Cashtrayの現在の状態に加え、エンドユーザーのCashtray読み取りの試行結果、Cashtray読み取りによって作られた取引情報が取得できます。
+
+レスポンス中の `attempt` には、このCashtrayをエンドユーザーが読み取った試行結果が入ります。
+`account` はエンドユーザーのウォレット情報です。
+成功時には `attempt` 内の `status_code` に200が入ります。
+
+まだCashtrayが読み取られていない場合は `attempt` の内容は `NULL` になります。
+エンドユーザーのCashtray読み取りの際には、様々なエラーが起き得ます。
+エラーの詳細は `attempt` 中の `error_type` と `error_message` にあります。主なエラー型と対応するステータスコードを以下に列挙します。
+
+- `cashtray_already_proceed (422)`
+  - 既に処理済みのCashtrayをエンドユーザーが再び読み取ったときに返されます
+- `cashtray_expired (422)`
+  - 読み取り時点でCashtray自体の有効期限が切れているときに返されます。Cashtrayが失効する時刻はレスポンス中の `expires_at` にあります
+- `cashtray_already_canceled (422)`
+  - 読み取り時点でCashtrayが無効化されているときに返されます
+- `account_balance_not_enough (422)`
+  - 支払い時に、エンドユーザーの残高が不足していて取引が完了できなかったときに返されます
+- `account_balance_exceeded`
+  - チャージ時に、エンドユーザーのウォレット上限を超えて取引が完了できなかったときに返されます
+- `account_transfer_limit_exceeded (422)`
+  - マネーに設定されている一度の取引金額の上限を超えたため、取引が完了できなかったときに返されます
+- `account_not_found (422)`
+  - Cashtrayに設定されたマネーのウォレットをエンドユーザーが持っていなかったときに返されます
+
+
+レスポンス中の `transaction` には、このCashtrayをエンドユーザーが読み取ることによって作られる取引データが入ります。まだCashtrayが読み取られていない場合は `NULL` になります。
+
+以上をまとめると、Cashtrayの状態は以下のようになります。
+
+- エンドユーザーのCashtray読み取りによって取引が成功した場合
+  - レスポンス中の `attempt` と `transaction` にそれぞれ値が入ります
+- 何らかの理由で取引が失敗した場合
+  - レスポンス中の `attempt` にエラー内容が入り、 `transaction` には `NULL` が入ります
+- まだCashtrayが読み取られていない場合
+  - レスポンス中の `attempt` と `transaction` にそれぞれ `NULL` が入ります。Cashtrayの `expires_at` が現在時刻より前の場合は有効期限切れ状態です。
+
+Cashtrayの取り得る全ての状態を擬似コードで記述すると以下のようになります。
+```
+if (attempt == null) {
+  // 状態は未確定
+  if (canceled_at != null) {
+    // 無効化済み
+  } else if (expires_at < now) {
+    // 失効済み
+  } else {
+    // まだ有効で読み取られていない
+  }
+} else if (transaction != null) {
+  // 取引成功確定。attempt で読み取ったユーザなどが分かる
+} else {
+  // 取引失敗確定。attempt で失敗理由などが分かる
+}
+```
+```ruby
+response = $client.send(Pokepay::Request::GetCashtray.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # cashtray_id: CashtrayのID
+))
+```
 
-- id (string): 口座ID
-- name (string): 口座名
-- isSuspended (bool): 口座が凍結されているかどうか
-- privateMoney (Response\PrivateMoney): 設定マネー情報
-- user (Response\User): ユーザーIDなどを含むユーザー情報
+---
+`cashtray_id`  
+情報を取得するCashtrayのIDです。
+
+---
+成功したときは[CashtrayWithResult](#cashtray-with-result)オブジェクトを返します
+<a name="cancel-cashtray"></a>
+#### Cashtrayを無効化する
+Cashtrayを無効化します。
+
+これにより、 `GetCashtray` のレスポンス中の `canceled_at` に無効化時点での現在時刻が入るようになります。
+エンドユーザーが無効化されたQRコードを読み取ると `cashtray_already_canceled` エラーとなり、取引は失敗します。
+```ruby
+response = $client.send(Pokepay::Request::CancelCashtray.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # cashtray_id: CashtrayのID
+))
+```
 
-#### エンドユーザーの口座情報を表示する
+---
+`cashtray_id`  
+無効化するCashtrayのIDです。
 
+---
+成功したときは[Cashtray](#cashtray)オブジェクトを返します
+<a name="update-cashtray"></a>
+#### Cashtrayの情報を更新する
+Cashtrayの内容を更新します。bodyパラメーターは全て省略可能で、指定したもののみ更新されます。
 ```ruby
-response = client.send(Pokepay::Request::GetAccount.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # 口座ID
-                         ))
+response = $client.send(Pokepay::Request::UpdateCashtray.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # cashtray_id: CashtrayのID
+                          amount: 987,                                          # 金額
+                          description: "たい焼き(小倉)",                              # 取引履歴に表示する説明文
+                          expires_in: 5471                                      # 失効時間(秒)
+))
 ```
 
-成功したときは以下のプロパティを持つ `Pokepay::Response::AccountDetail` のオブジェクトをレスポンスとして返します。
+---
+`cashtray_id`  
+更新対象のCashtrayのIDです。
+
+---
+`amount`  
+マネー額です(任意項目)。
+正の値を与えるとチャージになり、負の値を与えると支払いとなります。
+
+---
+`description`  
+Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
+アプリや管理画面などの取引履歴に表示されます。
+
+---
+`expires_in`  
+Cashtrayが失効するまでの時間を秒で指定します(任意項目、デフォルト値は1800秒(30分))。
 
-- id (string): 口座ID
-- name (string): 口座名
-- isSuspended (bool): 口座が凍結されているかどうか
-- balance (double): 総残高
-- moneyBalance (double): 総マネー残高
-- pointBalance (double): 総ポイント残高
-- privateMoney (Response\PrivateMoney): 設定マネー情報
+---
+成功したときは[Cashtray](#cashtray)オブジェクトを返します
+### Customer
+<a name="get-account"></a>
+#### ウォレット情報を表示する
+ウォレットを取得します。
+```ruby
+response = $client.send(Pokepay::Request::GetAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # account_id: ウォレットID
+))
+```
 
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
+
+---
+成功したときは[AccountDetail](#account-detail)オブジェクトを返します
+<a name="update-account"></a>
+#### ウォレット情報を更新する
+ウォレットの状態を更新します。現在はウォレットの凍結/凍結解除の切り替えにのみ対応しています。
+```ruby
+response = $client.send(Pokepay::Request::UpdateAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # account_id: ウォレットID
+                          is_suspended: false                                   # ウォレットが凍結されているかどうか
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+指定したウォレットIDのウォレットの状態を更新します。
+
+---
+`is_suspended`  
+ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
+
+---
+成功したときは[AccountDetail](#account-detail)オブジェクトを返します
+<a name="list-account-balances"></a>
 #### エンドユーザーの残高内訳を表示する
+エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListAccountBalances.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # account_id: ウォレットID
+                          page: 2948,                                           # ページ番号
+                          per_page: 4246,                                       # 1ページ分の取引数
+                          expires_at_from: "2024-04-18T03:31:49.000000+09:00",  # 有効期限の期間によるフィルター(開始時点)
+                          expires_at_to: "2019-01-11T07:51:31.000000+09:00",    # 有効期限の期間によるフィルター(終了時点)
+                          direction: "desc"                                     # 有効期限によるソート順序
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
+
+---
+`page`  
+取得したいページ番号です。デフォルト値は1です。
 
-エンドユーザーの残高は有効期限別のリストとして取得できます。
+---
+`per_page`  
+1ページ分のウォレット残高数です。デフォルト値は30です。
 
+---
+`expires_at_from`  
+有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`expires_at_to`  
+有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`direction`  
+有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
+
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
+<a name="list-account-expired-balances"></a>
+#### エンドユーザーの失効済みの残高内訳を表示する
+エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
 ```ruby
-response = client.send(Pokepay::Request::ListAccountBalances.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 口座ID
-                         ))
+response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # account_id: ウォレットID
+                          page: 6863,                                           # ページ番号
+                          per_page: 6525,                                       # 1ページ分の取引数
+                          expires_at_from: "2022-09-24T18:44:02.000000+09:00",  # 有効期限の期間によるフィルター(開始時点)
+                          expires_at_to: "2017-07-29T15:03:56.000000+09:00",    # 有効期限の期間によるフィルター(終了時点)
+                          direction: "desc"                                     # 有効期限によるソート順序
+))
 ```
 
-成功したときは `Pokepay::Response::AccountBalance` を `rows` に含むページングオブジェクトを返します。  
-詳細は [ページング](#paging) を参照してください。
+---
+`account_id`  
+ウォレットIDです。
 
-`Pokepay::Response::AccountBalance` のプロパティは以下の通りです。
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
 
-- expiresAt (DateTime): 失効日時
-- moneyAmount (double): マネー額
-- pointAmount (double): ポイント額
+---
+`page`  
+取得したいページ番号です。デフォルト値は1です。
 
-### Organization
+---
+`per_page`  
+1ページ分のウォレット残高数です。デフォルト値は30です。
+
+---
+`expires_at_from`  
+有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`expires_at_to`  
+有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`direction`  
+有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
 
-#### 新規加盟店組織を追加する
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
+<a name="create-customer-account"></a>
+#### 新規エンドユーザーウォレットを追加する
+指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
+```ruby
+response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          user_name: "ポケペイ太郎",                                  # ユーザー名
+                          account_name: "ポケペイ太郎のアカウント"                          # アカウント名
+))
+```
+
+---
+`private_money_id`  
+マネーIDです。
+
+これによって作成するウォレットのマネーを指定します。
 
+---
+`user_name`  
+ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
+
+---
+`account_name`  
+作成するウォレット名です。省略した場合は空文字となります。
+
+---
+成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
+<a name="list-customer-transactions"></a>
+#### 取引履歴を取得する
+取引一覧を返します。
 ```ruby
-response = client.send(Pokepay::Request::CreateOrganization.new(
-                         "ox_supermarket",                   # 新規組織コード
-                         "oxスーパー",                         # 新規組織名
-                         "pay@xx-issuer-company.jp",         # 発行体担当者メールアドレス
-                         "admin+pokepay@ox-supermarket.com", # 新規組織担当者メールアドレス
-                         {
-                           # 追加データ (すべて任意)
-                           "bank_name"                => "XYZ銀行",  # 銀行名
-                           "bank_code"                => "999X",    # 銀行金融機関コード
-                           "bank_branch_name"         => "ABC支店",  # 銀行支店名
-                           "bank_banch_code"          => "99X",     # 銀行支店コード
-                           "bank_account_type"        => "saving",  # 銀行口座種別 (普通=saving, 当座=current, その他=other)
-                           "bank_account"             => "9999999", # 銀行口座番号
-                           "bank_account_holder_name" => "ﾌｸｻﾞﾜﾕｷﾁ", # 口座名義人名
-                         }))
+response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
+                          receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
+                          type: "L",                                            # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
+                          is_modified: true,                                    # キャンセル済みかどうか
+                          from: "2017-03-01T02:18:01.000000+09:00",             # 開始日時
+                          to: "2021-08-14T21:55:36.000000+09:00",               # 終了日時
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取引数
+))
 ```
 
-成功したときには以下のプロパティを持つ `Pokepay::Response::Organization` のオブジェクトをレスポンスとして返します。
+---
+`private_money_id`  
+マネーIDです。
+フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
+
+---
+`sender_customer_id`  
+送金ユーザーIDです。
+
+フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
+
+---
+`receiver_customer_id`  
+受取ユーザーIDです。
+
+フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
+
+---
+`type`  
+取引の種類でフィルターします。
+
+以下の種類を指定できます。
+
+1. topup
+   店舗からエンドユーザーへの送金取引(チャージ)
+2. payment
+   エンドユーザーから店舗への送金取引(支払い)
+3. exchange
+   他マネーへの流出(outflow)/他マネーからの流入(inflow)
+4. transfer
+   個人間送金
+
+---
+`is_modified`  
+キャンセル済みかどうかを判定するフラグです。
+
+これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+falseを指定するとキャンセルされていない取引のみ一覧に表示されます
+何も指定しなければキャンセルの有無にかかわらず一覧に表示されます。
+
+---
+`from`  
+抽出期間の開始日時です。
+
+フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+
+---
+`to`  
+抽出期間の終了日時です。
+
+フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
 
-- code (string): 組織コード
-- name (string): 組織名
+---
+`page`  
+取得したいページ番号です。
 
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
+### Organization
 ### Shop
+<a name="list-shops"></a>
+#### 店舗一覧を取得する
+```ruby
+response = $client.send(Pokepay::Request::ListShops.new(
+                          organization_code: "pocketchange",                    # 組織コード
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
+                          name: "oxスーパー三田店",                                    # 店舗名
+                          postal_code: "624-0001",                              # 店舗の郵便番号
+                          address: "東京都港区芝...",                                 # 店舗の住所
+                          tel: "077-41-284",                                    # 店舗の電話番号
+                          email: "fAUj6MGuDC@QRgb.com",                         # 店舗のメールアドレス
+                          external_id: "h69IfOOqdFvcvTYHWhMSc2JtDSCuxpXIBKj",   # 店舗の外部ID
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取引数
+))
+```
+
+---
+`organization_code`  
+このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
+
+
+---
+`private_money_id`  
+このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
+
+
+---
+`name`  
+このパラメータを渡すとその名前の店舗のみが返されます。
+
+
+---
+`postal_code`  
+このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
+
+
+---
+`address`  
+このパラメータを渡すとその住所が登録された店舗のみが返されます。
 
-#### 新規店舗を追加する
 
+---
+`tel`  
+このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
+
+
+---
+`email`  
+このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
+
+
+---
+`external_id`  
+このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
+
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
+<a name="create-shop"></a>
+#### 新規店舗を追加する(廃止予定)
+新規店舗を追加します。このAPIは廃止予定です。以降は `CreateShopV2` を使用してください。
+```ruby
+response = $client.send(Pokepay::Request::CreateShop.new(
+                          "oxスーパー三田店",                                          # shop_name: 店舗名
+                          shop_postal_code: "8072594",                          # 店舗の郵便番号
+                          shop_address: "東京都港区芝...",                            # 店舗の住所
+                          shop_tel: "083-7936908",                              # 店舗の電話番号
+                          shop_email: "hctiEpL1Kl@L20S.com",                    # 店舗のメールアドレス
+                          shop_external_id: "Y28CEIpXvCz2lX0WFgkUTJYHHO",       # 店舗の外部ID
+                          organization_code: "ox-supermarket"                   # 組織コード
+))
+```
+成功したときは[User](#user)オブジェクトを返します
+<a name="create-shop-v"></a>
+#### 新規店舗を追加する
 ```ruby
-response = client.send(Pokepay::Request::CreateShop.new(
-                         "OXスーパー三田店",             # 店舗名
-                         {
-                           # 追加データ (すべて任意)
-                           "shop_postal_code" => "108-0014",                # 店舗の郵便番号
-                           "shop_address"     => "東京都港区芝...",           # 店舗の住所
-                           "shop_tel"         => "03-xxxx...",              # 店舗の電話番号
-                           "shop_email"       => "mita@ox-supermarket.com", # 店舗のメールアドレス
-                           "shop_external_id" => "mita0309",                # 店舗の外部ID
-                         }))
+response = $client.send(Pokepay::Request::CreateShopV.new(
+                          "oxスーパー三田店",                                          # name: 店舗名
+                          postal_code: "6626381",                               # 店舗の郵便番号
+                          address: "東京都港区芝...",                                 # 店舗の住所
+                          tel: "05763334042",                                   # 店舗の電話番号
+                          email: "jCOwyap0ls@b8d4.com",                         # 店舗のメールアドレス
+                          external_id: "Dc5yMU1TN0yX6wxY6IPoPyEr8klnc",         # 店舗の外部ID
+                          organization_code: "ox-supermarket",                  # 組織コード
+                          private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
+                          can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
+))
 ```
 
-成功したときは以下のプロパティを持つ `Pokepay::Response::User` のオブジェクトをレスポンスとして返します。
+---
+`name`  
+店舗名です。
 
-- id (string): 店舗ID
-- name (string): 店舗名
-- isMerchant (bool): 店舗かどうかのフラグ (この場合は常に真)
+同一組織内に同名の店舗があった場合は`name_conflict`エラーが返ります。
 
-### Private Money
+---
+`private_money_ids`  
+店舗で有効にするマネーIDの配列を指定します。
 
-#### 決済加盟店の取引サマリを取得する
+店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
+このパラメータを省略したときは、店舗が所属する組織が発行または加盟している全てのマネーのウォレットができます。
 
+---
+`can_topup_private_money_ids`  
+店舗でチャージ可能にするマネーIDの配列を指定します。
+
+このパラメータは発行体のみが指定でき、自身が発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
+省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
+
+---
+成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
+<a name="get-shop"></a>
+#### 店舗情報を表示する
+店舗情報を表示します。
+
+権限に関わらず自組織の店舗情報は表示可能です。それに加え、発行体は自組織の発行しているマネーの加盟店組織の店舗情報を表示できます。
 ```ruby
-response = client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
-                         "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz", # マネーのID
-                         {
-                           # フィルタオプション (すべて任意)
-                           # 期間指定 (ISO8601形式の文字列、またはDateTimeオブジェクト)
-                           # fromとtoを指定する場合は同時に指定する必要あり。
-                           # デフォルトではfromは昨日0時、toは当日0時。
-                          "from" => "2019-01-01T00:00:00+09:00",
-                          "to"   => "2019-07-31T18:13:39+09:00",
+response = $client.send(Pokepay::Request::GetShop.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # shop_id: 店舗ユーザーID
+))
+```
+成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
+<a name="update-shop"></a>
+#### 店舗情報を更新する
+店舗情報を更新します。bodyパラメーターは全て省略可能で、指定したもののみ更新されます。
+```ruby
+response = $client.send(Pokepay::Request::UpdateShop.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # shop_id: 店舗ユーザーID
+                          name: "oxスーパー三田店",                                    # 店舗名
+                          postal_code: "5576227",                               # 店舗の郵便番号
+                          address: "東京都港区芝...",                                 # 店舗の住所
+                          tel: "0904519142",                                    # 店舗の電話番号
+                          email: "uyEzfF4ihE@MnqI.com",                         # 店舗のメールアドレス
+                          external_id: "LL8T5msTmgqj81R",                       # 店舗の外部ID
+                          private_money_ids: [],                                # 店舗で有効にするマネーIDの配列
+                          can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
+))
+```
+
+---
+`name`  
+店舗名です。
+
+同一組織内に同名の店舗があった場合は`shop_name_conflict`エラーが返ります。
+
+---
+`postal_code`  
+店舗住所の郵便番号(7桁の数字)です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
+
+---
+`tel`  
+店舗の電話番号です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
+
+---
+`email`  
+店舗の連絡先メールアドレスです。明示的に空の値を設定するにはNULLを指定します。
+
+---
+`external_id`  
+店舗の外部IDです(最大36文字)。明示的に空の値を設定するにはNULLを指定します。
+
+---
+`private_money_ids`  
+店舗で有効にするマネーIDの配列を指定します。
+
+店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
+店舗が既にウォレットを持っている場合に、ここでそのウォレットのマネーIDを指定しないで更新すると、そのマネーのウォレットは凍結(無効化)されます。
 
-                          # ページングオプション
-                          "page"     => 1,
-                          "per_page" => 50
-                         }))
+---
+`can_topup_private_money_ids`  
+店舗でチャージ可能にするマネーIDの配列を指定します。
+
+このパラメータは発行体のみが指定でき、発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
+省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
+
+---
+成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
+### Account
+<a name="list-user-accounts"></a>
+#### エンドユーザー、店舗ユーザーのウォレット一覧を表示する
+ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListUserAccounts.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # user_id: ユーザーID
+))
 ```
 
-成功したときは `Pokepay::Response::PrivateMoneyOrganizationSummary` を `rows` に含むページングオブジェクトを返します。  
-以下にプロパティを示します。
+---
+`user_id`  
+ユーザーIDです。
+
+指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
 
-- organizationCode (string): 組織コード
-- topup (Response::OrganizationSummary): チャージのサマリ情報
-- payment (Response::OrganizationSummary): 支払いのサマリ情報
+---
+成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
+### Private Money
+<a name="get-private-moneys"></a>
+#### マネー一覧を取得する
+マネーの一覧を取得します。
+パートナーキーの管理者が発行体組織に属している場合、自組織が加盟または発行しているマネーの一覧を返します。また、`organization_code`として決済加盟店の組織コードを指定した場合、発行マネーのうち、その決済加盟店組織が加盟しているマネーの一覧を返します。
+パートナーキーの管理者が決済加盟店組織に属している場合は、自組織が加盟しているマネーの一覧を返します。
+```ruby
+response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
+                          organization_code: "ox-supermarket",                  # 組織コード
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取得数
+))
+```
 
-`Pokepay::Response::OrganizationSummary` のプロパティを以下に示します。
+---
+`organization_code`  
+パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
 
-- count (integer): 取引数
-- moneyAmount (double): 取引マネー総額
-- moneyCount (integer): マネー取引数
-- pointAmount (double): 取引ポイント総額
-- pointCount (integer): ポイント取引数
+---
+成功したときは[PaginatedPrivateMoneys](#paginated-private-moneys)オブジェクトを返します
+<a name="get-private-money-organization-summaries"></a>
+#### 決済加盟店の取引サマリを取得する
+```ruby
+response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          from: "2017-03-23T12:47:17.000000+09:00",             # 開始日時(toと同時に指定する必要有)
+                          to: "2024-06-20T02:27:27.000000+09:00",               # 終了日時(fromと同時に指定する必要有)
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取引数
+))
+```
+`from`と`to`は同時に指定する必要があります。
+
+成功したときは[PaginatedPrivateMoneyOrganizationSummaries](#paginated-private-money-organization-summaries)オブジェクトを返します
+### Bulk
+<a name="bulk-create-transaction"></a>
+#### CSVファイル一括取引
+CSVファイルから一括取引をします。
+```ruby
+response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
+                          "GFY2SrpQfm9Le0rSPWlrPa8fbLwdjVa",                    # name: 一括取引タスク名
+                          "9Jyd",                                               # content: 取引する情報のCSV
+                          "pHqXjqW7D3uCGCdE3Z7gIcLSudPl4JIrQmLF",               # request_id: リクエストID
+                          description: "JxcGB9NLriuIsMTYyCUoOEa9YZaUNPTMagDSPeHLGCGYvgqbqCIdoPTyGfjAlvbOwBRftL3mTfJhTjDs9c8QNUGv" # 一括取引の説明
+))
+```
 
-ページングについての詳細は [ページング](#paging) を参照してください。
+---
+`name`  
+一括取引タスクの管理用の名前です。
+
+---
+`description`  
+一括取引タスクの管理用の説明文です。
+
+---
+`content`  
+一括取引する情報を書いたCSVの文字列です。
+1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
+カラムは以下の7つです。任意のカラムには空文字を指定します。
+
+- `type`: 取引種別
+  - 必須。'topup' または 'payment'
+- `sender_id`: 送金ユーザーID
+  - 必須。UUID
+- `receiver_id`: 受取ユーザーID
+  - 必須。UUID
+- `private_money_id`: マネーID
+  - 必須。UUID
+- `money_amount`: マネー額
+  - 任意。ただし `point_amount` といずれかが必須。0以上の数字
+- `point_amount`: ポイント額
+  - 任意。ただし `money_amount` といずれかが必須。0以上の数字
+- `description`: 取引の説明文
+  - 任意。200文字以内。取引履歴に表示される文章
+- `bear_account_id`: ポイント負担ウォレットID
+  - `point_amount` があるときは必須。UUID
+- `point_expires_at`: ポイントの有効期限
+  - 任意。指定がないときはマネーに設定された有効期限を適用
+
+---
+`request_id`  
+重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
+
+---
+成功したときは[BulkTransaction](#bulk-transaction)オブジェクトを返します
+## Responses
+
+
+<a name="account-with-user"></a>
+## AccountWithUser
+* `id (string)`: 
+* `name (string)`: 
+* `is_suspended (boolean)`: 
+* `private_money (PrivateMoney)`: 
+* `user (User)`: 
+
+`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+`user`は [User](#user) オブジェクトを返します。
+
+<a name="account-detail"></a>
+## AccountDetail
+* `id (string)`: 
+* `name (string)`: 
+* `is_suspended (boolean)`: 
+* `balance (double)`: 
+* `money_balance (double)`: 
+* `point_balance (double)`: 
+* `private_money (PrivateMoney)`: 
+
+`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+<a name="bill"></a>
+## Bill
+* `id (string)`: 支払いQRコードのID
+* `amount (double)`: 支払い額
+* `max_amount (double)`: 支払い額を範囲指定した場合の上限
+* `min_amount (double)`: 支払い額を範囲指定した場合の下限
+* `description (string)`: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
+* `account (AccountWithUser)`: 支払いQRコード発行ウォレット
+* `is_disabled (boolean)`: 無効化されているかどうか
+* `token (string)`: 支払いQRコードを解析したときに出てくるURL
+
+`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
+
+<a name="cashtray"></a>
+## Cashtray
+* `id (string)`: Cashtray自体のIDです。
+* `amount (double)`: 取引金額
+* `description (string)`: Cashtrayの説明文
+* `account (AccountWithUser)`: 発行店舗のウォレット
+* `expires_at (string)`: Cashtrayの失効日時
+* `canceled_at (string)`: Cashtrayの無効化日時。NULLの場合は無効化されていません
+* `token (string)`: CashtrayのQRコードを解析したときに出てくるURL
+
+`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
+
+<a name="cashtray-with-result"></a>
+## CashtrayWithResult
+* `id (string)`: CashtrayのID
+* `amount (double)`: 取引金額
+* `description (string)`: Cashtrayの説明文(アプリ上で取引の説明文として表示される)
+* `account (AccountWithUser)`: 発行店舗のウォレット
+* `expires_at (string)`: Cashtrayの失効日時
+* `canceled_at (string)`: Cashtrayの無効化日時。NULLの場合は無効化されていません
+* `token (string)`: CashtrayのQRコードを解析したときに出てくるURL
+* `attempt (CashtrayAttempt)`: Cashtray読み取り結果
+* `transaction (Transaction)`: 取引結果
+
+`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
+
+`attempt`は [CashtrayAttempt](#cashtray-attempt) オブジェクトを返します。
+
+`transaction`は [Transaction](#transaction) オブジェクトを返します。
+
+<a name="user"></a>
+## User
+* `id (string)`: ユーザー (または店舗) ID
+* `name (string)`: ユーザー (または店舗) 名
+* `is_merchant (boolean)`: 店舗ユーザーかどうか
+
+<a name="transaction"></a>
+## Transaction
+* `id (string)`: 取引ID
+* `type (string)`: 取引種別 (チャージ=topup, 支払い=payment)
+* `is_modified (boolean)`: 返金された取引かどうか
+* `sender (User)`: 送金者情報
+* `sender_account (Account)`: 送金ウォレット情報
+* `receiver (User)`: 受取者情報
+* `receiver_account (Account)`: 受取ウォレット情報
+* `amount (double)`: 決済総額 (マネー額 + ポイント額)
+* `money_amount (double)`: 決済マネー額
+* `point_amount (double)`: 決済ポイント額
+* `done_at (string)`: 取引日時
+* `description (string)`: 取引説明文
+
+`receiver`と`sender`は [User](#user) オブジェクトを返します。
+
+`receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
+
+<a name="shop-with-accounts"></a>
+## ShopWithAccounts
+* `id (string)`: 店舗ID
+* `name (string)`: 店舗名
+* `organization_code (string)`: 組織コード
+* `postal_code (string)`: 店舗の郵便番号
+* `address (string)`: 店舗の住所
+* `tel (string)`: 店舗の電話番号
+* `email (string)`: 店舗のメールアドレス
+* `external_id (string)`: 店舗の外部ID
+* `accounts (array of ShopAccounts)`: 
+
+`accounts`は [ShopAccount](#shop-account) オブジェクトの配列を返します。
+
+<a name="bulk-transaction"></a>
+## BulkTransaction
+* `id (string)`: 
+* `request_id (string)`: リクエストID
+* `name (string)`: バルク取引管理用の名前
+* `description (string)`: バルク取引管理用の説明文
+* `status (string)`: バルク取引の状態
+* `error (string)`: バルク取引のエラー種別
+* `error_lineno (integer)`: バルク取引のエラーが発生した行番号
+* `submitted_at (string)`: バルク取引が登録された日時
+* `updated_at (string)`: バルク取引が更新された日時
+
+<a name="paginated-private-money-organization-summaries"></a>
+## PaginatedPrivateMoneyOrganizationSummaries
+* `rows (array of PrivateMoneyOrganizationSummaries)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [PrivateMoneyOrganizationSummary](#private-money-organization-summary) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-transaction"></a>
+## PaginatedTransaction
+* `rows (array of Transactions)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [Transaction](#transaction) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-transfers"></a>
+## PaginatedTransfers
+* `rows (array of Transfers)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [Transfer](#transfer) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-accounts"></a>
+## PaginatedAccounts
+* `rows (array of Accounts)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [Account](#account) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-account-balance"></a>
+## PaginatedAccountBalance
+* `rows (array of AccountBalances)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [AccountBalance](#account-balance) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-shops"></a>
+## PaginatedShops
+* `rows (array of ShopWithMetadatas)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [ShopWithMetadata](#shop-with-metadata) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-bills"></a>
+## PaginatedBills
+* `rows (array of Bills)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [Bill](#bill) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-private-moneys"></a>
+## PaginatedPrivateMoneys
+* `rows (array of PrivateMoneys)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [PrivateMoney](#private-money) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="private-money"></a>
+## PrivateMoney
+* `id (string)`: マネーID
+* `name (string)`: マネー名
+* `unit (string)`: マネー単位 (例: 円)
+* `is_exclusive (boolean)`: 会員制のマネーかどうか
+* `description (string)`: マネー説明文
+* `oneline_message (string)`: マネーの要約
+* `organization (Organization)`: マネーを発行した組織
+* `max_balance (double)`: ウォレットの上限金額
+* `transfer_limit (double)`: マネーの取引上限額
+* `type (string)`: マネー種別 (自家型=own, 第三者型=third-party)
+* `expiration_type (string)`: 有効期限種別 (チャージ日起算=static, 最終利用日起算=last-update, 最終チャージ日起算=last-topup-update)
+* `enable_topup_by_member (boolean)`: 加盟店によるチャージが有効かどうか
+
+`organization`は [Organization](#organization) オブジェクトを返します。
+
+<a name="cashtray-attempt"></a>
+## CashtrayAttempt
+* `account (AccountWithUser)`: エンドユーザーのウォレット
+* `status_code (double)`: ステータスコード
+* `error_type (string)`: エラー型
+* `error_message (string)`: エラーメッセージ
+* `created_at (string)`: Cashtray読み取り記録の作成日時
+
+`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
+
+<a name="account"></a>
+## Account
+* `id (string)`: ウォレットID
+* `name (string)`: ウォレット名
+* `is_suspended (boolean)`: ウォレットが凍結されているかどうか
+* `private_money (PrivateMoney)`: 設定マネー情報
+
+`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+<a name="shop-account"></a>
+## ShopAccount
+* `id (string)`: ウォレットID
+* `name (string)`: ウォレット名
+* `is_suspended (boolean)`: ウォレットが凍結されているかどうか
+* `can_transfer_topup (boolean)`: チャージ可能かどうか
+* `private_money (PrivateMoney)`: 設定マネー情報
+
+`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+<a name="private-money-organization-summary"></a>
+## PrivateMoneyOrganizationSummary
+* `organization_code (string)`: 
+* `topup (OrganizationSummary)`: 
+* `payment (OrganizationSummary)`: 
+
+`payment`と`topup`は [OrganizationSummary](#organization-summary) オブジェクトを返します。
+
+<a name="pagination"></a>
+## Pagination
+* `current (integer)`: 
+* `per_page (integer)`: 
+* `max_page (integer)`: 
+* `has_prev (boolean)`: 
+* `has_next (boolean)`: 
+
+<a name="transfer"></a>
+## Transfer
+* `id (string)`: 
+* `sender_account (AccountWithoutPrivateMoneyDetail)`: 
+* `receiver_account (AccountWithoutPrivateMoneyDetail)`: 
+* `amount (double)`: 
+* `money_amount (double)`: 
+* `point_amount (double)`: 
+* `done_at (string)`: 
+* `type (string)`: 
+* `description (string)`: 
+* `transaction_id (string)`: 
+
+`receiver_account`と`sender_account`は [AccountWithoutPrivateMoneyDetail](#account-without-private-money-detail) オブジェクトを返します。
+
+<a name="account-balance"></a>
+## AccountBalance
+* `expires_at (string)`: 
+* `money_amount (double)`: 
+* `point_amount (double)`: 
+
+<a name="shop-with-metadata"></a>
+## ShopWithMetadata
+* `id (string)`: 店舗ID
+* `name (string)`: 店舗名
+* `organization_code (string)`: 組織コード
+* `postal_code (string)`: 店舗の郵便番号
+* `address (string)`: 店舗の住所
+* `tel (string)`: 店舗の電話番号
+* `email (string)`: 店舗のメールアドレス
+* `external_id (string)`: 店舗の外部ID