pokepay_partner_ruby_sdk 0.1.8 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/docs/index.md +701 -311
  4. data/lib/pokepay_partner_ruby_sdk.rb +15 -0
  5. data/lib/pokepay_partner_ruby_sdk/request/cancel_cashtray.rb +15 -0
  6. data/lib/pokepay_partner_ruby_sdk/request/create_cashtray.rb +17 -0
  7. data/lib/pokepay_partner_ruby_sdk/request/create_shop_v.rb +15 -0
  8. data/lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb +15 -0
  9. data/lib/pokepay_partner_ruby_sdk/request/get_cashtray.rb +15 -0
  10. data/lib/pokepay_partner_ruby_sdk/request/get_private_moneys.rb +15 -0
  11. data/lib/pokepay_partner_ruby_sdk/request/get_shop.rb +15 -0
  12. data/lib/pokepay_partner_ruby_sdk/request/update_cashtray.rb +15 -0
  13. data/lib/pokepay_partner_ruby_sdk/request/update_shop.rb +15 -0
  14. data/lib/pokepay_partner_ruby_sdk/response/bulk_transaction.rb +6 -0
  15. data/lib/pokepay_partner_ruby_sdk/response/cashtray.rb +24 -0
  16. data/lib/pokepay_partner_ruby_sdk/response/cashtray_attempt.rb +20 -0
  17. data/lib/pokepay_partner_ruby_sdk/response/cashtray_with_result.rb +30 -0
  18. data/lib/pokepay_partner_ruby_sdk/response/paginated_private_moneys.rb +16 -0
  19. data/lib/pokepay_partner_ruby_sdk/response/private_money.rb +0 -2
  20. data/lib/pokepay_partner_ruby_sdk/response/shop_account.rb +20 -0
  21. data/lib/pokepay_partner_ruby_sdk/response/shop_with_accounts.rb +27 -0
  22. data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
  23. data/partner.yaml +894 -53
  24. metadata +20 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4820f2638f0bc46dd7d401e8d0d488ee8ebe763f0e1664cc872113ff1a9e45a8
4
- data.tar.gz: 7fe61418ef2c499d79a261b02209924579d1f16bbf224a2cfd7775d6291ed465
3
+ metadata.gz: b31b44c25482290e71f6ddb114c700f2502dd19bae3a6f4c7a0dbf125f034af7
4
+ data.tar.gz: d37c5c6a38ef8e22ff542ef38402924ef1614c8231ff4b1b5410a55e727a600e
5
5
  SHA512:
6
- metadata.gz: b2e5b0bd0c12fd7ab88b51e328cb39a3eff5d3c35c443f336affae2e9591567dc261335f5683f467b8b550b049662d9aa0b8aa7e45185561d138f71258cb8d0b
7
- data.tar.gz: a66eb0bfe7ffbc70b581d3f10cce063dc67ce594846d4a1ce541e2c367a2f0643fef79cc769831e8a7afe2b69f6645a068a0d2d55c5cfd6331fbf9939034b445
6
+ metadata.gz: 135694919952fad3d174fd466f20350d8411c615b691368b30e01820bc25be8054597f247ba12b5fa08a6c6a003102e75ba03fb95c06b6843ec88e8465701be8
7
+ data.tar.gz: a4492393069d894ac2a35d9a77056376c401db1dc206e29bff3322b04b0706d0e5912b1864514b1247b89ede94c543a4cd32dcce600170ccee7a17437f0ea077
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- pokepay_partner_ruby_sdk (0.1.8)
4
+ pokepay_partner_ruby_sdk (0.1.9)
5
5
  inifile (~> 3.0.0)
6
6
  json (~> 2.3.0)
7
7
  openssl (~> 2.1.2)
@@ -11,7 +11,7 @@ GEM
11
11
  specs:
12
12
  inifile (3.0.0)
13
13
  ipaddr (1.2.2)
14
- json (2.3.0)
14
+ json (2.3.1)
15
15
  minitest (5.14.0)
16
16
  openssl (2.1.2)
17
17
  ipaddr
data/docs/index.md CHANGED
@@ -142,25 +142,171 @@ response.body
142
142
  <a name="api-operations"></a>
143
143
  ## API Operations
144
144
 
145
+ - [ListTransactions](#list-transactions): 取引履歴を取得する
146
+ - [CreateTransaction](#create-transaction): チャージする(廃止予定)
147
+ - [CreateTopupTransaction](#create-topup-transaction): チャージする
148
+ - [CreatePaymentTransaction](#create-payment-transaction): 支払いする
149
+ - [CreateTransferTransaction](#create-transfer-transaction): 個人間送金
150
+ - [CreateExchangeTransaction](#create-exchange-transaction):
151
+ - [GetTransaction](#get-transaction): 取引情報を取得する
152
+ - [ListTransfers](#list-transfers):
153
+ - [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
154
+ - [ListBills](#list-bills): 支払いQRコード一覧を表示する
155
+ - [CreateBill](#create-bill): 支払いQRコードの発行
156
+ - [UpdateBill](#update-bill): 支払いQRコードの更新
157
+ - [CreateCashtray](#create-cashtray): Cashtrayを作る
158
+ - [GetCashtray](#get-cashtray): Cashtrayの情報を取得する
159
+ - [CancelCashtray](#cancel-cashtray): Cashtrayを無効化する
160
+ - [UpdateCashtray](#update-cashtray): Cashtrayの情報を更新する
161
+ - [GetAccount](#get-account): ウォレット情報を表示する
162
+ - [UpdateAccount](#update-account): ウォレット情報を更新する
163
+ - [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
164
+ - [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
165
+ - [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーウォレットを追加する
166
+ - [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
167
+ - [ListShops](#list-shops): 店舗一覧を取得する
168
+ - [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
169
+ - [CreateShopV2](#create-shop-v): 新規店舗を追加する
170
+ - [GetShop](#get-shop): 店舗情報を表示する
171
+ - [UpdateShop](#update-shop): 店舗情報を更新する
172
+ - [ListUserAccounts](#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
173
+ - [GetPrivateMoneys](#get-private-moneys): マネー一覧を取得する
174
+ - [GetPrivateMoneyOrganizationSummaries](#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
175
+ - [BulkCreateTransaction](#bulk-create-transaction): CSVファイル一括取引
145
176
  ### Transaction
146
-
147
- #### 取引情報を取得する
148
- 取引を取得します。
177
+ <a name="list-transactions"></a>
178
+ #### 取引履歴を取得する
179
+ 取引一覧を返します。
149
180
  ```ruby
150
- response = $client.send(Pokepay::Request::GetTransaction.new(
151
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # transaction_id: 取引ID
181
+ response = $client.send(Pokepay::Request::ListTransactions.new(
182
+ from: "2018-02-24T20:24:55.000000+09:00", # 開始日時
183
+ to: "2020-10-22T04:47:28.000000+09:00", # 終了日時
184
+ page: 1, # ページ番号
185
+ per_page: 50, # 1ページ分の取引数
186
+ shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
187
+ customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
188
+ customer_name: "太郎", # エンドユーザー名
189
+ terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
190
+ transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
191
+ organization_code: "pocketchange", # 組織コード
192
+ private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
193
+ is_modified: true, # キャンセルフラグ
194
+ types: ["topup", "payment"] # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
152
195
  ))
153
196
  ```
154
197
 
198
+ ---
199
+ `from`
200
+ 抽出期間の開始日時です。
201
+
202
+ フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
203
+
204
+ ---
205
+ `to`
206
+ 抽出期間の終了日時です。
207
+
208
+ フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
209
+
210
+ ---
211
+ `page`
212
+ 取得したいページ番号です。
213
+
214
+ ---
215
+ `per_page`
216
+ 1ページ分の取引数です。
217
+
218
+ ---
219
+ `shop_id`
220
+ 店舗IDです。
221
+
222
+ フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
223
+
224
+ ---
225
+ `customer_id`
226
+ エンドユーザーIDです。
227
+
228
+ フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
229
+
230
+ ---
231
+ `customer_name`
232
+ エンドユーザー名です。
233
+
234
+ フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
235
+
236
+ ---
237
+ `terminal_id`
238
+ 端末IDです。
239
+
240
+ フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
241
+
155
242
  ---
156
243
  `transaction_id`
157
244
  取引IDです。
158
245
 
159
- フィルターとして使われ、指定した取引IDの取引を取得します。
246
+ フィルターとして使われ、指定された取引のみ一覧に表示されます。
160
247
 
161
248
  ---
162
- 成功したときは[Transaction](#transaction)オブジェクトを返します
249
+ `organization_code`
250
+ 組織コードです。
251
+
252
+ フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
253
+
254
+ ---
255
+ `private_money_id`
256
+ マネーIDです。
257
+
258
+ フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
259
+
260
+ ---
261
+ `is_modified`
262
+ キャンセルフラグです。
163
263
 
264
+ これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
265
+ デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
266
+
267
+ ---
268
+ `types`
269
+ 取引の種類でフィルターします。
270
+
271
+ 以下の種類を指定できます。
272
+
273
+ 1. topup
274
+ 店舗からエンドユーザーへの送金取引(チャージ)
275
+
276
+ 2. payment
277
+ エンドユーザーから店舗への送金取引(支払い)
278
+
279
+ 3. exchange-outflow
280
+ 　　他マネーへの流出
281
+
282
+ 4. exchange-inflow
283
+ 他マネーからの流入
284
+
285
+ ---
286
+ 成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
287
+ <a name="create-transaction"></a>
288
+ #### チャージする(廃止予定)
289
+ チャージ取引を作成します。このAPIは廃止予定です。以降は `CreateTopupTransaction` を使用してください。
290
+ ```ruby
291
+ response = $client.send(Pokepay::Request::CreateTransaction.new(
292
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
293
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
294
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
295
+ money_amount: 313,
296
+ point_amount: 3912,
297
+ point_expires_at: "2023-04-30T21:00:37.000000+09:00", # ポイント有効期限
298
+ description: "S"
299
+ ))
300
+ ```
301
+
302
+ ---
303
+ `point_expires_at`
304
+ ポイントをチャージした場合の、付与されるポイントの有効期限です。
305
+ 省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
306
+
307
+ ---
308
+ 成功したときは[Transaction](#transaction)オブジェクトを返します
309
+ <a name="create-topup-transaction"></a>
164
310
  #### チャージする
165
311
  チャージ取引を作成します。
166
312
  ```ruby
@@ -169,8 +315,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
169
315
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
170
316
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
171
317
  bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
172
- money_amount: 9829, # マネー額
173
- point_amount: 3839, # ポイント額
318
+ money_amount: 5960, # マネー額
319
+ point_amount: 6566, # ポイント額
320
+ point_expires_at: "2020-06-09T20:49:01.000000+09:00", # ポイント有効期限
174
321
  description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
175
322
  ))
176
323
  ```
@@ -211,6 +358,11 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
211
358
 
212
359
  送金するポイント額を指定します。
213
360
 
361
+ ---
362
+ `point_expires_at`
363
+ ポイントをチャージした場合の、付与されるポイントの有効期限です。
364
+ 省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
365
+
214
366
  ---
215
367
  `description`
216
368
  取引説明文です。
@@ -219,7 +371,7 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
219
371
 
220
372
  ---
221
373
  成功したときは[Transaction](#transaction)オブジェクトを返します
222
-
374
+ <a name="create-payment-transaction"></a>
223
375
  #### 支払いする
224
376
  支払取引を作成します。
225
377
  支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
@@ -229,7 +381,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
229
381
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
230
382
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
231
383
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
232
- 9578, # amount: 支払い額
384
+ 5274, # amount: 支払い額
233
385
  description: "たい焼き(小倉)" # 取引履歴に表示する説明文
234
386
  ))
235
387
  ```
@@ -266,7 +418,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
266
418
 
267
419
  ---
268
420
  成功したときは[Transaction](#transaction)オブジェクトを返します
269
-
421
+ <a name="create-transfer-transaction"></a>
270
422
  #### 個人間送金
271
423
  エンドユーザー間での送金取引(個人間送金)を作成します。
272
424
  個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
@@ -276,7 +428,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
276
428
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
277
429
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
278
430
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
279
- 2298, # amount: 送金額
431
+ 9429, # amount: 送金額
280
432
  description: "たい焼き(小倉)" # 取引履歴に表示する説明文
281
433
  ))
282
434
  ```
@@ -313,129 +465,57 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
313
465
 
314
466
  ---
315
467
  成功したときは[Transaction](#transaction)オブジェクトを返します
316
-
317
- #### 取引履歴を取得する
318
- 取引一覧を返します。
468
+ <a name="create-exchange-transaction"></a>
469
+ ####
319
470
  ```ruby
320
- response = $client.send(Pokepay::Request::ListTransactions.new(
321
- from: "2022-12-14T10:46:43.000000+09:00", # 開始日時
322
- to: "2024-01-27T16:51:48.000000+09:00", # 終了日時
323
- page: 1, # ページ番号
324
- per_page: 50, # 1ページ分の取引数
325
- shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
326
- customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
327
- customer_name: "太郎", # エンドユーザー名
328
- terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
329
- transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
330
- organization_code: "pocketchange", # 組織コード
331
- private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
332
- is_modified: true, # キャンセルフラグ
333
- types: ["topup", "payment"] # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
471
+ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
472
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
473
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
474
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
475
+ 3501,
476
+ description: "ruJxi1ST1WXtfeKSzrq1Zc5Ju53UYOCwl5C8rEq5yNfh8NoRe5rX0rVCmpqdlLHNNlbdnW1ooZFRDSiyltrhPzNi7jenj4X3xdXKxR7POl5XLEB6rdcoyFq3Dy2RXyPUA"
477
+ ))
478
+ ```
479
+ 成功したときは[Transaction](#transaction)オブジェクトを返します
480
+ <a name="get-transaction"></a>
481
+ #### 取引情報を取得する
482
+ 取引を取得します。
483
+ ```ruby
484
+ response = $client.send(Pokepay::Request::GetTransaction.new(
485
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # transaction_id: 取引ID
334
486
  ))
335
487
  ```
336
-
337
- ---
338
- `from`
339
- 抽出期間の開始日時です。
340
-
341
- フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
342
-
343
- ---
344
- `to`
345
- 抽出期間の終了日時です。
346
-
347
- フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
348
-
349
- ---
350
- `page`
351
- 取得したいページ番号です。
352
-
353
- ---
354
- `per_page`
355
- 1ページ分の取引数です。
356
-
357
- ---
358
- `shop_id`
359
- 店舗IDです。
360
-
361
- フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
362
-
363
- ---
364
- `customer_id`
365
- エンドユーザーIDです。
366
-
367
- フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
368
-
369
- ---
370
- `customer_name`
371
- エンドユーザー名です。
372
-
373
- フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
374
-
375
- ---
376
- `terminal_id`
377
- 端末IDです。
378
-
379
- フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
380
488
 
381
489
  ---
382
490
  `transaction_id`
383
491
  取引IDです。
384
492
 
385
- フィルターとして使われ、指定された取引のみ一覧に表示されます。
386
-
387
- ---
388
- `organization_code`
389
- 組織コードです。
390
-
391
- フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
392
-
393
- ---
394
- `private_money_id`
395
- マネーIDです。
396
-
397
- フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
398
-
399
- ---
400
- `is_modified`
401
- キャンセルフラグです。
402
-
403
- これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
404
- デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
405
-
406
- ---
407
- `types`
408
- 取引の種類でフィルターします。
409
-
410
- 以下の種類を指定できます。
411
-
412
- 1. topup
413
- 店舗からエンドユーザーへの送金取引(チャージ)
414
-
415
- 2. payment
416
- エンドユーザーから店舗への送金取引(支払い)
417
-
418
- 3. exchange-outflow
419
- 　　他マネーへの流出
420
-
421
- 4. exchange-inflow
422
- 他マネーからの流入
493
+ フィルターとして使われ、指定した取引IDの取引を取得します。
423
494
 
424
495
  ---
425
- 成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
426
-
427
- #### 返金する
496
+ 成功したときは[Transaction](#transaction)オブジェクトを返します
497
+ <a name="list-transfers"></a>
498
+ ####
428
499
  ```ruby
429
- response = $client.send(Pokepay::Request::RefundTransaction.new(
430
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
431
- description: "返品対応のため" # 取引履歴に表示する返金事由
500
+ response = $client.send(Pokepay::Request::ListTransfers.new(
501
+ from: "2017-11-27T11:10:27.000000+09:00",
502
+ to: "2022-07-13T10:00:27.000000+09:00",
503
+ page: 9517,
504
+ per_page: 651,
505
+ shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
506
+ shop_name: "gOIxNaz33MDlMm45c417ClVPZadCz21oTLg0Zh082rSUmgTJgltXUvopMAE6nKVgCC79b4Ei190OQ71CLczodkHUHlo8UiDVjyL8K2mxNxSNDBAB21jRDnDfUt4YgIyZaTsiHOmcCShoExxXDzwmu0NmtxroKVUk7sDu4lw8ZxL5",
507
+ customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
508
+ customer_name: "oBCUmbexHlOYPdRDRXfcFEKebPAHiatKRmL7K8IMJIBW1vB1RC8WQ75Zq2CPEph5LyiHrKKZHYeA6KMsRSBkbfNhFwjSSUkqouGV2ULftf3KLiOm",
509
+ transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
510
+ private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
511
+ is_modified: true,
512
+ transaction_types: ["topup", "transfer", "exchange"],
513
+ transfer_types: ["exchange", "payment"]
432
514
  ))
433
515
  ```
434
- 成功したときは[Transfer](#transfer)オブジェクトを返します
435
-
436
- ### チャージQRコード
437
-
438
- 店舗ユーザが発行し、エンドユーザがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
516
+ 成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
517
+ ### Check
518
+ 店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
439
519
 
440
520
  チャージQRコードを解析すると次のようなURLになります(URLは環境によって異なります)。
441
521
 
@@ -443,44 +523,11 @@ response = $client.send(Pokepay::Request::RefundTransaction.new(
443
523
 
444
524
  QRコードを読み取る方法以外にも、このURLリンクを直接スマートフォン(iOS/Android)上で開くことによりアプリが起動して取引が行われます。(注意: 上記URLはsandbox環境であるため、アプリもsandbox環境のものである必要があります) 上記URL中の `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージQRコードのIDです。
445
525
 
446
- #### チャージQRコードの発行
447
- ```ruby
448
- response = $client.send(Pokepay::Request::CreateCheck.new(
449
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
450
- money_amount: 4826, # 付与マネー額
451
- point_amount: 2394, # 付与ポイント額
452
- description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
453
- is_onetime: true, # ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
454
- usage_limit: 3826, # ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
455
- expires_at: "2019-02-22T16:57:44.000000+09:00", # チャージQR自体の失効日時
456
- point_expires_at: "2024-02-13T17:41:07.000000+09:00", # チャージQRによって付与されるポイントの失効日時
457
- point_expires_in_days: 60, # チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
458
- bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗アカウントのID
459
- ))
460
- ```
461
- `money_amount`と`point_amount`の少なくとも一方は指定する必要があります。
462
-
463
-
464
- ---
465
- `is_onetime`
466
- チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
467
- `false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
468
-
469
-
470
- ---
471
- `usage_limit`
472
- 複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
473
- 省略すると無制限に読み取り可能なチャージQRコードになります。
474
- チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
475
-
476
-
477
- ---
478
- 成功したときは[Check](#check)オブジェクトを返します
479
-
526
+ <a name="create-topup-transaction-with-check"></a>
480
527
  #### チャージQRコードを読み取ることでチャージする
481
- 通常チャージQRコードはエンドユーザのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
528
+ 通常チャージQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
482
529
 
483
- エンドユーザから受け取ったチャージ用QRコードのIDをエンドユーザIDと共に渡すことでチャージ取引が作られます。
530
+ エンドユーザーから受け取ったチャージ用QRコードのIDをエンドユーザーIDと共に渡すことでチャージ取引が作られます。
484
531
 
485
532
  ```ruby
486
533
  response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
@@ -503,25 +550,25 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
503
550
 
504
551
  ---
505
552
  成功したときは[Transaction](#transaction)オブジェクトを返します
506
-
507
- ### 支払いQRコード
508
-
553
+ ### Bill
554
+ 支払いQRコード
555
+ <a name="list-bills"></a>
509
556
  #### 支払いQRコード一覧を表示する
510
557
  支払いQRコード一覧を表示します。
511
558
  ```ruby
512
559
  response = $client.send(Pokepay::Request::ListBills.new(
513
- page: 6649, # ページ番号
514
- per_page: 2896, # 1ページの表示数
515
- bill_id: "3x6r1", # 支払いQRコードのID
560
+ page: 532, # ページ番号
561
+ per_page: 218, # 1ページの表示数
562
+ bill_id: "WM", # 支払いQRコードのID
516
563
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
517
- organization_code: "70s2krAk--iSH3DW--7--d----N", # 組織コード
564
+ organization_code: "--9", # 組織コード
518
565
  description: "test bill", # 取引説明文
519
- created_from: "2022-07-07T06:17:16.000000+09:00", # 作成日時(起点)
520
- created_to: "2024-09-06T18:44:09.000000+09:00", # 作成日時(終点)
566
+ created_from: "2016-02-26T19:01:25.000000+09:00", # 作成日時(起点)
567
+ created_to: "2021-01-22T10:47:37.000000+09:00", # 作成日時(終点)
521
568
  shop_name: "bill test shop1", # 店舗名
522
569
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
523
- lower_limit_amount: 8780, # 金額の範囲によるフィルタ(下限)
524
- upper_limit_amount: 8338, # 金額の範囲によるフィルタ(上限)
570
+ lower_limit_amount: 4942, # 金額の範囲によるフィルタ(下限)
571
+ upper_limit_amount: 1563, # 金額の範囲によるフィルタ(上限)
525
572
  is_disabled: true # 支払いQRコードが無効化されているかどうか
526
573
  ))
527
574
  ```
@@ -536,7 +583,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
536
583
 
537
584
  ---
538
585
  `bill_id`
539
- 支払いQRコードのIDを指定して検索します。IDは部分一致で検索できます。
586
+ 支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
540
587
 
541
588
  ---
542
589
  `private_money_id`
@@ -564,7 +611,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
564
611
 
565
612
  ---
566
613
  `shop_name`
567
- 支払いQRコードを作成した店舗名でフィルターします。
614
+ 支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
568
615
 
569
616
  ---
570
617
  `shop_id`
@@ -584,14 +631,14 @@ response = $client.send(Pokepay::Request::ListBills.new(
584
631
 
585
632
  ---
586
633
  成功したときは[PaginatedBills](#paginated-bills)オブジェクトを返します
587
-
634
+ <a name="create-bill"></a>
588
635
  #### 支払いQRコードの発行
589
636
  支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
590
637
  ```ruby
591
638
  response = $client.send(Pokepay::Request::CreateBill.new(
592
639
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
593
640
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
594
- amount: 9137, # 支払い額
641
+ amount: 3512, # 支払い額
595
642
  description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
596
643
  ))
597
644
  ```
@@ -602,15 +649,15 @@ response = $client.send(Pokepay::Request::CreateBill.new(
602
649
 
603
650
  ---
604
651
  成功したときは[Bill](#bill)オブジェクトを返します
605
-
652
+ <a name="update-bill"></a>
606
653
  #### 支払いQRコードの更新
607
654
  支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
608
655
  ```ruby
609
656
  response = $client.send(Pokepay::Request::UpdateBill.new(
610
657
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
611
- amount: 8582, # 支払い額
658
+ amount: 2045, # 支払い額
612
659
  description: "test bill", # 説明文
613
- is_disabled: false # 無効化されているかどうか
660
+ is_disabled: true # 無効化されているかどうか
614
661
  ))
615
662
  ```
616
663
 
@@ -632,36 +679,177 @@ response = $client.send(Pokepay::Request::UpdateBill.new(
632
679
 
633
680
  ---
634
681
  成功したときは[Bill](#bill)オブジェクトを返します
682
+ ### Cashtray
683
+ Cashtrayは支払いとチャージ両方に使えるQRコードで、店舗ユーザとエンドユーザーの間の主に店頭などでの取引のために用いられます。
684
+ Cashtrayによる取引では、エンドユーザーがQRコードを読み取った時点で即時取引が作られ、ユーザに対して受け取り確認画面は表示されません。
685
+ Cashtrayはワンタイムで、一度読み取りに成功するか、取引エラーになると失効します。
686
+ また、Cashtrayには有効期限があり、デフォルトでは30分で失効します。
635
687
 
636
- ### Customer
688
+ <a name="create-cashtray"></a>
689
+ #### Cashtrayを作る
690
+ Cashtrayを作成します。
691
+
692
+ エンドユーザーに対して支払いまたはチャージを行う店舗の情報(店舗ユーザーIDとマネーID)と、取引金額が必須項目です。
693
+ 店舗ユーザーIDとマネーIDから店舗ウォレットを特定します。
694
+
695
+ その他に、Cashtrayから作られる取引に対する説明文や失効時間を指定できます。
637
696
 
638
- #### 新規エンドユーザーウォレットを追加する
639
- 指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
640
697
  ```ruby
641
- response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
698
+ response = $client.send(Pokepay::Request::CreateCashtray.new(
642
699
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
643
- user_name: "ポケペイ太郎", # ユーザー名
644
- account_name: "ポケペイ太郎のアカウント" # アカウント名
700
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
701
+ 1828, # amount: 金額
702
+ description: "たい焼き(小倉)", # 取引履歴に表示する説明文
703
+ expires_in: 3161 # 失効時間(秒)
645
704
  ))
646
705
  ```
647
706
 
648
707
  ---
649
708
  `private_money_id`
650
- マネーIDです。
709
+ 取引対象のマネーのIDです(必須項目)。
651
710
 
652
- これによって作成するウォレットのマネーを指定します。
711
+ ---
712
+ `shop_id`
713
+ 店舗のユーザーIDです(必須項目)。
653
714
 
654
715
  ---
655
- `user_name`
656
- ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
716
+ `amount`
717
+ マネー額です(必須項目)。
718
+ 正の値を与えるとチャージになり、負の値を与えると支払いとなります。
657
719
 
658
720
  ---
659
- `account_name`
660
- 作成するウォレット名です。省略した場合は空文字となります。
721
+ `description`
722
+ Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
723
+ アプリや管理画面などの取引履歴に表示されます。デフォルトでは空文字になります。
661
724
 
662
725
  ---
663
- 成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
726
+ `expires_in`
727
+ Cashtrayが失効するまでの時間を秒単位で指定します(任意項目、デフォルト値は1800秒(30分))。
728
+
729
+ ---
730
+ 成功したときは[Cashtray](#cashtray)オブジェクトを返します
731
+ <a name="get-cashtray"></a>
732
+ #### Cashtrayの情報を取得する
733
+ Cashtrayの情報を取得します。
734
+
735
+ Cashtrayの現在の状態に加え、エンドユーザーのCashtray読み取りの試行結果、Cashtray読み取りによって作られた取引情報が取得できます。
736
+
737
+ レスポンス中の `attempt` には、このCashtrayをエンドユーザーが読み取った試行結果が入ります。
738
+ `account` はエンドユーザーのウォレット情報です。
739
+ 成功時には `attempt` 内の `status_code` に200が入ります。
740
+
741
+ まだCashtrayが読み取られていない場合は `attempt` の内容は `NULL` になります。
742
+ エンドユーザーのCashtray読み取りの際には、様々なエラーが起き得ます。
743
+ エラーの詳細は `attempt` 中の `error_type` と `error_message` にあります。主なエラー型と対応するステータスコードを以下に列挙します。
744
+
745
+ - `cashtray_already_proceed (422)`
746
+ - 既に処理済みのCashtrayをエンドユーザーが再び読み取ったときに返されます
747
+ - `cashtray_expired (422)`
748
+ - 読み取り時点でCashtray自体の有効期限が切れているときに返されます。Cashtrayが失効する時刻はレスポンス中の `expires_at` にあります
749
+ - `cashtray_already_canceled (422)`
750
+ - 読み取り時点でCashtrayが無効化されているときに返されます
751
+ - `account_balance_not_enough (422)`
752
+ - 支払い時に、エンドユーザーの残高が不足していて取引が完了できなかったときに返されます
753
+ - `account_balance_exceeded`
754
+ - チャージ時に、エンドユーザーのウォレット上限を超えて取引が完了できなかったときに返されます
755
+ - `account_transfer_limit_exceeded (422)`
756
+ - マネーに設定されている一度の取引金額の上限を超えたため、取引が完了できなかったときに返されます
757
+ - `account_not_found (422)`
758
+ - Cashtrayに設定されたマネーのウォレットをエンドユーザーが持っていなかったときに返されます
759
+
760
+
761
+ レスポンス中の `transaction` には、このCashtrayをエンドユーザーが読み取ることによって作られる取引データが入ります。まだCashtrayが読み取られていない場合は `NULL` になります。
762
+
763
+ 以上をまとめると、Cashtrayの状態は以下のようになります。
764
+
765
+ - エンドユーザーのCashtray読み取りによって取引が成功した場合
766
+ - レスポンス中の `attempt` と `transaction` にそれぞれ値が入ります
767
+ - 何らかの理由で取引が失敗した場合
768
+ - レスポンス中の `attempt` にエラー内容が入り、 `transaction` には `NULL` が入ります
769
+ - まだCashtrayが読み取られていない場合
770
+ - レスポンス中の `attempt` と `transaction` にそれぞれ `NULL` が入ります。Cashtrayの `expires_at` が現在時刻より前の場合は有効期限切れ状態です。
771
+
772
+ Cashtrayの取り得る全ての状態を擬似コードで記述すると以下のようになります。
773
+ ```
774
+ if (attempt == null) {
775
+ // 状態は未確定
776
+ if (canceled_at != null) {
777
+ // 無効化済み
778
+ } else if (expires_at < now) {
779
+ // 失効済み
780
+ } else {
781
+ // まだ有効で読み取られていない
782
+ }
783
+ } else if (transaction != null) {
784
+ // 取引成功確定。attempt で読み取ったユーザなどが分かる
785
+ } else {
786
+ // 取引失敗確定。attempt で失敗理由などが分かる
787
+ }
788
+ ```
789
+ ```ruby
790
+ response = $client.send(Pokepay::Request::GetCashtray.new(
791
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # cashtray_id: CashtrayのID
792
+ ))
793
+ ```
794
+
795
+ ---
796
+ `cashtray_id`
797
+ 情報を取得するCashtrayのIDです。
798
+
799
+ ---
800
+ 成功したときは[CashtrayWithResult](#cashtray-with-result)オブジェクトを返します
801
+ <a name="cancel-cashtray"></a>
802
+ #### Cashtrayを無効化する
803
+ Cashtrayを無効化します。
804
+
805
+ これにより、 `GetCashtray` のレスポンス中の `canceled_at` に無効化時点での現在時刻が入るようになります。
806
+ エンドユーザーが無効化されたQRコードを読み取ると `cashtray_already_canceled` エラーとなり、取引は失敗します。
807
+ ```ruby
808
+ response = $client.send(Pokepay::Request::CancelCashtray.new(
809
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # cashtray_id: CashtrayのID
810
+ ))
811
+ ```
664
812
 
813
+ ---
814
+ `cashtray_id`
815
+ 無効化するCashtrayのIDです。
816
+
817
+ ---
818
+ 成功したときは[Cashtray](#cashtray)オブジェクトを返します
819
+ <a name="update-cashtray"></a>
820
+ #### Cashtrayの情報を更新する
821
+ Cashtrayの内容を更新します。bodyパラメーターは全て省略可能で、指定したもののみ更新されます。
822
+ ```ruby
823
+ response = $client.send(Pokepay::Request::UpdateCashtray.new(
824
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
825
+ amount: 987, # 金額
826
+ description: "たい焼き(小倉)", # 取引履歴に表示する説明文
827
+ expires_in: 5471 # 失効時間(秒)
828
+ ))
829
+ ```
830
+
831
+ ---
832
+ `cashtray_id`
833
+ 更新対象のCashtrayのIDです。
834
+
835
+ ---
836
+ `amount`
837
+ マネー額です(任意項目)。
838
+ 正の値を与えるとチャージになり、負の値を与えると支払いとなります。
839
+
840
+ ---
841
+ `description`
842
+ Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
843
+ アプリや管理画面などの取引履歴に表示されます。
844
+
845
+ ---
846
+ `expires_in`
847
+ Cashtrayが失効するまでの時間を秒で指定します(任意項目、デフォルト値は1800秒(30分))。
848
+
849
+ ---
850
+ 成功したときは[Cashtray](#cashtray)オブジェクトを返します
851
+ ### Customer
852
+ <a name="get-account"></a>
665
853
  #### ウォレット情報を表示する
666
854
  ウォレットを取得します。
667
855
  ```ruby
@@ -678,17 +866,39 @@ response = $client.send(Pokepay::Request::GetAccount.new(
678
866
 
679
867
  ---
680
868
  成功したときは[AccountDetail](#account-detail)オブジェクトを返します
869
+ <a name="update-account"></a>
870
+ #### ウォレット情報を更新する
871
+ ウォレットの状態を更新します。現在はウォレットの凍結/凍結解除の切り替えにのみ対応しています。
872
+ ```ruby
873
+ response = $client.send(Pokepay::Request::UpdateAccount.new(
874
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
875
+ is_suspended: false # ウォレットが凍結されているかどうか
876
+ ))
877
+ ```
878
+
879
+ ---
880
+ `account_id`
881
+ ウォレットIDです。
882
+
883
+ 指定したウォレットIDのウォレットの状態を更新します。
681
884
 
885
+ ---
886
+ `is_suspended`
887
+ ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
888
+
889
+ ---
890
+ 成功したときは[AccountDetail](#account-detail)オブジェクトを返します
891
+ <a name="list-account-balances"></a>
682
892
  #### エンドユーザーの残高内訳を表示する
683
893
  エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
684
894
  ```ruby
685
895
  response = $client.send(Pokepay::Request::ListAccountBalances.new(
686
896
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
687
- page: 1912, # ページ番号
688
- per_page: 4503, # 1ページ分の取引数
689
- expires_at_from: "2021-11-26T22:06:49.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
690
- expires_at_to: "2019-12-08T14:37:45.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
691
- direction: "asc" # 有効期限によるソート順序
897
+ page: 2948, # ページ番号
898
+ per_page: 4246, # 1ページ分の取引数
899
+ expires_at_from: "2024-04-18T03:31:49.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
900
+ expires_at_to: "2019-01-11T07:51:31.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
901
+ direction: "desc" # 有効期限によるソート順序
692
902
  ))
693
903
  ```
694
904
 
@@ -720,17 +930,17 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
720
930
 
721
931
  ---
722
932
  成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
723
-
933
+ <a name="list-account-expired-balances"></a>
724
934
  #### エンドユーザーの失効済みの残高内訳を表示する
725
935
  エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
726
936
  ```ruby
727
937
  response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
728
938
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
729
- page: 7446, # ページ番号
730
- per_page: 9384, # 1ページ分の取引数
731
- expires_at_from: "2020-08-10T16:38:08.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
732
- expires_at_to: "2024-03-31T04:16:45.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
733
- direction: "asc" # 有効期限によるソート順序
939
+ page: 6863, # ページ番号
940
+ per_page: 6525, # 1ページ分の取引数
941
+ expires_at_from: "2022-09-24T18:44:02.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
942
+ expires_at_to: "2017-07-29T15:03:56.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
943
+ direction: "desc" # 有効期限によるソート順序
734
944
  ))
735
945
  ```
736
946
 
@@ -762,7 +972,34 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
762
972
 
763
973
  ---
764
974
  成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
975
+ <a name="create-customer-account"></a>
976
+ #### 新規エンドユーザーウォレットを追加する
977
+ 指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
978
+ ```ruby
979
+ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
980
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
981
+ user_name: "ポケペイ太郎", # ユーザー名
982
+ account_name: "ポケペイ太郎のアカウント" # アカウント名
983
+ ))
984
+ ```
985
+
986
+ ---
987
+ `private_money_id`
988
+ マネーIDです。
989
+
990
+ これによって作成するウォレットのマネーを指定します。
765
991
 
992
+ ---
993
+ `user_name`
994
+ ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
995
+
996
+ ---
997
+ `account_name`
998
+ 作成するウォレット名です。省略した場合は空文字となります。
999
+
1000
+ ---
1001
+ 成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
1002
+ <a name="list-customer-transactions"></a>
766
1003
  #### 取引履歴を取得する
767
1004
  取引一覧を返します。
768
1005
  ```ruby
@@ -770,10 +1007,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
770
1007
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
771
1008
  sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
772
1009
  receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
773
- type: "sFsWbo7bpQ", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
1010
+ type: "L", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
774
1011
  is_modified: true, # キャンセル済みかどうか
775
- from: "2021-04-11T02:43:13.000000+09:00", # 開始日時
776
- to: "2022-03-18T03:41:42.000000+09:00", # 終了日時
1012
+ from: "2017-03-01T02:18:01.000000+09:00", # 開始日時
1013
+ to: "2021-08-14T21:55:36.000000+09:00", # 終了日時
777
1014
  page: 1, # ページ番号
778
1015
  per_page: 50 # 1ページ分の取引数
779
1016
  ))
@@ -841,56 +1078,20 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
841
1078
 
842
1079
  ---
843
1080
  成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
844
-
845
1081
  ### Organization
846
-
847
- #### 新規加盟店組織を追加する
848
- ```ruby
849
- response = $client.send(Pokepay::Request::CreateOrganization.new(
850
- "ox_supermarket", # code: 新規組織コード
851
- "oxスーパー", # name: 新規組織名
852
- ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # private_money_ids: 加盟店組織で有効にするマネーIDの配列
853
- "PszkN335U1@t4DY.com", # issuer_admin_user_email: 発行体担当者メールアドレス
854
- "suiE88p3Ho@g0k8.com", # member_admin_user_email: 新規組織担当者メールアドレス
855
- bank_name: "XYZ銀行", # 銀行名
856
- bank_code: "99X", # 銀行金融機関コード
857
- bank_branch_name: "ABC支店", # 銀行支店名
858
- bank_branch_code: "99X", # 銀行支店コード
859
- bank_account_type: "saving", # 銀行口座種別 (普通=saving, 当座=current, その他=other)
860
- bank_account: 9999999, # 銀行口座番号
861
- bank_account_holder_name: "ﾌｸｻﾞﾜﾕｷﾁ", # 口座名義人名
862
- contact_name: "佐藤清" # 担当者名
863
- ))
864
- ```
865
- 成功したときは[Organization](#organization)オブジェクトを返します
866
-
867
1082
  ### Shop
868
-
869
- #### 新規店舗を追加する
870
- ```ruby
871
- response = $client.send(Pokepay::Request::CreateShop.new(
872
- "oxスーパー三田店", # shop_name: 店舗名
873
- shop_postal_code: "805-5907", # 店舗の郵便番号
874
- shop_address: "東京都港区芝...", # 店舗の住所
875
- shop_tel: "06-01122", # 店舗の電話番号
876
- shop_email: "n8ATMTNMME@yVAp.com", # 店舗のメールアドレス
877
- shop_external_id: "kaDeYuOtBoCZgc4gwc8RSE7", # 店舗の外部ID
878
- organization_code: "ox-supermarket" # 組織コード
879
- ))
880
- ```
881
- 成功したときは[User](#user)オブジェクトを返します
882
-
1083
+ <a name="list-shops"></a>
883
1084
  #### 店舗一覧を取得する
884
1085
  ```ruby
885
1086
  response = $client.send(Pokepay::Request::ListShops.new(
886
1087
  organization_code: "pocketchange", # 組織コード
887
1088
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
888
1089
  name: "oxスーパー三田店", # 店舗名
889
- postal_code: "257-1310", # 店舗の郵便番号
1090
+ postal_code: "624-0001", # 店舗の郵便番号
890
1091
  address: "東京都港区芝...", # 店舗の住所
891
- tel: "0689-859-5517", # 店舗の電話番号
892
- email: "pb9AHk6UF1@UjWU.com", # 店舗のメールアドレス
893
- external_id: "yw97H5Wi0UlM5hWRopq8fm3QjwrUJD", # 店舗の外部ID
1092
+ tel: "077-41-284", # 店舗の電話番号
1093
+ email: "fAUj6MGuDC@QRgb.com", # 店舗のメールアドレス
1094
+ external_id: "h69IfOOqdFvcvTYHWhMSc2JtDSCuxpXIBKj", # 店舗の外部ID
894
1095
  page: 1, # ページ番号
895
1096
  per_page: 50 # 1ページ分の取引数
896
1097
  ))
@@ -946,9 +1147,127 @@ response = $client.send(Pokepay::Request::ListShops.new(
946
1147
 
947
1148
  ---
948
1149
  成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
1150
+ <a name="create-shop"></a>
1151
+ #### 新規店舗を追加する(廃止予定)
1152
+ 新規店舗を追加します。このAPIは廃止予定です。以降は `CreateShopV2` を使用してください。
1153
+ ```ruby
1154
+ response = $client.send(Pokepay::Request::CreateShop.new(
1155
+ "oxスーパー三田店", # shop_name: 店舗名
1156
+ shop_postal_code: "8072594", # 店舗の郵便番号
1157
+ shop_address: "東京都港区芝...", # 店舗の住所
1158
+ shop_tel: "083-7936908", # 店舗の電話番号
1159
+ shop_email: "hctiEpL1Kl@L20S.com", # 店舗のメールアドレス
1160
+ shop_external_id: "Y28CEIpXvCz2lX0WFgkUTJYHHO", # 店舗の外部ID
1161
+ organization_code: "ox-supermarket" # 組織コード
1162
+ ))
1163
+ ```
1164
+ 成功したときは[User](#user)オブジェクトを返します
1165
+ <a name="create-shop-v"></a>
1166
+ #### 新規店舗を追加する
1167
+ ```ruby
1168
+ response = $client.send(Pokepay::Request::CreateShopV.new(
1169
+ "oxスーパー三田店", # name: 店舗名
1170
+ postal_code: "6626381", # 店舗の郵便番号
1171
+ address: "東京都港区芝...", # 店舗の住所
1172
+ tel: "05763334042", # 店舗の電話番号
1173
+ email: "jCOwyap0ls@b8d4.com", # 店舗のメールアドレス
1174
+ external_id: "Dc5yMU1TN0yX6wxY6IPoPyEr8klnc", # 店舗の外部ID
1175
+ organization_code: "ox-supermarket", # 組織コード
1176
+ private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
1177
+ can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
1178
+ ))
1179
+ ```
949
1180
 
950
- ### Account
1181
+ ---
1182
+ `name`
1183
+ 店舗名です。
1184
+
1185
+ 同一組織内に同名の店舗があった場合は`name_conflict`エラーが返ります。
1186
+
1187
+ ---
1188
+ `private_money_ids`
1189
+ 店舗で有効にするマネーIDの配列を指定します。
1190
+
1191
+ 店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
1192
+ このパラメータを省略したときは、店舗が所属する組織が発行または加盟している全てのマネーのウォレットができます。
951
1193
 
1194
+ ---
1195
+ `can_topup_private_money_ids`
1196
+ 店舗でチャージ可能にするマネーIDの配列を指定します。
1197
+
1198
+ このパラメータは発行体のみが指定でき、自身が発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
1199
+ 省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
1200
+
1201
+ ---
1202
+ 成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
1203
+ <a name="get-shop"></a>
1204
+ #### 店舗情報を表示する
1205
+ 店舗情報を表示します。
1206
+
1207
+ 権限に関わらず自組織の店舗情報は表示可能です。それに加え、発行体は自組織の発行しているマネーの加盟店組織の店舗情報を表示できます。
1208
+ ```ruby
1209
+ response = $client.send(Pokepay::Request::GetShop.new(
1210
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # shop_id: 店舗ユーザーID
1211
+ ))
1212
+ ```
1213
+ 成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
1214
+ <a name="update-shop"></a>
1215
+ #### 店舗情報を更新する
1216
+ 店舗情報を更新します。bodyパラメーターは全て省略可能で、指定したもののみ更新されます。
1217
+ ```ruby
1218
+ response = $client.send(Pokepay::Request::UpdateShop.new(
1219
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
1220
+ name: "oxスーパー三田店", # 店舗名
1221
+ postal_code: "5576227", # 店舗の郵便番号
1222
+ address: "東京都港区芝...", # 店舗の住所
1223
+ tel: "0904519142", # 店舗の電話番号
1224
+ email: "uyEzfF4ihE@MnqI.com", # 店舗のメールアドレス
1225
+ external_id: "LL8T5msTmgqj81R", # 店舗の外部ID
1226
+ private_money_ids: [], # 店舗で有効にするマネーIDの配列
1227
+ can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
1228
+ ))
1229
+ ```
1230
+
1231
+ ---
1232
+ `name`
1233
+ 店舗名です。
1234
+
1235
+ 同一組織内に同名の店舗があった場合は`shop_name_conflict`エラーが返ります。
1236
+
1237
+ ---
1238
+ `postal_code`
1239
+ 店舗住所の郵便番号(7桁の数字)です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
1240
+
1241
+ ---
1242
+ `tel`
1243
+ 店舗の電話番号です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
1244
+
1245
+ ---
1246
+ `email`
1247
+ 店舗の連絡先メールアドレスです。明示的に空の値を設定するにはNULLを指定します。
1248
+
1249
+ ---
1250
+ `external_id`
1251
+ 店舗の外部IDです(最大36文字)。明示的に空の値を設定するにはNULLを指定します。
1252
+
1253
+ ---
1254
+ `private_money_ids`
1255
+ 店舗で有効にするマネーIDの配列を指定します。
1256
+
1257
+ 店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
1258
+ 店舗が既にウォレットを持っている場合に、ここでそのウォレットのマネーIDを指定しないで更新すると、そのマネーのウォレットは凍結(無効化)されます。
1259
+
1260
+ ---
1261
+ `can_topup_private_money_ids`
1262
+ 店舗でチャージ可能にするマネーIDの配列を指定します。
1263
+
1264
+ このパラメータは発行体のみが指定でき、発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
1265
+ 省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
1266
+
1267
+ ---
1268
+ 成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
1269
+ ### Account
1270
+ <a name="list-user-accounts"></a>
952
1271
  #### エンドユーザー、店舗ユーザーのウォレット一覧を表示する
953
1272
  ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
954
1273
  ```ruby
@@ -965,15 +1284,33 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
965
1284
 
966
1285
  ---
967
1286
  成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
968
-
969
1287
  ### Private Money
1288
+ <a name="get-private-moneys"></a>
1289
+ #### マネー一覧を取得する
1290
+ マネーの一覧を取得します。
1291
+ パートナーキーの管理者が発行体組織に属している場合、自組織が加盟または発行しているマネーの一覧を返します。また、`organization_code`として決済加盟店の組織コードを指定した場合、発行マネーのうち、その決済加盟店組織が加盟しているマネーの一覧を返します。
1292
+ パートナーキーの管理者が決済加盟店組織に属している場合は、自組織が加盟しているマネーの一覧を返します。
1293
+ ```ruby
1294
+ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
1295
+ organization_code: "ox-supermarket", # 組織コード
1296
+ page: 1, # ページ番号
1297
+ per_page: 50 # 1ページ分の取得数
1298
+ ))
1299
+ ```
1300
+
1301
+ ---
1302
+ `organization_code`
1303
+ パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
970
1304
 
1305
+ ---
1306
+ 成功したときは[PaginatedPrivateMoneys](#paginated-private-moneys)オブジェクトを返します
1307
+ <a name="get-private-money-organization-summaries"></a>
971
1308
  #### 決済加盟店の取引サマリを取得する
972
1309
  ```ruby
973
1310
  response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
974
1311
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
975
- from: "2021-01-27T10:09:02.000000+09:00", # 開始日時(toと同時に指定する必要有)
976
- to: "2016-02-05T23:42:53.000000+09:00", # 終了日時(fromと同時に指定する必要有)
1312
+ from: "2017-03-23T12:47:17.000000+09:00", # 開始日時(toと同時に指定する必要有)
1313
+ to: "2024-06-20T02:27:27.000000+09:00", # 終了日時(fromと同時に指定する必要有)
977
1314
  page: 1, # ページ番号
978
1315
  per_page: 50 # 1ページ分の取引数
979
1316
  ))
@@ -981,17 +1318,16 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
981
1318
  `from`と`to`は同時に指定する必要があります。
982
1319
 
983
1320
  成功したときは[PaginatedPrivateMoneyOrganizationSummaries](#paginated-private-money-organization-summaries)オブジェクトを返します
984
-
985
- ### バルクチャージ
986
-
1321
+ ### Bulk
1322
+ <a name="bulk-create-transaction"></a>
987
1323
  #### CSVファイル一括取引
988
1324
  CSVファイルから一括取引をします。
989
1325
  ```ruby
990
1326
  response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
991
- "IEgbGEOQG1PZp7fjd9", # name: 一括取引タスク名
992
- "1zgh1", # content: 取引する情報のCSV
993
- "RHHtL55R7YEprCJ0U4QnLZWmGvTqLQwaZ9vO", # request_id: リクエストID
994
- description: "v67spoRoPKUgWvYVa3Gv9xbfzvgScohGvfvszFZKZ0fsirdyb8N5N4uLXeppDXZ9aq2pYugtiiL7qWoYElTKmZkEzCv7OKUa8NeEnF41oUMWRj1" # 一括取引の説明
1327
+ "GFY2SrpQfm9Le0rSPWlrPa8fbLwdjVa", # name: 一括取引タスク名
1328
+ "9Jyd", # content: 取引する情報のCSV
1329
+ "pHqXjqW7D3uCGCdE3Z7gIcLSudPl4JIrQmLF", # request_id: リクエストID
1330
+ description: "JxcGB9NLriuIsMTYyCUoOEa9YZaUNPTMagDSPeHLGCGYvgqbqCIdoPTyGfjAlvbOwBRftL3mTfJhTjDs9c8QNUGv" # 一括取引の説明
995
1331
  ))
996
1332
  ```
997
1333
 
@@ -1011,14 +1347,18 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1011
1347
 
1012
1348
  - `type`: 取引種別
1013
1349
  - 必須。'topup' または 'payment'
1014
- - `sender_account_id`: 送金ウォレットID
1350
+ - `sender_id`: 送金ユーザーID
1351
+ - 必須。UUID
1352
+ - `receiver_id`: 受取ユーザーID
1015
1353
  - 必須。UUID
1016
- - `receiver_account_id`: 受取ウォレットID
1354
+ - `private_money_id`: マネーID
1017
1355
  - 必須。UUID
1018
1356
  - `money_amount`: マネー額
1019
1357
  - 任意。ただし `point_amount` といずれかが必須。0以上の数字
1020
1358
  - `point_amount`: ポイント額
1021
1359
  - 任意。ただし `money_amount` といずれかが必須。0以上の数字
1360
+ - `description`: 取引の説明文
1361
+ - 任意。200文字以内。取引履歴に表示される文章
1022
1362
  - `bear_account_id`: ポイント負担ウォレットID
1023
1363
  - `point_amount` があるときは必須。UUID
1024
1364
  - `point_expires_at`: ポイントの有効期限
@@ -1030,7 +1370,6 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1030
1370
 
1031
1371
  ---
1032
1372
  成功したときは[BulkTransaction](#bulk-transaction)オブジェクトを返します
1033
-
1034
1373
  ## Responses
1035
1374
 
1036
1375
 
@@ -1067,29 +1406,39 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1067
1406
  * `description (string)`: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
1068
1407
  * `account (AccountWithUser)`: 支払いQRコード発行ウォレット
1069
1408
  * `is_disabled (boolean)`: 無効化されているかどうか
1070
- * `token (string)`:
1409
+ * `token (string)`: 支払いQRコードを解析したときに出てくるURL
1071
1410
 
1072
1411
  `account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
1073
1412
 
1074
- <a name="check"></a>
1075
- ## Check
1076
- * `id (string)`: チャージQRコードのID
1077
- * `amount (double)`: チャージマネー額 (deprecated)
1078
- * `money_amount (double)`: チャージマネー額
1079
- * `point_amount (double)`: チャージポイント額
1080
- * `description (string)`: チャージQRコードの説明文(アプリ上で取引の説明文として表示される)
1081
- * `user (User)`: 送金元ユーザ情報
1082
- * `is_onetime (boolean)`: 使用回数が一回限りかどうか
1083
- * `is_disabled (boolean)`: 無効化されているかどうか
1084
- * `expires_at (string)`: チャージQRコード自体の失効日時
1085
- * `private_money (PrivateMoney)`: 対象マネー情報
1086
- * `usage_limit (integer)`: 一回限りでない場合の最大読み取り回数
1087
- * `usage_count (double)`: 一回限りでない場合の現在までに読み取られた回数
1088
- * `token (string)`: チャージQRコードを解析したときに出てくるURL
1413
+ <a name="cashtray"></a>
1414
+ ## Cashtray
1415
+ * `id (string)`: Cashtray自体のIDです。
1416
+ * `amount (double)`: 取引金額
1417
+ * `description (string)`: Cashtrayの説明文
1418
+ * `account (AccountWithUser)`: 発行店舗のウォレット
1419
+ * `expires_at (string)`: Cashtrayの失効日時
1420
+ * `canceled_at (string)`: Cashtrayの無効化日時。NULLの場合は無効化されていません
1421
+ * `token (string)`: CashtrayのQRコードを解析したときに出てくるURL
1089
1422
 
1090
- `user`は [User](#user) オブジェクトを返します。
1423
+ `account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
1091
1424
 
1092
- `private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
1425
+ <a name="cashtray-with-result"></a>
1426
+ ## CashtrayWithResult
1427
+ * `id (string)`: CashtrayのID
1428
+ * `amount (double)`: 取引金額
1429
+ * `description (string)`: Cashtrayの説明文(アプリ上で取引の説明文として表示される)
1430
+ * `account (AccountWithUser)`: 発行店舗のウォレット
1431
+ * `expires_at (string)`: Cashtrayの失効日時
1432
+ * `canceled_at (string)`: Cashtrayの無効化日時。NULLの場合は無効化されていません
1433
+ * `token (string)`: CashtrayのQRコードを解析したときに出てくるURL
1434
+ * `attempt (CashtrayAttempt)`: Cashtray読み取り結果
1435
+ * `transaction (Transaction)`: 取引結果
1436
+
1437
+ `account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
1438
+
1439
+ `attempt`は [CashtrayAttempt](#cashtray-attempt) オブジェクトを返します。
1440
+
1441
+ `transaction`は [Transaction](#transaction) オブジェクトを返します。
1093
1442
 
1094
1443
  <a name="user"></a>
1095
1444
  ## User
@@ -1097,11 +1446,6 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1097
1446
  * `name (string)`: ユーザー (または店舗) 名
1098
1447
  * `is_merchant (boolean)`: 店舗ユーザーかどうか
1099
1448
 
1100
- <a name="organization"></a>
1101
- ## Organization
1102
- * `code (string)`: 組織コード
1103
- * `name (string)`: 組織名
1104
-
1105
1449
  <a name="transaction"></a>
1106
1450
  ## Transaction
1107
1451
  * `id (string)`: 取引ID
@@ -1121,29 +1465,31 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1121
1465
 
1122
1466
  `receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
1123
1467
 
1468
+ <a name="shop-with-accounts"></a>
1469
+ ## ShopWithAccounts
1470
+ * `id (string)`: 店舗ID
1471
+ * `name (string)`: 店舗名
1472
+ * `organization_code (string)`: 組織コード
1473
+ * `postal_code (string)`: 店舗の郵便番号
1474
+ * `address (string)`: 店舗の住所
1475
+ * `tel (string)`: 店舗の電話番号
1476
+ * `email (string)`: 店舗のメールアドレス
1477
+ * `external_id (string)`: 店舗の外部ID
1478
+ * `accounts (array of ShopAccounts)`:
1479
+
1480
+ `accounts`は [ShopAccount](#shop-account) オブジェクトの配列を返します。
1481
+
1124
1482
  <a name="bulk-transaction"></a>
1125
1483
  ## BulkTransaction
1126
- * `request_id (string)`: リクエストID
1127
- * `name (string)`: バルクチャージ管理用の名前
1128
- * `description (string)`: バルクチャージ管理用の説明文
1129
- * `status (string)`: バルクチャージの状態
1130
- * `submitted_at (string)`: バルクチャージが登録された日時
1131
- * `updated_at (string)`: バルクチャージが更新された日時
1132
-
1133
- <a name="transfer"></a>
1134
- ## Transfer
1135
1484
  * `id (string)`:
1136
- * `sender_account (AccountWithoutPrivateMoneyDetail)`:
1137
- * `receiver_account (AccountWithoutPrivateMoneyDetail)`:
1138
- * `amount (double)`:
1139
- * `money_amount (double)`:
1140
- * `point_amount (double)`:
1141
- * `done_at (string)`:
1142
- * `type (string)`:
1143
- * `description (string)`:
1144
- * `transaction_id (string)`:
1145
-
1146
- `receiver_account`と`sender_account`は [AccountWithoutPrivateMoneyDetail](#account-without-private-money-detail) オブジェクトを返します。
1485
+ * `request_id (string)`: リクエストID
1486
+ * `name (string)`: バルク取引管理用の名前
1487
+ * `description (string)`: バルク取引管理用の説明文
1488
+ * `status (string)`: バルク取引の状態
1489
+ * `error (string)`: バルク取引のエラー種別
1490
+ * `error_lineno (integer)`: バルク取引のエラーが発生した行番号
1491
+ * `submitted_at (string)`: バルク取引が登録された日時
1492
+ * `updated_at (string)`: バルク取引が更新された日時
1147
1493
 
1148
1494
  <a name="paginated-private-money-organization-summaries"></a>
1149
1495
  ## PaginatedPrivateMoneyOrganizationSummaries
@@ -1165,6 +1511,16 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1165
1511
 
1166
1512
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
1167
1513
 
1514
+ <a name="paginated-transfers"></a>
1515
+ ## PaginatedTransfers
1516
+ * `rows (array of Transfers)`:
1517
+ * `count (integer)`:
1518
+ * `pagination (Pagination)`:
1519
+
1520
+ `rows`は [Transfer](#transfer) オブジェクトの配列を返します。
1521
+
1522
+ `pagination`は [Pagination](#pagination) オブジェクトを返します。
1523
+
1168
1524
  <a name="paginated-accounts"></a>
1169
1525
  ## PaginatedAccounts
1170
1526
  * `rows (array of Accounts)`:
@@ -1205,6 +1561,16 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1205
1561
 
1206
1562
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
1207
1563
 
1564
+ <a name="paginated-private-moneys"></a>
1565
+ ## PaginatedPrivateMoneys
1566
+ * `rows (array of PrivateMoneys)`:
1567
+ * `count (integer)`:
1568
+ * `pagination (Pagination)`:
1569
+
1570
+ `rows`は [PrivateMoney](#private-money) オブジェクトの配列を返します。
1571
+
1572
+ `pagination`は [Pagination](#pagination) オブジェクトを返します。
1573
+
1208
1574
  <a name="private-money"></a>
1209
1575
  ## PrivateMoney
1210
1576
  * `id (string)`: マネーID
@@ -1219,10 +1585,19 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1219
1585
  * `type (string)`: マネー種別 (自家型=own, 第三者型=third-party)
1220
1586
  * `expiration_type (string)`: 有効期限種別 (チャージ日起算=static, 最終利用日起算=last-update, 最終チャージ日起算=last-topup-update)
1221
1587
  * `enable_topup_by_member (boolean)`: 加盟店によるチャージが有効かどうか
1222
- * `account_image (string)`: マネーの画像URL
1223
1588
 
1224
1589
  `organization`は [Organization](#organization) オブジェクトを返します。
1225
1590
 
1591
+ <a name="cashtray-attempt"></a>
1592
+ ## CashtrayAttempt
1593
+ * `account (AccountWithUser)`: エンドユーザーのウォレット
1594
+ * `status_code (double)`: ステータスコード
1595
+ * `error_type (string)`: エラー型
1596
+ * `error_message (string)`: エラーメッセージ
1597
+ * `created_at (string)`: Cashtray読み取り記録の作成日時
1598
+
1599
+ `account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
1600
+
1226
1601
  <a name="account"></a>
1227
1602
  ## Account
1228
1603
  * `id (string)`: ウォレットID
@@ -1232,15 +1607,15 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1232
1607
 
1233
1608
  `private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
1234
1609
 
1235
- <a name="account-without-private-money-detail"></a>
1236
- ## AccountWithoutPrivateMoneyDetail
1237
- * `id (string)`:
1238
- * `name (string)`:
1239
- * `is_suspended (boolean)`:
1240
- * `private_money_id (string)`:
1241
- * `user (User)`:
1610
+ <a name="shop-account"></a>
1611
+ ## ShopAccount
1612
+ * `id (string)`: ウォレットID
1613
+ * `name (string)`: ウォレット名
1614
+ * `is_suspended (boolean)`: ウォレットが凍結されているかどうか
1615
+ * `can_transfer_topup (boolean)`: チャージ可能かどうか
1616
+ * `private_money (PrivateMoney)`: 設定マネー情報
1242
1617
 
1243
- `user`は [User](#user) オブジェクトを返します。
1618
+ `private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
1244
1619
 
1245
1620
  <a name="private-money-organization-summary"></a>
1246
1621
  ## PrivateMoneyOrganizationSummary
@@ -1258,6 +1633,21 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1258
1633
  * `has_prev (boolean)`:
1259
1634
  * `has_next (boolean)`:
1260
1635
 
1636
+ <a name="transfer"></a>
1637
+ ## Transfer
1638
+ * `id (string)`:
1639
+ * `sender_account (AccountWithoutPrivateMoneyDetail)`:
1640
+ * `receiver_account (AccountWithoutPrivateMoneyDetail)`:
1641
+ * `amount (double)`:
1642
+ * `money_amount (double)`:
1643
+ * `point_amount (double)`:
1644
+ * `done_at (string)`:
1645
+ * `type (string)`:
1646
+ * `description (string)`:
1647
+ * `transaction_id (string)`:
1648
+
1649
+ `receiver_account`と`sender_account`は [AccountWithoutPrivateMoneyDetail](#account-without-private-money-detail) オブジェクトを返します。
1650
+
1261
1651
  <a name="account-balance"></a>
1262
1652
  ## AccountBalance
1263
1653
  * `expires_at (string)`: