pokepay_partner_ruby_sdk 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 015dc3b92d9ad253a74ec83550047f20afdf6d99e3820dc313ee15a8e8e1bed5
-  data.tar.gz: 189c9ff489aa5093c5014e0d4fdb85693b3755b72b98274a06814a38efd4a037
+  metadata.gz: 1fd61e182a33f59658adeb782593d28971cc70072d3d434b8880ba51d1348e81
+  data.tar.gz: 26dae7ac67ff5e10e2ab44f7e1fe2c03efcf30616e2cab5cb755b6bf757518fc
 SHA512:
-  metadata.gz: 2f0a69b091a89ff1f71588ccb778c0433a80794b7565460106ce549204f540ccf70eeb0b99ddd1e8b51d4c05c5f8cd7db123a1417908a63ec07d2c667c1f5fd6
-  data.tar.gz: c35badfaf92b55ff5d4255e213d44dceb2ae2a3f4d5782b33f76759ff8ad0434267698f5a2b433d4f0f42c22898004e2d95e25c008770e0f964210b7cc64b5f1
+  metadata.gz: 5e2b87c098a019491ffac0b7744d672747cbc0a6a1756e4d7b6ce61da8dc765e4d05b61522eb206a27618c0bf793a7c7c89f03aa1e761e0dde503f5b6e999926
+  data.tar.gz: d8fd52165e868d36d33de7e96637cd02d30fb99107ca74b1b8964c2780bf16cee298c2af817cd1983a6a149e932495a4c17a72261ce12c7b73e6e8d37b42a58d

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    pokepay_partner_ruby_sdk (0.1.0)
+    pokepay_partner_ruby_sdk (0.1.6)
       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/config.ini.sample

@@ -1,5 +1,5 @@
 CLIENT_ID        = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 CLIENT_SECRET    = yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
-API_BASE_URL     = https://partnerapi-dev.pokepay.jp
+API_BASE_URL     = https://partnerapi-sandbox.pokepay.jp
 SSL_KEY_FILE     = /path/to/key.pem
 SSL_CERT_FILE    = /path/to/cert.pem

data/docs/index.md

@@ -1,29 +1,765 @@
-# Installation
+# Partner API SDK for Ruby
+## Installation
 
+rubygemsからインストールすることができます。
 ```
-$ bundle exec rake install
+$ gem install pokepay_partner_ruby_sdk
 ```
 
-# Settings
+ロードパスの通ったところにライブラリが配置されていれば、以下のようにロードできます。
 
-# Getting Started
+```ruby
+require "pokepay_partner_ruby_sdk"
+```
+
+## Getting started
+
+基本的な使い方は次のようになります。
+
+- ライブラリをロード
+- 設定ファイル(後述)から `Pokepay::Client` オブジェクトを作る
+- リクエストオブジェクトを作り、`Pokepay::Client` オブジェクトの `send` メソッドに対して渡す
+- レスポンスオブジェクトを得る
 
 ```ruby
 require "pokepay_partner_ruby_sdk"
-c = Pokepay::Client.new("/path/to/config.ini")
-res = c.send(Pokepay::Request::SendEcho.new('hello'))
-res = c.send(Pokepay::Request::ListTransactions.new({'per_page'=>1}))
-res = c.send(Pokepay::Request::CreateTransaction.new(
-               "8b9fbece-73fa-494d-bad5-c7fd9e52f9a0",
-               "78e56df5-dd71-4554-86e5-b0eb8d3781cb",
-               "4b138a4c-8944-4f98-a5c4-96d3c1c415eb",
-               100,
-               200,
-               "チャージテスト"))
+client = Pokepay::Client.new("/path/to/config.ini")
+request = Pokepay::Request::SendEcho.new('hello')
+response = client.send(request)
 ```
 
-# Run test
+レスポンスオブジェクト内にステータスコード、JSONをパースしたハッシュマップ、さらにレスポンス内容のオブジェクトが含まれています。
+
+## Settings
+
+設定はINIファイルに記述し、`Pokepay::Client` のコンストラクタにファイルパスを指定します。
+
+SDKプロジェクトルートに `config.ini.sample` というファイルがありますのでそれを元に必要な情報を記述してください。特に以下の情報は通信の安全性のため必要な項目です。これらはパートナー契約時にお渡ししているものです。
+
+- `CLIENT_ID`: パートナーAPI クライアントID
+- `CLIENT_SECRET`: パートナーAPI クライアント秘密鍵
+- `SSL_KEY_FILE`: SSL秘密鍵ファイルパス
+- `SSL_CERT_FILE`: SSL証明書ファイルパス
+
+この他に接続先のサーバURL情報が必要です。
+
+- `API_BASE_URL`: パートナーAPI サーバURL
+
+また、この設定ファイルには認証に必要な情報が含まれるため、ファイルの管理・取り扱いに十分注意してください。
+
+設定ファイル記述例(`config.ini.sample`)
 
 ```
-$ bundle exec ruby test/pokepay_partner_ruby_sdk_test.rb
+CLIENT_ID        = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+CLIENT_SECRET    = yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+API_BASE_URL     = https://partnerapi-sandbox.pokepay.jp
+SSL_KEY_FILE     = /path/to/key.pem
+SSL_CERT_FILE    = /path/to/cert.pem
 ```
+
+## Overview
+
+### APIリクエスト
+
+Partner APIへの通信はリクエストオブジェクトを作り、`Pokepay::Client.send` メソッドに渡すことで行われます。  
+リクエストクラスは名前空間 `Pokepay::Request` 以下に定義されています。
+
+たとえば `Pokepay::Request::SendEcho` は送信した内容をそのまま返す処理です。
+
+```ruby
+request = Pokepay::Request::SendEcho.new('hello')
+
+response = client.send(request)
+# => #<Pokepay::Response::Response 200 OK readbody=>
+```
+
+通信の結果として、レスポンスオブジェクトが得られます。  
+これはステータスコードとレスポンスボディ、各レスポンスクラスのオブジェクトをインスタンス変数に持つオブジェクトです。
+
+```ruby
+response.code
+# => 200
+
+response.body
+# => {"status"=>"ok", "message"=>"hello"}
+
+response.object
+# => #<Pokepay::Response::Echo:0x000055fd7cc0db20 @message="hello">
+
+response.object.message
+# => "hello"
+```
+
+利用可能な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)
+
+response = client.send(request)
+# => #<Net::HTTPBadRequest 400 Bad Request readbody=true>
+
+response.code
+# => 400
+
+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::GetTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // transaction_id: 取引ID
+))
+```
+
+---
+`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: 3515,                                   // マネー額
+                          point_amount: 7853,                                   // ポイント額
+                          description: "初夏のチャージキャンペーン"                          // 取引履歴に表示する説明文
+))
+```
+
+---
+`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",               // shop_id: 店舗ID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // customer_id: エンドユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          4119,                                                 // amount: 支払い額
+                          description: "たい焼き(小倉)"                               // 取引履歴に表示する説明文
+))
+```
+
+---
+`shop_id`  
+店舗IDです。
+
+送金先の店舗を指定します。
+
+---
+`customer_id`  
+エンドユーザーIDです。
+
+送金元のエンドユーザーを指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
+
+---
+`amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
+#### 取引履歴を取得する
+取引一覧を返します。
+```ruby
+response = $client.send(Pokepay::Request::ListTransactions.new(
+                          from: "2024-03-14T02:41:24.000000+09:00",             // 開始日時
+                          to: "2019-04-09T15:58:53.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: 9919,                                   // 付与マネー額
+                          point_amount: 2608,                                   // 付与ポイント額
+                          description: "test check",                            // 説明文(アプリ上で取引の説明文として表示される)
+                          is_onetime: false,                                    // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
+                          usage_limit: 8625,                                    // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
+                          expires_at: "2022-02-18T00:32:55.000000+09:00",       // チャージQR自体の失効日時
+                          point_expires_at: "2017-12-02T22:53:00.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)オブジェクトを返します
+
+### 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: 7956,                                           // ページ番号
+                          per_page: 4513                                        // 1ページ分の取引数
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分のウォレット残高数です。
+
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
+
+### Organization
+
+#### 新規加盟店組織を追加する
+```ruby
+response = $client.send(Pokepay::Request::CreateOrganization.new(
+                          "ox_supermarket",                                     // code: 新規組織コード
+                          "oxスーパー",                                             // name: 新規組織名
+                          ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],             // private_money_ids: 加盟店組織で有効にするマネーIDの配列
+                          "1qSYlEPOrX@96su.com",                                // issuer_admin_user_email: 発行体担当者メールアドレス
+                          "Y89xlB3mgj@Y6Ph.com",                                // member_admin_user_email: 新規組織担当者メールアドレス
+                          bank_name: "XYZ銀行",                                   // 銀行名
+                          bank_code: "99X",                                     // 銀行金融機関コード
+                          bank_branch_name: "ABC支店",                            // 銀行支店名
+                          bank_branch_code: "99X",                              // 銀行支店コード
+                          bank_account_type: "current",                         // 銀行口座種別 (普通=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: "652-4859",                         // 店舗の郵便番号
+                          shop_address: "東京都港区芝...",                            // 店舗の住所
+                          shop_tel: "096-99-5223",                              // 店舗の電話番号
+                          shop_email: "0ktWQ723w2@IG1J.com",                    // 店舗のメールアドレス
+                          shop_external_id: "lBzqgWY2glpsEhUQhgL9hEwO7oPQpA",   // 店舗の外部ID
+                          organization_code: "ox-supermarket"                   // 組織コード
+))
+```
+成功したときは[User](#user)オブジェクトを返します
+
+### Private Money
+
+#### 決済加盟店の取引サマリを取得する
+```ruby
+response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          from: "2017-05-21T20:37:05.000000+09:00",             // 開始日時(toと同時に指定する必要有)
+                          to: "2018-07-11T00:21:30.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)`: