pokepay_partner_ruby_sdk 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef55822676f9f2e427fd76e1434e510c90491a72d57ce38d0be9c6f9f271936b
-  data.tar.gz: a48fb9effd3ae012dc51d9efc19021088d8d01e6c3eab08745beb5b6e6fbef6d
+  metadata.gz: 5354d8343e918d7d6918a30d5616d3d3af32dfb225a63430a87b439b992bb591
+  data.tar.gz: 11287914f04797d6efb7f32b00b8a231063eb072c690690a354e79cc49e75750
 SHA512:
-  metadata.gz: dce0a61b071729c5b85af8035d7e1cc767d5eb99b55da16a0126c344aba7b8fee5a17a70994d8284bc3fe02910cceda320ff646dcba3aea2230c908a57906cdb
-  data.tar.gz: 2f4f017ff5a6fa72c2dcce10155ec211f9db9f4ca00f8f8f28914502fb85a4721564c014c27efee938889aeeffc3de999e6e4f4bf0bd6e72cd854a05f7c07919
+  metadata.gz: 79786b8b53e12dd1d064e018a17d12ea973b01428520a751f4632fb0babcc40ff234799204a524b2eb41804345b6d2c3726e4cbb0272806a161c9bebd95bd1f5
+  data.tar.gz: 7ec5ccca95604a37fdd5cc71b40d5d9297d1deb0ef8786768ec5993edc42ce8e60b72356352374883e45e0be06b80dd9fb8c46f624b597557a20e3219151e5d7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pokepay_partner_ruby_sdk (0.1.4)
+    pokepay_partner_ruby_sdk (0.1.5)
       inifile (~> 3.0.0)
       json (~> 2.3.0)
       openssl (~> 2.1.2)

data/docs/index.md

@@ -1,5 +1,4 @@
 # Partner API SDK for Ruby
-
 ## Installation
 
 rubygemsからインストールすることができます。
@@ -140,287 +139,627 @@ response.code
 response.body
 # => {"type"=>"invalid_parameters", "message"=>"Invalid parameters", "errors"=>{"invalid"=>["message"]}}
 ```
-
 <a name="api-operations"></a>
 ## API Operations
 
 ### Transaction
 
-<a name="get-transaction"></a>
 #### 取引情報を取得する
-
+取引を取得します。
 ```ruby
-response = client.send(Pokepay::Request::GetTransaction.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # 取引ID
-                         ))
-
+response = $client.send(Pokepay::Request::GetTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // transaction_id: 取引ID
+))
 ```
 
-成功したときは以下のプロパティを含む `Pokepay::Response::Transaction` オブジェクトをレスポンスとして返します。
-
-- 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` のオブジェクトです。 以下にプロパティを示します。
-
-- id (String): ユーザー (または店舗) ID
-- name (String): ユーザー (または店舗) 名
-- is_merchant (真理値): 店舗ユーザーかどうか
-
-`senderAccount` と `receiverAccount` は `Pokepay::Response::Account` のオブジェクトです。以下にプロパティを示します。
-
-- id (String): 口座ID
-- name (String): 口座名
-- is_suspended (真理値): 口座が凍結されているかどうか
-- private_money (Pokepay::Response::PrivateMoney): 設定マネー情報
-
-`privateMoney` は `Pokepay::Response::PrivateMoney` のオブジェクトです。以下にプロパティを示します。
-
-- 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)
+---
+`transaction_id`  
+取引IDです。
 
-#### チャージする
+フィルターとして使われ、指定した取引IDの取引を取得します。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
 
+#### チャージする
+チャージ取引を作成します。
 ```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::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: 8555,                                   // マネー額
+                          point_amount: 2302,                                   // ポイント額
+                          description: "初夏のチャージキャンペーン"                          // 取引履歴に表示する説明文
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` を持つレスポンスオブジェクトを返します。  
-プロパティは [取引情報を取得する](#get-transaction) を参照してください。
+---
+`shop_id`  
+店舗IDです。
+
+送金元の店舗を指定します。
+
+---
+`customer_id`  
+エンドユーザーIDです。
+
+送金先のエンドユーザーを指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
+
+---
+`bear_point_shop_id`  
+ポイント支払時の負担店舗IDです。
+
+ポイント支払い時に実際お金を負担する店舗を指定します。
+
+---
+`money_amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`point_amount`  
+ポイント額です。
+
+送金するポイント額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
 
 #### 支払いする
+支払取引を作成します。
+支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
 
 ```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::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
+                          6077,                                                 // amount: 支払い額
+                          description: "たい焼き(小倉)"                               // 取引履歴に表示する説明文
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` オブジェクトをレスポンスとして返します。  
-プロパティは [取引情報を取得する](#get-transaction) を参照してください。
+---
+`shop_id`  
+店舗IDです。
 
-#### チャージ用QRコードを読み取ることでチャージする
+送金先の店舗を指定します。
 
-チャージ用QRコードを解析すると次のようなURLになります(URLは環境によって異なります)。
+---
+`customer_id`  
+エンドユーザーIDです。
 
-`https://www-sandbox.pokepay.jp/checks/xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx`
+送金元のエンドユーザーを指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
 
-この `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージ用QRコードのIDです。
-これを以下のようにエンドユーザIDと共に渡すことでチャージ取引が作られます。
+---
+`amount`  
+マネー額です。
 
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+#### 取引履歴を取得する
+取引一覧を返します。
 ```ruby
-response = client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
-                         "xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx", # チャージ用QRコードのID
-                         "yyyyyyyy-yyyy-yyyyyyyyy-yyyyyyyyyyyy"  # エンドユーザーのID
-                         ))
+response = $client.send(Pokepay::Request::ListTransactions.new(
+                          from: "2021-04-20T20:55:06.000000+09:00",             // 開始日時
+                          to: "2021-12-08T08:10:34.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
+))
 ```
 
-成功したときは `Pokepay::Response::Transaction` オブジェクトをレスポンスとして返します。  
-プロパティは [取引情報を取得する](#get-transaction) を参照してください。
+---
+`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)オブジェクトを返します
+
+#### 返金する
 ```ruby
-response = client.send(Pokepay::Request::ListTransactions.new(
-                         {
-                           # ページング
-                           "page"     => 1,
-                           "per_page" => 50,
-
-                           # フィルタオプション (すべて任意)
-                           # 期間指定 (ISO8601形式の文字列)
-                           "from" => "2019-01-01T00:00:00+09:00",
-                           "to"   => "2019-07-30T18:13:39+09:00",
-
-                           # 検索オプション
-                           "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"],
-                         }))
+response = $client.send(Pokepay::Request::RefundTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // transaction_id: 取引ID
+                          description: "返品対応のため"                                // 取引履歴に表示する返金事由
+))
 ```
+成功したときは[Transfer](#transfer)オブジェクトを返します
 
-成功したときは `Pokepay::Response::Transaction` を `rows` に含むページングオブジェクトを返します。  
-詳細は [ページング](#paging) を参照してください。
+### チャージQRコード
 
-### Customer
+店舗ユーザが発行し、エンドユーザがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
 
-#### 新規エンドユーザー口座を追加する
+チャージQRコードを解析すると次のようなURLになります(URLは環境によって異なります)。
 
+`https://www-sandbox.pokepay.jp/checks/xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx`
+
+QRコードを読み取る方法以外にも、このURLリンクを直接スマートフォン(iOS/Android)上で開くことによりアプリが起動して取引が行われます。(注意: 上記URLはsandbox環境であるため、アプリもsandbox環境のものである必要があります) 上記URL中の `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージQRコードのIDです。
+
+#### チャージQRコードの発行
 ```ruby
-response = client.send(Pokepay::Request::CreateCustomerAccount.new(
-                         "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",    # マネーのID
-                         {
-                           "user_name" => "ポケペイ太郎",             #  ユーザー名 (任意)
-                           "account_name" => "ポケペイ太郎のアカウント" # アカウント名 (任意)
-                         }))
+response = $client.send(Pokepay::Request::CreateCheck.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: 送金元の店舗アカウントID
+                          money_amount: 5032,                                   // 付与マネー額
+                          point_amount: 1995,                                   // 付与ポイント額
+                          description: "test check",                            // 説明文(アプリ上で取引の説明文として表示される)
+                          is_onetime: false,                                    // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
+                          usage_limit: 219,                                     // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
+                          expires_at: "2024-10-18T00:20:49.000000+09:00",       // チャージQR自体の失効日時
+                          point_expires_at: "2019-07-04T01:50:46.000000+09:00", // チャージQRによって付与されるポイントの失効日時
+                          point_expires_in_days: 60,                            // チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
+                          bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ポイント額を負担する店舗アカウントのID
+))
 ```
+`money_amount`と`point_amount`の少なくとも一方は指定する必要があります。
+
+
+---
+`is_onetime`  
+チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
+`false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
+
+
+---
+`usage_limit`  
+複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
+省略すると無制限に読み取り可能なチャージQRコードになります。
+チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
 
-成功したときは以下のプロパティを持つ `Pokepay::Response::AccountWithUser` のオブジェクトをレスポンスとして返します。
 
-- id (string): 口座ID
-- name (string): 口座名
-- isSuspended (bool): 口座が凍結されているかどうか
-- privateMoney (Response\PrivateMoney): 設定マネー情報
-- user (Response\User): ユーザーIDなどを含むユーザー情報
+---
+成功したときは[Check](#check)オブジェクトを返します
 
-#### エンドユーザーの口座情報を表示する
+#### チャージQRコードを読み取ることでチャージする
+通常チャージQRコードはエンドユーザのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
+
+エンドユーザから受け取ったチャージ用QRコードのIDをエンドユーザIDと共に渡すことでチャージ取引が作られます。
 
 ```ruby
-response = client.send(Pokepay::Request::GetAccount.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # 口座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::AccountDetail` のオブジェクトをレスポンスとして返します。
+---
+`check_id`  
+チャージ用QRコードのIDです。
 
-- id (string): 口座ID
-- name (string): 口座名
-- isSuspended (bool): 口座が凍結されているかどうか
-- balance (double): 総残高
-- moneyBalance (double): 総マネー残高
-- pointBalance (double): 総ポイント残高
-- privateMoney (Response\PrivateMoney): 設定マネー情報
+QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
 
-#### エンドユーザーの残高内訳を表示する
+---
+`customer_id`  
+エンドユーザーIDです。
 
-エンドユーザーの残高は有効期限別のリストとして取得できます。
+送金先のエンドユーザーを指定します。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+### Customer
 
+#### 新規エンドユーザーウォレットを追加する
+指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
 ```ruby
-response = client.send(Pokepay::Request::ListAccountBalances.new(
-                         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 口座ID
-                         ))
+response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          user_name: "ポケペイ太郎",                                  // ユーザー名
+                          account_name: "ポケペイ太郎のアカウント"                          // アカウント名
+))
 ```
 
-成功したときは `Pokepay::Response::AccountBalance` を `rows` に含むページングオブジェクトを返します。  
-詳細は [ページング](#paging) を参照してください。
+---
+`private_money_id`  
+マネーIDです。
 
-`Pokepay::Response::AccountBalance` のプロパティは以下の通りです。
+これによって作成するウォレットのマネーを指定します。
 
-- expiresAt (DateTime): 失効日時
-- moneyAmount (double): マネー額
-- pointAmount (double): ポイント額
+---
+`user_name`  
+ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
 
-### Organization
+---
+`account_name`  
+作成するウォレット名です。省略した場合は空文字となります。
 
-#### 新規加盟店組織を追加する
+---
+成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
 
+#### エンドユーザーのウォレット情報を表示する
+ウォレットを取得します。
 ```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::GetAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // account_id: ウォレットID
+))
 ```
 
-成功したときには以下のプロパティを持つ `Pokepay::Response::Organization` のオブジェクトをレスポンスとして返します。
+---
+`account_id`  
+ウォレットIDです。
 
-- code (string): 組織コード
-- name (string): 組織名
+フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
 
-### Shop
-
-#### 新規店舗を追加する
+---
+成功したときは[AccountDetail](#account-detail)オブジェクトを返します
 
+#### エンドユーザーの残高内訳を表示する
+エンドユーザーの残高は有効期限別のリストとして取得できます。
 ```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::ListAccountBalances.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: ウォレットID
+                          page: 8855,                                           // ページ番号
+                          per_page: 14                                          // 1ページ分の取引数
+))
 ```
 
-成功したときは以下のプロパティを持つ `Pokepay::Response::User` のオブジェクトをレスポンスとして返します。
+---
+`account_id`  
+ウォレットIDです。
 
-- id (string): 店舗ID
-- name (string): 店舗名
-- isMerchant (bool): 店舗かどうかのフラグ (この場合は常に真)
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
 
-### Private Money
+---
+`page`  
+取得したいページ番号です。
 
-#### 決済加盟店の取引サマリを取得する
+---
+`per_page`  
+1ページ分のウォレット残高数です。
+
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
 
+### Organization
+
+#### 新規加盟店組織を追加する
 ```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",
-
-                          # ページングオプション
-                          "page"     => 1,
-                          "per_page" => 50
-                         }))
+response = $client.send(Pokepay::Request::CreateOrganization.new(
+                          "ox_supermarket",                                     // code: 新規組織コード
+                          "oxスーパー",                                             // name: 新規組織名
+                          ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],             // private_money_ids: 加盟店組織で有効にするマネーIDの配列
+                          "Rrnkhmqvwf@VE2D.com",                                // issuer_admin_user_email: 発行体担当者メールアドレス
+                          "1nKhvBTC3o@f9gR.com",                                // member_admin_user_email: 新規組織担当者メールアドレス
+                          bank_name: "XYZ銀行",                                   // 銀行名
+                          bank_code: "99X",                                     // 銀行金融機関コード
+                          bank_branch_name: "ABC支店",                            // 銀行支店名
+                          bank_branch_code: "99X",                              // 銀行支店コード
+                          bank_account_type: "saving",                          // 銀行口座種別 (普通=saving, 当座=current, その他=other)
+                          bank_account: 9999999,                                // 銀行口座番号
+                          bank_account_holder_name: "ﾌｸｻﾞﾜﾕｷﾁ",                 // 口座名義人名
+                          contact_name: "佐藤清"                                   // 担当者名
+))
 ```
+成功したときは[Organization](#organization)オブジェクトを返します
 
-成功したときは `Pokepay::Response::PrivateMoneyOrganizationSummary` を `rows` に含むページングオブジェクトを返します。  
-以下にプロパティを示します。
-
-- organizationCode (string): 組織コード
-- topup (Response::OrganizationSummary): チャージのサマリ情報
-- payment (Response::OrganizationSummary): 支払いのサマリ情報
+### Shop
 
-`Pokepay::Response::OrganizationSummary` のプロパティを以下に示します。
+#### 新規店舗を追加する
+```ruby
+response = $client.send(Pokepay::Request::CreateShop.new(
+                          "oxスーパー三田店",                                          // shop_name: 店舗名
+                          shop_postal_code: "7374764",                          // 店舗の郵便番号
+                          shop_address: "東京都港区芝...",                            // 店舗の住所
+                          shop_tel: "0550-6127",                                // 店舗の電話番号
+                          shop_email: "nrkqiF5U2g@QPDC.com",                    // 店舗のメールアドレス
+                          shop_external_id: "3BmwEo",                           // 店舗の外部ID
+                          organization_code: "ox-supermarket"                   // 組織コード
+))
+```
+成功したときは[User](#user)オブジェクトを返します
 
-- count (integer): 取引数
-- moneyAmount (double): 取引マネー総額
-- moneyCount (integer): マネー取引数
-- pointAmount (double): 取引ポイント総額
-- pointCount (integer): ポイント取引数
+### Private Money
 
-ページングについての詳細は [ページング](#paging) を参照してください。
+#### 決済加盟店の取引サマリを取得する
+```ruby
+response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          from: "2024-08-10T12:22:25.000000+09:00",             // 開始日時(toと同時に指定する必要有)
+                          to: "2024-07-28T01:26:08.000000+09:00",               // 終了日時(fromと同時に指定する必要有)
+                          page: 1,                                              // ページ番号
+                          per_page: 50                                          // 1ページ分の取引数
+))
+```
+`from`と`to`は同時に指定する必要があります。
+
+成功したときは[PaginatedPrivateMoneyOrganizationSummaries](#paginated-private-money-organization-summaries)オブジェクトを返します
+
+## 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="check"></a>
+## Check
+* `id (string)`: チャージQRコードのID
+* `amount (double)`: チャージマネー額 (deprecated)
+* `money_amount (double)`: チャージマネー額
+* `point_amount (double)`: チャージポイント額
+* `description (string)`: チャージQRコードの説明文(アプリ上で取引の説明文として表示される)
+* `user (User)`: 送金元ユーザ情報
+* `is_onetime (boolean)`: 使用回数が一回限りかどうか
+* `is_disabled (boolean)`: 無効化されているかどうか
+* `expires_at (string)`: チャージQRコード自体の失効日時
+* `private_money (PrivateMoney)`: 対象マネー情報
+* `usage_limit (integer)`: 一回限りでない場合の最大読み取り回数
+* `usage_count (double)`: 一回限りでない場合の現在までに読み取られた回数
+* `token (string)`: チャージQRコードを解析したときに出てくるURL
+
+`user`は [User](#user) オブジェクトを返します。
+
+`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+<a name="user"></a>
+## User
+* `id (string)`: ユーザー (または店舗) ID
+* `name (string)`: ユーザー (または店舗) 名
+* `is_merchant (boolean)`: 店舗ユーザーかどうか
+
+<a name="organization"></a>
+## Organization
+* `code (string)`: 組織コード
+* `name (string)`: 組織名
+
+<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="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="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-account-balance"></a>
+## PaginatedAccountBalance
+* `rows (array of AccountBalances)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [AccountBalance](#account-balance) オブジェクトの配列を返します。
+
+`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)`: 加盟店によるチャージが有効かどうか
+* `account_image (string)`: マネーの画像URL
+
+`organization`は [Organization](#organization) オブジェクトを返します。
+
+<a name="account"></a>
+## Account
+* `id (string)`: ウォレットID
+* `name (string)`: ウォレット名
+* `is_suspended (boolean)`: ウォレットが凍結されているかどうか
+* `private_money (PrivateMoney)`: 設定マネー情報
+
+`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+<a name="account-without-private-money-detail"></a>
+## AccountWithoutPrivateMoneyDetail
+* `id (string)`: 
+* `name (string)`: 
+* `is_suspended (boolean)`: 
+* `private_money_id (string)`: 
+* `user (User)`: 
+
+`user`は [User](#user) オブジェクトを返します。
+
+<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="account-balance"></a>
+## AccountBalance
+* `expires_at (string)`: 
+* `money_amount (double)`: 
+* `point_amount (double)`: