pokepay_partner_ruby_sdk 0.1.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b462bd0f2ea7bce3ec40b034bb138999de416b4618f956042d97cce6ab592ffa
-  data.tar.gz: 887c9023e4346498b6ef4cef2e0cebd125d9b28e5d19fe0ff06ad7e489eb645d
+  metadata.gz: 9db39bf7da512ddaf415d0312da429572674806d75d1a5beca492a8e10860f4b
+  data.tar.gz: 843b0548ce65832615325185665fd702b52dadcc13deadb0f0a3edbd7123d6a5
 SHA512:
-  metadata.gz: e1e978f24e716234f533e02221f9e77c6f56f892fa6be91ff998be328fcf231ba47ddad601736bd6df5c6c5a3ec28b143aeabe369dcd33601ab27eb06684c536
-  data.tar.gz: 5a722a10444c8ac32a2ed0b61408925ffc336d1367b14c2cce51c20a5b41f9d4fbcafe2042bdd16541c3184f5d15957b7cb41b85bacf226910c11f341ab67130
+  metadata.gz: 174b9e30acfcd57947de69f0860fb0def5703b4a35b6d90931760bcf604799bb6c5bd2e6d43428929a53452b88eb2736ed013d0e32646254ca7547f03906ce2e
+  data.tar.gz: ab2167de48835f66b92a3db675e768288736ad04376a76d2415b291d2146888ad6c24296ce345436a2bfa23f24da15169b7ec94bea7513452302d96122c1d07d

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    pokepay_partner_ruby_sdk (0.1.1)
+    pokepay_partner_ruby_sdk (0.1.7)
       inifile (~> 3.0.0)
-      json (~> 2.1.0)
+      json (~> 2.3.0)
       openssl (~> 2.1.2)
 
 GEM
@@ -11,11 +11,11 @@ GEM
   specs:
     inifile (3.0.0)
     ipaddr (1.2.2)
-    json (2.1.0)
-    minitest (5.11.3)
+    json (2.3.0)
+    minitest (5.14.0)
     openssl (2.1.2)
       ipaddr
-    rake (10.5.0)
+    rake (13.0.1)
 
 PLATFORMS
   ruby
@@ -24,7 +24,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   minitest (~> 5.0)
   pokepay_partner_ruby_sdk!
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -39,6 +39,20 @@ response = c.send(Pokepay::Request::CreateTransaction.new(
 
 ## Run test
 
+Add `~/.pokepay/test-config.ini`
+
+```
+CLIENT_ID        = aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
+CLIENT_SECRET    = bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
+API_BASE_URL     = https://partnerapi-dev.pokepay.jp
+SSL_KEY_FILE     = /path/to/key.pem
+SSL_CERT_FILE    = /path/to/cert.pem
+[testdata]
+shop_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+customer_id = yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
+private_money_id = zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz
+```
+
 ```
 $ bundle exec ruby test/pokepay_partner_ruby_sdk_test.rb
 ```

data/docs/index.md

@@ -1,5 +1,4 @@
 # Partner API SDK for Ruby
-
 ## Installation
 
 rubygemsからインストールすることができます。
@@ -18,8 +17,8 @@ require "pokepay_partner_ruby_sdk"
 基本的な使い方は次のようになります。
 
 - ライブラリをロード
-- 設定ファイル(後述)から Pokepay::Client オブジェクトを作る
-- リクエストオブジェクトを作り、Pokepay::Client オブジェクトのsendメソッドに対して渡す
+- 設定ファイル(後述)から `Pokepay::Client` オブジェクトを作る
+- リクエストオブジェクトを作り、`Pokepay::Client` オブジェクトの `send` メソッドに対して渡す
 - レスポンスオブジェクトを得る
 
 ```ruby
@@ -33,22 +32,22 @@ response = client.send(request)
 
 ## Settings
 
-設定はINIファイルに記述し、 Pokepay::Client のコンストラクタにファイルパスを指定します。
+設定はINIファイルに記述し、`Pokepay::Client` のコンストラクタにファイルパスを指定します。
 
-SDKプロジェクトルートに config.ini.sample というファイルがありますのでそれを元に必要な情報を記述してください。特に以下の情報は通信の安全性のため必要な項目です。これらはパートナー契約時にお渡ししているものです。
+SDKプロジェクトルートに `config.ini.sample` というファイルがありますのでそれを元に必要な情報を記述してください。特に以下の情報は通信の安全性のため必要な項目です。これらはパートナー契約時にお渡ししているものです。
 
-- CLIENT_ID: パートナーAPI クライアントID
-- CLIENT_SECRET: パートナーAPI クライアント秘密鍵
-- SSL_KEY_FILE: SSL秘密鍵ファイルパス
-- SSL_CERT_FILE: SSL証明書ファイルパス
+- `CLIENT_ID`: パートナーAPI クライアントID
+- `CLIENT_SECRET`: パートナーAPI クライアント秘密鍵
+- `SSL_KEY_FILE`: SSL秘密鍵ファイルパス
+- `SSL_CERT_FILE`: SSL証明書ファイルパス
 
 この他に接続先のサーバURL情報が必要です。
 
-- API_BASE_URL: パートナーAPI サーバURL
+- `API_BASE_URL`: パートナーAPI サーバURL
 
 また、この設定ファイルには認証に必要な情報が含まれるため、ファイルの管理・取り扱いに十分注意してください。
 
-設定ファイル記述例(config.ini.sample)
+設定ファイル記述例(`config.ini.sample`)
 
 ```
 CLIENT_ID        = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
@@ -62,9 +61,10 @@ SSL_CERT_FILE    = /path/to/cert.pem
 
 ### APIリクエスト
 
-Partner APIへの通信はリクエストオブジェクトを作り、Pokepay::Client.send メソッドに渡すことで行われます。リクエストクラスは名前空間 Pokepay::Request 以下に定義されています。
+Partner APIへの通信はリクエストオブジェクトを作り、`Pokepay::Client.send` メソッドに渡すことで行われます。  
+リクエストクラスは名前空間 `Pokepay::Request` 以下に定義されています。
 
-たとえば Pokepay::Request::SendEcho 送信した内容をそのまま返す処理です。
+たとえば `Pokepay::Request::SendEcho` は送信した内容をそのまま返す処理です。
 
 ```ruby
 request = Pokepay::Request::SendEcho.new('hello')
@@ -73,7 +73,8 @@ response = client.send(request)
 # => #<Pokepay::Response::Response 200 OK readbody=>
 ```
 
-通信の結果として、レスポンスオブジェクトが得られます。これはステータスコードとレスポンスボディ、各レスポンスクラスのオブジェクトをインスタンス変数に持つオブジェクトです。
+通信の結果として、レスポンスオブジェクトが得られます。  
+これはステータスコードとレスポンスボディ、各レスポンスクラスのオブジェクトをインスタンス変数に持つオブジェクトです。
 
 ```ruby
 response.code
@@ -89,7 +90,42 @@ response.object.message
 # => "hello"
 ```
 
-エラーの場合は Net::HTTPBadRequest などのエラーレスポンスオブジェクトが返ります。エラーレスポンスもステータスコードとレスポンスボディを持ちます。
+利用可能なAPI操作については [API Operations](#api-operations) で紹介します。
+
+<a name="paging"></a>
+### ページング
+
+API操作によっては、大量のデータがある場合に備えてページング処理があります。
+その処理では以下のようなプロパティを持つレスポンスオブジェクトを返します。
+
+- rows : 列挙するレスポンスクラスのオブジェクトの配列
+- count : 全体の要素数
+- pagination : 以下のインスタンス変数を持つオブジェクト
+  - current : 現在のページ位置(1からスタート)
+  - per_page : 1ページ当たりの要素数
+  - max_page : 最後のページ番号
+  - has_prev : 前ページを持つかどうかの真理値
+  - has_next : 次ページを持つかどうかの真理値
+
+ページングクラスは `Pokepay::Response::Pagination` で定義されています。
+
+以下にコード例を示します。
+
+```ruby
+request = Pokepay::Request::ListTransactions.new({ "page" => 1, "per_page" => 50 })
+response = client.send(request)
+
+if response.object.pagination.has_next then
+  next_page = response.object.pagination.current + 1
+  request = Pokepay::Request::ListTransactions.new({ "page" => next_page, "per_page" => 50 })
+  response = client.send(request)
+end
+```
+
+### エラーハンドリング
+
+エラーの場合は `Net::HTTPBadRequest` などのエラーレスポンスオブジェクトが返ります。  
+エラーレスポンスもステータスコードとレスポンスボディを持ちます。
 
 ```ruby
 request = Pokepay::Request::SendEcho.new(-1)
@@ -103,111 +139,1044 @@ response.code
 response.body
 # => {"type"=>"invalid_parameters", "message"=>"Invalid parameters", "errors"=>{"invalid"=>["message"]}}
 ```
-
+<a name="api-operations"></a>
 ## API Operations
 
-### 取引一覧を取得する
+### Transaction
 
+#### 取引情報を取得する
+取引を取得します。
 ```ruby
-response = client.send(Pokepay::Request::ListTransactions.new(
-                         {
-                           # ページング
-                           "page"     => 1,
-                           "per_page" => 50,
+response = $client.send(Pokepay::Request::GetTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // transaction_id: 取引ID
+))
+```
 
-                           # フィルタオプション (すべて任意)
-                           # 期間指定 (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"  => "9ff644fc......", # マネーID
-                           "is_modified"    => "true",           # キャンセルされた取引のみ検索するか
-                           # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
-                           "types"          => ["topup", "payment"],
-                         }))
+---
+`transaction_id`  
+取引IDです。
+
+フィルターとして使われ、指定した取引IDの取引を取得します。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+#### チャージする
+チャージ取引を作成します。
+```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: 8987,                                   // マネー額
+                          point_amount: 750,                                    // ポイント額
+                          description: "初夏のチャージキャンペーン"                          // 取引履歴に表示する説明文
+))
 ```
 
-成功したときは Pokepay::Response::Transaction を rows に含むページングオブジェクトを返します。
-取引一覧のような大量のレスポンスが返るエンドポイントでは、一度に取得する量を制限するためにページングされています。
+---
+`shop_id`  
+店舗IDです。
 
-#### 取引情報
+送金元の店舗を指定します。
 
-取引クラスは Pokepay::Response::Transaction で定義されています。
+---
+`customer_id`  
+エンドユーザーIDです。
 
-取引オブジェクトのプロパティは以下のようになっています。
+送金先のエンドユーザーを指定します。
 
-- id (String): 取引ID
-- type (String): 取引種別 (チャージ=topup, 支払い=payment)
-- is_modified (真理値): 返金された取引かどうか
-- sender (Response\User): 送金者情報
-- receiver (Response\User): 受取者情報
-- sender_account (Response\Account): 送金口座情報
-- receiver_account (Response\Account): 受取口座情報
-- amount (Numeric): 決済総額 (マネー額 + ポイント額)
-- money_amount (Numeric): 決済マネー額
-- point_amount (Numeric): 決済ポイント額
-- done_at (Time): 取引日時
-- description (String): 取引説明文
+---
+`private_money_id`  
+マネーIDです。
 
-`sender` と `receiver` には `Pokepay::Response::User` のオブジェクトです。 以下にプロパティを示します。
+マネーを指定します。
 
-- id (String): ユーザー (または店舗) ID
-- name (String): ユーザー (または店舗) 名
-- is_merchant (真理値): 店舗ユーザーかどうか
+---
+`bear_point_shop_id`  
+ポイント支払時の負担店舗IDです。
 
-`senderAccount` と `receiverAccount` は `Pokepay::Response::Account` のオブジェクトです。以下にプロパティを示します。
+ポイント支払い時に実際お金を負担する店舗を指定します。
 
-- id (String): 口座ID
-- name (String): 口座名
-- is_suspended (真理値): 口座が凍結されているかどうか
-- private_money (Response\PrivateMoney): 設定マネー情報
+---
+`money_amount`  
+マネー額です。
 
-`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)
+---
+`point_amount`  
+ポイント額です。
 
-#### ページング
+送金するポイント額を指定します。
 
-ページングクラスは Pokepay::Response::Pagination で定義されています。
+---
+`description`  
+取引説明文です。
 
-ページングオブジェクトのプロパティは以下のようになっています。
+任意入力で、取引履歴に表示される説明文です。
 
-- rows : 列挙するレスポンスクラスのオブジェクトの配列
-- count : 全体の要素数
-- pagination : 以下のインスタンス変数を持つオブジェクト
-  - current : 現在のページ位置(1からスタート)
-  - per_page : 1ページ当たりの要素数
-  - max_page : 最後のページ番号
-  - has_prev : 前ページを持つかどうかの真理値
-  - has_next : 次ページを持つかどうかの真理値
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+#### 支払いする
+支払取引を作成します。
+支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
+
+```ruby
+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
+                          8123,                                                 // amount: 支払い額
+                          description: "たい焼き(小倉)"                               // 取引履歴に表示する説明文
+))
+```
+
+---
+`shop_id`  
+店舗IDです。
+
+送金先の店舗を指定します。
+
+---
+`customer_id`  
+エンドユーザーIDです。
+
+送金元のエンドユーザーを指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
+
+---
+`amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+#### 個人間送金
+エンドユーザー間での送金取引(個人間送金)を作成します。
+個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
+
+```ruby
+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
+                          7070,                                                 // amount: 送金額
+                          description: "たい焼き(小倉)"                               // 取引履歴に表示する説明文
+))
+```
+
+---
+`sender_id`  
+エンドユーザーIDです。
+
+送金元のエンドユーザー(送り主)を指定します。
+
+---
+`receiver_id`  
+エンドユーザーIDです。
+
+送金先のエンドユーザー(受け取り人)を指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
+
+---
+`amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+#### 取引履歴を取得する
+取引一覧を返します。
+```ruby
+response = $client.send(Pokepay::Request::ListTransactions.new(
+                          from: "2016-11-19T02:36:58.000000+09:00",             // 開始日時
+                          to: "2021-03-05T00:00:07.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
+))
+```
+
+---
+`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::RefundTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // transaction_id: 取引ID
+                          description: "返品対応のため"                                // 取引履歴に表示する返金事由
+))
+```
+成功したときは[Transfer](#transfer)オブジェクトを返します
+
+### チャージQRコード
+
+店舗ユーザが発行し、エンドユーザがポケペイアプリから読み取ることでチャージ取引が発生する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::CreateCheck.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: 送金元の店舗アカウントID
+                          money_amount: 8455,                                   // 付与マネー額
+                          point_amount: 6119,                                   // 付与ポイント額
+                          description: "test check",                            // 説明文(アプリ上で取引の説明文として表示される)
+                          is_onetime: true,                                     // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
+                          usage_limit: 4746,                                    // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
+                          expires_at: "2018-04-09T08:22:29.000000+09:00",       // チャージQR自体の失効日時
+                          point_expires_at: "2016-10-24T09:19:20.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コードは管理画面からいつでも無効化(有効化)することができます。
+
+
+---
+成功したときは[Check](#check)オブジェクトを返します
+
+#### チャージQRコードを読み取ることでチャージする
+通常チャージQRコードはエンドユーザのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
+
+エンドユーザから受け取ったチャージ用QRコードのIDをエンドユーザIDと共に渡すことでチャージ取引が作られます。
+
+```ruby
+response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // check_id: チャージ用QRコードのID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // customer_id: エンドユーザーのID
+))
+```
+
+---
+`check_id`  
+チャージ用QRコードのIDです。
+
+QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
+
+---
+`customer_id`  
+エンドユーザーIDです。
+
+送金先のエンドユーザーを指定します。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+### 支払いQRコード
+
+#### 支払いQRコード一覧を表示する
+支払いQRコード一覧を表示します。
+```ruby
+response = $client.send(Pokepay::Request::ListBills.new(
+                          page: 9486,                                           // ページ番号
+                          per_page: 5839,                                       // 1ページの表示数
+                          bill_id: "1Ez",                                       // 支払いQRコードのID
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
+                          organization_code: "1rDRdnXy6PY122A---0nzUq-g",       // 組織コード
+                          description: "test bill",                             // 取引説明文
+                          created_from: "2017-11-03T07:17:36.000000+09:00",     // 作成日時(起点)
+                          created_to: "2016-02-19T04:37:01.000000+09:00",       // 作成日時(終点)
+                          shop_name: "bill test shop1",                         // 店舗名
+                          shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",      // 店舗ID
+                          lower_limit_amount: 8463,                             // 金額の範囲によるフィルタ(下限)
+                          upper_limit_amount: 3110,                             // 金額の範囲によるフィルタ(上限)
+                          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でフィルターします。
+
+---
+`lower_limit_amount`  
+支払いQRコードの金額の下限を指定してフィルターします。
+
+---
+`upper_limit_amount`  
+支払いQRコードの金額の上限を指定してフィルターします。
+
+---
+`is_disabled`  
+支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
 
-### チャージする
+---
+成功したときは[PaginatedBills](#paginated-bills)オブジェクトを返します
 
+#### 支払いQRコードの発行
+支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
 ```ruby
-shop_id          = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # 店舗ID
-customer_id      = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" # エンドユーザーのID
-private_money_id = "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz" # 送るマネーのID
-money_amount     = 1000                                   # チャージマネー額
-point_amount     = 0                                      # チャージするポイント額
-description      = "初夏のチャージキャンペーン"           # 取引履歴に表示する説明文
+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: 9236,                                         // 支払い額
+                          description: "test bill"                              // 説明文(アプリ上で取引の説明文として表示される)
+))
+```
+
+---
+`amount`  
+支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+---
+成功したときは[Bill](#bill)オブジェクトを返します
+
+#### 支払いQRコードの更新
+支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
+```ruby
+response = $client.send(Pokepay::Request::UpdateBill.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // bill_id: 支払いQRコードのID
+                          amount: 1515,                                         // 支払い額
+                          description: "test bill",                             // 説明文
+                          is_disabled: true                                     // 無効化されているかどうか
+))
+```
+
+---
+`bill_id`  
+更新対象の支払いQRコードのIDです。
+
+---
+`amount`  
+支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+---
+`description`  
+支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
+
+---
+`is_disabled`  
+支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
+
+---
+成功したときは[Bill](#bill)オブジェクトを返します
+
+### Customer
+
+#### 新規エンドユーザーウォレットを追加する
+指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
+```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)オブジェクトを返します
+
+#### ウォレット情報を表示する
+ウォレットを取得します。
+```ruby
+response = $client.send(Pokepay::Request::GetAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // account_id: ウォレットID
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
+
+---
+成功したときは[AccountDetail](#account-detail)オブジェクトを返します
+
+#### エンドユーザーの残高内訳を表示する
+エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListAccountBalances.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: ウォレットID
+                          page: 2589,                                           // ページ番号
+                          per_page: 6451,                                       // 1ページ分の取引数
+                          expires_at_from: "2024-03-14T23:56:23.000000+09:00",  // 有効期限の期間によるフィルター(開始時点)
+                          expires_at_to: "2019-10-04T17:19:48.000000+09:00",    // 有効期限の期間によるフィルター(終了時点)
+                          direction: "asc"                                      // 有効期限によるソート順序
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
+
+---
+`page`  
+取得したいページ番号です。デフォルト値は1です。
+
+---
+`per_page`  
+1ページ分のウォレット残高数です。デフォルト値は30です。
+
+---
+`expires_at_from`  
+有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`expires_at_to`  
+有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`direction`  
+有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
 
-response = $client.send(Pokepay::Request::CreateTransaction.new(
-                          shop_id, customer_id, private_money_id,
-                          money_amount, point_amount, description))
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
+
+#### エンドユーザーの失効済みの残高内訳を表示する
+エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: ウォレットID
+                          page: 6958,                                           // ページ番号
+                          per_page: 2994,                                       // 1ページ分の取引数
+                          expires_at_from: "2016-02-15T00:43:30.000000+09:00",  // 有効期限の期間によるフィルター(開始時点)
+                          expires_at_to: "2016-06-15T15:33:00.000000+09:00",    // 有効期限の期間によるフィルター(終了時点)
+                          direction: "asc"                                      // 有効期限によるソート順序
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
+
+---
+`page`  
+取得したいページ番号です。デフォルト値は1です。
+
+---
+`per_page`  
+1ページ分のウォレット残高数です。デフォルト値は30です。
+
+---
+`expires_at_from`  
+有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`expires_at_to`  
+有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`direction`  
+有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
+
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
+
+#### 取引履歴を取得する
+取引一覧を返します。
+```ruby
+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: "FjJy7",                                        // 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
+                          is_modified: true,                                    // キャンセル済みかどうか
+                          from: "2019-01-09T15:47:03.000000+09:00",             // 開始日時
+                          to: "2025-02-14T22:55:32.000000+09:00",               // 終了日時
+                          page: 1,                                              // ページ番号
+                          per_page: 50                                          // 1ページ分の取引数
+))
+```
+
+---
+`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`  
+抽出期間の終了日時です。
+
+フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
+
+### Organization
+
+#### 新規加盟店組織を追加する
+```ruby
+response = $client.send(Pokepay::Request::CreateOrganization.new(
+                          "ox_supermarket",                                     // code: 新規組織コード
+                          "oxスーパー",                                             // name: 新規組織名
+                          ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], // private_money_ids: 加盟店組織で有効にするマネーIDの配列
+                          "Kkoz4u4vqN@tkYj.com",                                // issuer_admin_user_email: 発行体担当者メールアドレス
+                          "PXUyJ1V0r5@CHRN.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)オブジェクトを返します
+
+### Shop
+
+#### 新規店舗を追加する
+```ruby
+response = $client.send(Pokepay::Request::CreateShop.new(
+                          "oxスーパー三田店",                                          // shop_name: 店舗名
+                          shop_postal_code: "422-5364",                         // 店舗の郵便番号
+                          shop_address: "東京都港区芝...",                            // 店舗の住所
+                          shop_tel: "083-33-947",                               // 店舗の電話番号
+                          shop_email: "pSCBGnb27K@I1Ko.com",                    // 店舗のメールアドレス
+                          shop_external_id: "9Ro9P2UOPHKc",                     // 店舗の外部ID
+                          organization_code: "ox-supermarket"                   // 組織コード
+))
+```
+成功したときは[User](#user)オブジェクトを返します
+
+#### 店舗一覧を取得する
+```ruby
+response = $client.send(Pokepay::Request::ListShops.new(
+                          organization_code: "pocketchange",                    // 組織コード
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
+                          page: 1,                                              // ページ番号
+                          per_page: 50                                          // 1ページ分の取引数
+))
+```
+
+---
+`organization_code`  
+このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
+
+
+---
+`private_money_id`  
+このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
+
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
+
+### Account
+
+#### エンドユーザー、店舗ユーザーのウォレット一覧を表示する
+ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListUserAccounts.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // user_id: ユーザーID
+))
+```
+
+---
+`user_id`  
+ユーザーIDです。
+
+指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
+
+---
+成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
+
+### Private Money
+
+#### 決済加盟店の取引サマリを取得する
+```ruby
+response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          from: "2020-03-02T19:54:29.000000+09:00",             // 開始日時(toと同時に指定する必要有)
+                          to: "2024-10-09T07:46:14.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="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)`: 
+
+`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
+
+<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-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="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)`: 
 
-成功したときは Pokepay::Response::Transaction を持つレスポンスオブジェクトを返します。
+<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