pokepay_partner_ruby_sdk 0.1.9 → 0.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b31b44c25482290e71f6ddb114c700f2502dd19bae3a6f4c7a0dbf125f034af7
4
- data.tar.gz: d37c5c6a38ef8e22ff542ef38402924ef1614c8231ff4b1b5410a55e727a600e
3
+ metadata.gz: 1630f5d909147fb03a05583bbde221dc53fafe375d2cd5b7ab85727b63429662
4
+ data.tar.gz: 30242c08c57c768e0866c17fa5e378dbc35e600225346d9710cda0695c937f4c
5
5
  SHA512:
6
- metadata.gz: 135694919952fad3d174fd466f20350d8411c615b691368b30e01820bc25be8054597f247ba12b5fa08a6c6a003102e75ba03fb95c06b6843ec88e8465701be8
7
- data.tar.gz: a4492393069d894ac2a35d9a77056376c401db1dc206e29bff3322b04b0706d0e5912b1864514b1247b89ede94c543a4cd32dcce600170ccee7a17437f0ea077
6
+ metadata.gz: b97c52f0c83b1fcf7b7b633a1d5490c78a33923c82318bc09dd9e3fbd896c6b87d9929084717831f88d46618af06e22e0b249a4e8c28874d4783b30716d193c4
7
+ data.tar.gz: c5e179d9e18940099d2131311d5ae5f66f82b9688ab60af60b19292f2393faa19771b653e53d915ff9e424b8239010040076eb16080ef97c6b44d91bac0a69cd
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- pokepay_partner_ruby_sdk (0.1.9)
4
+ pokepay_partner_ruby_sdk (0.1.13)
5
5
  inifile (~> 3.0.0)
6
6
  json (~> 2.3.0)
7
7
  openssl (~> 2.1.2)
@@ -12,7 +12,7 @@ GEM
12
12
  inifile (3.0.0)
13
13
  ipaddr (1.2.2)
14
14
  json (2.3.1)
15
- minitest (5.14.0)
15
+ minitest (5.14.4)
16
16
  openssl (2.1.2)
17
17
  ipaddr
18
18
  rake (13.0.1)
@@ -27,4 +27,4 @@ DEPENDENCIES
27
27
  rake (~> 13.0)
28
28
 
29
29
  BUNDLED WITH
30
- 2.1.4
30
+ 2.2.3
data/docs/index.md CHANGED
@@ -149,6 +149,7 @@ response.body
149
149
  - [CreateTransferTransaction](#create-transfer-transaction): 個人間送金
150
150
  - [CreateExchangeTransaction](#create-exchange-transaction):
151
151
  - [GetTransaction](#get-transaction): 取引情報を取得する
152
+ - [RefundTransaction](#refund-transaction): 返金する
152
153
  - [ListTransfers](#list-transfers):
153
154
  - [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
154
155
  - [ListBills](#list-bills): 支払いQRコード一覧を表示する
@@ -162,11 +163,13 @@ response.body
162
163
  - [UpdateAccount](#update-account): ウォレット情報を更新する
163
164
  - [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
164
165
  - [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
166
+ - [GetCustomerAccounts](#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
165
167
  - [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーウォレットを追加する
168
+ - [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
166
169
  - [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
167
170
  - [ListShops](#list-shops): 店舗一覧を取得する
168
171
  - [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
169
- - [CreateShopV2](#create-shop-v): 新規店舗を追加する
172
+ - [CreateShopV2](#create-shop-v2): 新規店舗を追加する
170
173
  - [GetShop](#get-shop): 店舗情報を表示する
171
174
  - [UpdateShop](#update-shop): 店舗情報を更新する
172
175
  - [ListUserAccounts](#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
@@ -179,8 +182,8 @@ response.body
179
182
  取引一覧を返します。
180
183
  ```ruby
181
184
  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", # 終了日時
185
+ from: "2016-06-03T22:47:56.000000+09:00", # 開始日時
186
+ to: "2020-02-14T17:14:59.000000+09:00", # 終了日時
184
187
  page: 1, # ページ番号
185
188
  per_page: 50, # 1ページ分の取引数
186
189
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
@@ -190,75 +193,146 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
190
193
  transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
191
194
  organization_code: "pocketchange", # 組織コード
192
195
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
193
- is_modified: true, # キャンセルフラグ
194
- types: ["topup", "payment"] # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
196
+ is_modified: false, # キャンセルフラグ
197
+ types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
198
+ description: "店頭QRコードによる支払い" # 取引説明文
195
199
  ))
196
200
  ```
197
201
 
198
202
  ---
199
203
  `from`
204
+ ```json
205
+ {
206
+ "type": "string",
207
+ "format": "date-time"
208
+ }
209
+ ```
200
210
  抽出期間の開始日時です。
201
211
 
202
212
  フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
203
213
 
204
214
  ---
205
215
  `to`
216
+ ```json
217
+ {
218
+ "type": "string",
219
+ "format": "date-time"
220
+ }
221
+ ```
206
222
  抽出期間の終了日時です。
207
223
 
208
224
  フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
209
225
 
210
226
  ---
211
227
  `page`
228
+ ```json
229
+ {
230
+ "type": "integer",
231
+ "minimum": 1
232
+ }
233
+ ```
212
234
  取得したいページ番号です。
213
235
 
214
236
  ---
215
237
  `per_page`
238
+ ```json
239
+ {
240
+ "type": "integer",
241
+ "minimum": 1
242
+ }
243
+ ```
216
244
  1ページ分の取引数です。
217
245
 
218
246
  ---
219
247
  `shop_id`
248
+ ```json
249
+ {
250
+ "type": "string",
251
+ "format": "uuid"
252
+ }
253
+ ```
220
254
  店舗IDです。
221
255
 
222
256
  フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
223
257
 
224
258
  ---
225
259
  `customer_id`
260
+ ```json
261
+ {
262
+ "type": "string",
263
+ "format": "uuid"
264
+ }
265
+ ```
226
266
  エンドユーザーIDです。
227
267
 
228
268
  フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
229
269
 
230
270
  ---
231
271
  `customer_name`
272
+ ```json
273
+ {
274
+ "type": "string",
275
+ "maxLength": 256
276
+ }
277
+ ```
232
278
  エンドユーザー名です。
233
279
 
234
280
  フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
235
281
 
236
282
  ---
237
283
  `terminal_id`
284
+ ```json
285
+ {
286
+ "type": "string",
287
+ "format": "uuid"
288
+ }
289
+ ```
238
290
  端末IDです。
239
291
 
240
292
  フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
241
293
 
242
294
  ---
243
295
  `transaction_id`
296
+ ```json
297
+ {
298
+ "type": "string",
299
+ "format": "uuid"
300
+ }
301
+ ```
244
302
  取引IDです。
245
303
 
246
304
  フィルターとして使われ、指定された取引のみ一覧に表示されます。
247
305
 
248
306
  ---
249
307
  `organization_code`
308
+ ```json
309
+ {
310
+ "type": "string",
311
+ "maxLength": 32,
312
+ "pattern": "^[a-zA-Z0-9-]*$"
313
+ }
314
+ ```
250
315
  組織コードです。
251
316
 
252
317
  フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
253
318
 
254
319
  ---
255
320
  `private_money_id`
321
+ ```json
322
+ {
323
+ "type": "string",
324
+ "format": "uuid"
325
+ }
326
+ ```
256
327
  マネーIDです。
257
328
 
258
329
  フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
259
330
 
260
331
  ---
261
332
  `is_modified`
333
+ ```json
334
+ { "type": "boolean" }
335
+ ```
262
336
  キャンセルフラグです。
263
337
 
264
338
  これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
@@ -266,6 +340,18 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
266
340
 
267
341
  ---
268
342
  `types`
343
+ ```json
344
+ {
345
+ "type": "array",
346
+ "items": {
347
+ "type": "string",
348
+ "enum": {
349
+ "topup": "payment",
350
+ "exchange_outflow": "exchange_inflow"
351
+ }
352
+ }
353
+ }
354
+ ```
269
355
  取引の種類でフィルターします。
270
356
 
271
357
  以下の種類を指定できます。
@@ -282,6 +368,18 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
282
368
  4. exchange-inflow
283
369
  他マネーからの流入
284
370
 
371
+ ---
372
+ `description`
373
+ ```json
374
+ {
375
+ "type": "string",
376
+ "maxLength": 200
377
+ }
378
+ ```
379
+ 取引を指定の取引説明文でフィルターします。
380
+
381
+ 取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
382
+
285
383
  ---
286
384
  成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
287
385
  <a name="create-transaction"></a>
@@ -292,15 +390,21 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
292
390
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
293
391
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
294
392
  "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"
393
+ money_amount: 534,
394
+ point_amount: 1195,
395
+ point_expires_at: "2023-05-29T08:46:58.000000+09:00", # ポイント有効期限
396
+ description: "N6lsKCXAkk07Q9YuV27x2ZZwJNPJ0aXH1uRWCYsw6VRBfXAF7xeoT0y6lNlDnKEOyMV89HUL5OwvTmfk"
299
397
  ))
300
398
  ```
301
399
 
302
400
  ---
303
401
  `point_expires_at`
402
+ ```json
403
+ {
404
+ "type": "string",
405
+ "format": "date-time"
406
+ }
407
+ ```
304
408
  ポイントをチャージした場合の、付与されるポイントの有効期限です。
305
409
  省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
306
410
 
@@ -315,60 +419,123 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
315
419
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
316
420
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
317
421
  bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
318
- money_amount: 5960, # マネー額
319
- point_amount: 6566, # ポイント額
320
- point_expires_at: "2020-06-09T20:49:01.000000+09:00", # ポイント有効期限
321
- description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
422
+ money_amount: 6611, # マネー額
423
+ point_amount: 3184, # ポイント額
424
+ point_expires_at: "2024-11-16T15:12:20.000000+09:00", # ポイント有効期限
425
+ description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
426
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
322
427
  ))
323
428
  ```
324
429
 
325
430
  ---
326
431
  `shop_id`
432
+ ```json
433
+ {
434
+ "type": "string",
435
+ "format": "uuid"
436
+ }
437
+ ```
327
438
  店舗IDです。
328
439
 
329
440
  送金元の店舗を指定します。
330
441
 
331
442
  ---
332
443
  `customer_id`
444
+ ```json
445
+ {
446
+ "type": "string",
447
+ "format": "uuid"
448
+ }
449
+ ```
333
450
  エンドユーザーIDです。
334
451
 
335
452
  送金先のエンドユーザーを指定します。
336
453
 
337
454
  ---
338
455
  `private_money_id`
456
+ ```json
457
+ {
458
+ "type": "string",
459
+ "format": "uuid"
460
+ }
461
+ ```
339
462
  マネーIDです。
340
463
 
341
464
  マネーを指定します。
342
465
 
343
466
  ---
344
467
  `bear_point_shop_id`
468
+ ```json
469
+ {
470
+ "type": "string",
471
+ "format": "uuid"
472
+ }
473
+ ```
345
474
  ポイント支払時の負担店舗IDです。
346
475
 
347
476
  ポイント支払い時に実際お金を負担する店舗を指定します。
348
477
 
349
478
  ---
350
479
  `money_amount`
480
+ ```json
481
+ {
482
+ "type": "number",
483
+ "minimum": 0
484
+ }
485
+ ```
351
486
  マネー額です。
352
487
 
353
488
  送金するマネー額を指定します。
354
489
 
355
490
  ---
356
491
  `point_amount`
492
+ ```json
493
+ {
494
+ "type": "number",
495
+ "minimum": 0
496
+ }
497
+ ```
357
498
  ポイント額です。
358
499
 
359
500
  送金するポイント額を指定します。
360
501
 
361
502
  ---
362
503
  `point_expires_at`
504
+ ```json
505
+ {
506
+ "type": "string",
507
+ "format": "date-time"
508
+ }
509
+ ```
363
510
  ポイントをチャージした場合の、付与されるポイントの有効期限です。
364
511
  省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
365
512
 
366
513
  ---
367
514
  `description`
515
+ ```json
516
+ {
517
+ "type": "string",
518
+ "maxLength": 200
519
+ }
520
+ ```
368
521
  取引説明文です。
369
522
 
370
523
  任意入力で、取引履歴に表示される説明文です。
371
524
 
525
+ ---
526
+ `request_id`
527
+ ```json
528
+ {
529
+ "type": "string",
530
+ "format": "uuid"
531
+ }
532
+ ```
533
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
534
+
535
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
536
+
537
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
538
+
372
539
  ---
373
540
  成功したときは[Transaction](#transaction)オブジェクトを返します
374
541
  <a name="create-payment-transaction"></a>
@@ -381,41 +548,86 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
381
548
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
382
549
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
383
550
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
384
- 5274, # amount: 支払い額
385
- description: "たい焼き(小倉)" # 取引履歴に表示する説明文
551
+ 7587, # amount: 支払い額
552
+ description: "たい焼き(小倉)", # 取引履歴に表示する説明文
553
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
386
554
  ))
387
555
  ```
388
556
 
389
557
  ---
390
558
  `shop_id`
559
+ ```json
560
+ {
561
+ "type": "string",
562
+ "format": "uuid"
563
+ }
564
+ ```
391
565
  店舗IDです。
392
566
 
393
567
  送金先の店舗を指定します。
394
568
 
395
569
  ---
396
570
  `customer_id`
571
+ ```json
572
+ {
573
+ "type": "string",
574
+ "format": "uuid"
575
+ }
576
+ ```
397
577
  エンドユーザーIDです。
398
578
 
399
579
  送金元のエンドユーザーを指定します。
400
580
 
401
581
  ---
402
582
  `private_money_id`
583
+ ```json
584
+ {
585
+ "type": "string",
586
+ "format": "uuid"
587
+ }
588
+ ```
403
589
  マネーIDです。
404
590
 
405
591
  マネーを指定します。
406
592
 
407
593
  ---
408
594
  `amount`
595
+ ```json
596
+ {
597
+ "type": "number",
598
+ "minimum": 0
599
+ }
600
+ ```
409
601
  マネー額です。
410
602
 
411
603
  送金するマネー額を指定します。
412
604
 
413
605
  ---
414
606
  `description`
607
+ ```json
608
+ {
609
+ "type": "string",
610
+ "maxLength": 200
611
+ }
612
+ ```
415
613
  取引説明文です。
416
614
 
417
615
  任意入力で、取引履歴に表示される説明文です。
418
616
 
617
+ ---
618
+ `request_id`
619
+ ```json
620
+ {
621
+ "type": "string",
622
+ "format": "uuid"
623
+ }
624
+ ```
625
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
626
+
627
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
628
+
629
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
630
+
419
631
  ---
420
632
  成功したときは[Transaction](#transaction)オブジェクトを返します
421
633
  <a name="create-transfer-transaction"></a>
@@ -428,41 +640,86 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
428
640
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
429
641
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
430
642
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
431
- 9429, # amount: 送金額
432
- description: "たい焼き(小倉)" # 取引履歴に表示する説明文
643
+ 9515, # amount: 送金額
644
+ description: "たい焼き(小倉)", # 取引履歴に表示する説明文
645
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
433
646
  ))
434
647
  ```
435
648
 
436
649
  ---
437
650
  `sender_id`
651
+ ```json
652
+ {
653
+ "type": "string",
654
+ "format": "uuid"
655
+ }
656
+ ```
438
657
  エンドユーザーIDです。
439
658
 
440
659
  送金元のエンドユーザー(送り主)を指定します。
441
660
 
442
661
  ---
443
662
  `receiver_id`
663
+ ```json
664
+ {
665
+ "type": "string",
666
+ "format": "uuid"
667
+ }
668
+ ```
444
669
  エンドユーザーIDです。
445
670
 
446
671
  送金先のエンドユーザー(受け取り人)を指定します。
447
672
 
448
673
  ---
449
674
  `private_money_id`
675
+ ```json
676
+ {
677
+ "type": "string",
678
+ "format": "uuid"
679
+ }
680
+ ```
450
681
  マネーIDです。
451
682
 
452
683
  マネーを指定します。
453
684
 
454
685
  ---
455
686
  `amount`
687
+ ```json
688
+ {
689
+ "type": "number",
690
+ "minimum": 0
691
+ }
692
+ ```
456
693
  マネー額です。
457
694
 
458
695
  送金するマネー額を指定します。
459
696
 
460
697
  ---
461
698
  `description`
699
+ ```json
700
+ {
701
+ "type": "string",
702
+ "maxLength": 200
703
+ }
704
+ ```
462
705
  取引説明文です。
463
706
 
464
707
  任意入力で、取引履歴に表示される説明文です。
465
708
 
709
+ ---
710
+ `request_id`
711
+ ```json
712
+ {
713
+ "type": "string",
714
+ "format": "uuid"
715
+ }
716
+ ```
717
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
718
+
719
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
720
+
721
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
722
+
466
723
  ---
467
724
  成功したときは[Transaction](#transaction)オブジェクトを返します
468
725
  <a name="create-exchange-transaction"></a>
@@ -472,10 +729,27 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
472
729
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
473
730
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
474
731
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
475
- 3501,
476
- description: "ruJxi1ST1WXtfeKSzrq1Zc5Ju53UYOCwl5C8rEq5yNfh8NoRe5rX0rVCmpqdlLHNNlbdnW1ooZFRDSiyltrhPzNi7jenj4X3xdXKxR7POl5XLEB6rdcoyFq3Dy2RXyPUA"
732
+ 4983,
733
+ description: "sJQRiuvWpRkphzntqbTr2vHF1iF0Y7dBxe8hiTzwkLtzBfAa7kaQm6vULSy1FKdTtu83N0tnRGbdpbMjOs6NsjUaiDroY6Q3IK7BQ6AmswdAM3IJrwVbs9pMxfMCth",
734
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
477
735
  ))
478
736
  ```
737
+
738
+ ---
739
+ `request_id`
740
+ ```json
741
+ {
742
+ "type": "string",
743
+ "format": "uuid"
744
+ }
745
+ ```
746
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
747
+
748
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
749
+
750
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
751
+
752
+ ---
479
753
  成功したときは[Transaction](#transaction)オブジェクトを返します
480
754
  <a name="get-transaction"></a>
481
755
  #### 取引情報を取得する
@@ -488,31 +762,95 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
488
762
 
489
763
  ---
490
764
  `transaction_id`
765
+ ```json
766
+ {
767
+ "type": "string",
768
+ "format": "uuid"
769
+ }
770
+ ```
491
771
  取引IDです。
492
772
 
493
773
  フィルターとして使われ、指定した取引IDの取引を取得します。
494
774
 
495
775
  ---
496
776
  成功したときは[Transaction](#transaction)オブジェクトを返します
777
+ <a name="refund-transaction"></a>
778
+ #### 返金する
779
+ ```ruby
780
+ response = $client.send(Pokepay::Request::RefundTransaction.new(
781
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
782
+ description: "返品対応のため" # 取引履歴に表示する返金事由
783
+ ))
784
+ ```
785
+ 成功したときは[Transaction](#transaction)オブジェクトを返します
497
786
  <a name="list-transfers"></a>
498
787
  ####
499
788
  ```ruby
500
789
  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,
790
+ from: "2016-06-14T19:11:56.000000+09:00",
791
+ to: "2022-09-27T00:44:53.000000+09:00",
792
+ page: 3877,
793
+ per_page: 9011,
505
794
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
506
- shop_name: "gOIxNaz33MDlMm45c417ClVPZadCz21oTLg0Zh082rSUmgTJgltXUvopMAE6nKVgCC79b4Ei190OQ71CLczodkHUHlo8UiDVjyL8K2mxNxSNDBAB21jRDnDfUt4YgIyZaTsiHOmcCShoExxXDzwmu0NmtxroKVUk7sDu4lw8ZxL5",
795
+ shop_name: "EHFmQw4OmJsXraAGliEBPmHrH76ocsr7yZptwOIMGRxZLktLdV7uiWarFr5GP0wp4l70Zs",
507
796
  customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
508
- customer_name: "oBCUmbexHlOYPdRDRXfcFEKebPAHiatKRmL7K8IMJIBW1vB1RC8WQ75Zq2CPEph5LyiHrKKZHYeA6KMsRSBkbfNhFwjSSUkqouGV2ULftf3KLiOm",
797
+ customer_name: "yPlyZYRURgUMf0P5ozHDn0iOeoWIRRMyR0nQkh8Zz7eaFGoiOPKR0rUW9UTcnGDBsZuPfABdiNvfS9Anufij6THnocikBJOkD3FvwnaI0WeOGlWmmegc1KGhe3TxnuKac7CS1DK4Gnrr3oBLGMXHrz9mqfRhRmUp8pN9pjtBKEK15Dd3XxCT0Zmu6u7tOxquneNatGol",
509
798
  transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
510
799
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
511
- is_modified: true,
512
- transaction_types: ["topup", "transfer", "exchange"],
513
- transfer_types: ["exchange", "payment"]
800
+ is_modified: false,
801
+ transaction_types: ["transfer", "exchange"],
802
+ transfer_types: ["transfer", "topup", "payment", "campaign", "exchange", "coupon"], # 取引明細の種類でフィルターします。
803
+ description: "店頭QRコードによる支払い" # 取引詳細説明文
514
804
  ))
515
805
  ```
806
+
807
+ ---
808
+ `transfer_types`
809
+ ```json
810
+ {
811
+ "type": "array",
812
+ "items": {
813
+ "type": "string",
814
+ "enum": {
815
+ "topup": "payment",
816
+ "exchange": "transfer",
817
+ "coupon": "campaign"
818
+ }
819
+ }
820
+ }
821
+ ```
822
+ 取引明細の種類でフィルターします。
823
+
824
+ 以下の種類を指定できます。
825
+
826
+ 1. topup
827
+ 店舗からエンドユーザーへの送金取引(チャージ)、またはそのキャンセル取引
828
+
829
+ 2. payment
830
+ エンドユーザーから店舗への送金取引(支払い)、またはそのキャンセル取引
831
+
832
+ 3. exchange
833
+ 他マネーへの流出/流入
834
+
835
+ 4. campaign
836
+ 取引に対するポイント還元キャンペーンによるポイント付与、またはそのキャンセル取引
837
+
838
+ 5. coupon
839
+ クーポンによる値引き処理、またはそのキャンセル取引
840
+
841
+ ---
842
+ `description`
843
+ ```json
844
+ {
845
+ "type": "string",
846
+ "maxLength": 200
847
+ }
848
+ ```
849
+ 取引詳細を指定の取引詳細説明文でフィルターします。
850
+
851
+ 取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
852
+
853
+ ---
516
854
  成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
517
855
  ### Check
518
856
  店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
@@ -538,12 +876,24 @@ response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
538
876
 
539
877
  ---
540
878
  `check_id`
879
+ ```json
880
+ {
881
+ "type": "string",
882
+ "format": "uuid"
883
+ }
884
+ ```
541
885
  チャージ用QRコードのIDです。
542
886
 
543
887
  QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
544
888
 
545
889
  ---
546
890
  `customer_id`
891
+ ```json
892
+ {
893
+ "type": "string",
894
+ "format": "uuid"
895
+ }
896
+ ```
547
897
  エンドユーザーIDです。
548
898
 
549
899
  送金先のエンドユーザーを指定します。
@@ -557,76 +907,151 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
557
907
  支払いQRコード一覧を表示します。
558
908
  ```ruby
559
909
  response = $client.send(Pokepay::Request::ListBills.new(
560
- page: 532, # ページ番号
561
- per_page: 218, # 1ページの表示数
562
- bill_id: "WM", # 支払いQRコードのID
910
+ page: 4107, # ページ番号
911
+ per_page: 1151, # 1ページの表示数
912
+ bill_id: "yMS6WkNJ2", # 支払いQRコードのID
563
913
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
564
- organization_code: "--9", # 組織コード
914
+ organization_code: "--y6-I0", # 組織コード
565
915
  description: "test bill", # 取引説明文
566
- created_from: "2016-02-26T19:01:25.000000+09:00", # 作成日時(起点)
567
- created_to: "2021-01-22T10:47:37.000000+09:00", # 作成日時(終点)
916
+ created_from: "2017-06-06T23:19:55.000000+09:00", # 作成日時(起点)
917
+ created_to: "2024-08-04T19:51:44.000000+09:00", # 作成日時(終点)
568
918
  shop_name: "bill test shop1", # 店舗名
569
919
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
570
- lower_limit_amount: 4942, # 金額の範囲によるフィルタ(下限)
571
- upper_limit_amount: 1563, # 金額の範囲によるフィルタ(上限)
920
+ lower_limit_amount: 8925, # 金額の範囲によるフィルタ(下限)
921
+ upper_limit_amount: 149, # 金額の範囲によるフィルタ(上限)
572
922
  is_disabled: true # 支払いQRコードが無効化されているかどうか
573
923
  ))
574
924
  ```
575
925
 
576
926
  ---
577
927
  `page`
928
+ ```json
929
+ {
930
+ "type": "integer",
931
+ "minimum": 1
932
+ }
933
+ ```
578
934
  取得したいページ番号です。
579
935
 
580
936
  ---
581
937
  `per_page`
938
+ ```json
939
+ {
940
+ "type": "integer",
941
+ "minimum": 1
942
+ }
943
+ ```
582
944
  1ページに表示する支払いQRコードの数です。
583
945
 
584
946
  ---
585
947
  `bill_id`
948
+ ```json
949
+ { "type": "string" }
950
+ ```
586
951
  支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
587
952
 
588
953
  ---
589
954
  `private_money_id`
955
+ ```json
956
+ {
957
+ "type": "string",
958
+ "format": "uuid"
959
+ }
960
+ ```
590
961
  支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
591
962
 
592
963
  ---
593
964
  `organization_code`
965
+ ```json
966
+ {
967
+ "type": "string",
968
+ "maxLength": 32,
969
+ "pattern": "^[a-zA-Z0-9-]*$"
970
+ }
971
+ ```
594
972
  支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
595
973
 
596
974
  ---
597
975
  `description`
976
+ ```json
977
+ {
978
+ "type": "string",
979
+ "maxLength": 200
980
+ }
981
+ ```
598
982
  支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
599
983
 
600
984
  ---
601
985
  `created_from`
986
+ ```json
987
+ {
988
+ "type": "string",
989
+ "format": "date-time"
990
+ }
991
+ ```
602
992
  支払いQRコードの作成日時でフィルターします。
603
993
 
604
994
  これ以降に作成された支払いQRコードのみ一覧に表示されます。
605
995
 
606
996
  ---
607
997
  `created_to`
998
+ ```json
999
+ {
1000
+ "type": "string",
1001
+ "format": "date-time"
1002
+ }
1003
+ ```
608
1004
  支払いQRコードの作成日時でフィルターします。
609
1005
 
610
1006
  これ以前に作成された支払いQRコードのみ一覧に表示されます。
611
1007
 
612
1008
  ---
613
1009
  `shop_name`
1010
+ ```json
1011
+ {
1012
+ "type": "string",
1013
+ "maxLength": 256
1014
+ }
1015
+ ```
614
1016
  支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
615
1017
 
616
1018
  ---
617
1019
  `shop_id`
1020
+ ```json
1021
+ {
1022
+ "type": "string",
1023
+ "format": "uuid"
1024
+ }
1025
+ ```
618
1026
  支払いQRコードを作成した店舗IDでフィルターします。
619
1027
 
620
1028
  ---
621
1029
  `lower_limit_amount`
1030
+ ```json
1031
+ {
1032
+ "type": "integer",
1033
+ "format": "decimal",
1034
+ "minimum": 0
1035
+ }
1036
+ ```
622
1037
  支払いQRコードの金額の下限を指定してフィルターします。
623
1038
 
624
1039
  ---
625
1040
  `upper_limit_amount`
1041
+ ```json
1042
+ {
1043
+ "type": "integer",
1044
+ "format": "decimal",
1045
+ "minimum": 0
1046
+ }
1047
+ ```
626
1048
  支払いQRコードの金額の上限を指定してフィルターします。
627
1049
 
628
1050
  ---
629
1051
  `is_disabled`
1052
+ ```json
1053
+ { "type": "boolean" }
1054
+ ```
630
1055
  支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
631
1056
 
632
1057
  ---
@@ -638,13 +1063,20 @@ response = $client.send(Pokepay::Request::ListBills.new(
638
1063
  response = $client.send(Pokepay::Request::CreateBill.new(
639
1064
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
640
1065
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
641
- amount: 3512, # 支払い額
1066
+ amount: 1855, # 支払い額
642
1067
  description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
643
1068
  ))
644
1069
  ```
645
1070
 
646
1071
  ---
647
1072
  `amount`
1073
+ ```json
1074
+ {
1075
+ "type": "number",
1076
+ "format": "decimal",
1077
+ "minimum": 0
1078
+ }
1079
+ ```
648
1080
  支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
649
1081
 
650
1082
  ---
@@ -655,26 +1087,48 @@ response = $client.send(Pokepay::Request::CreateBill.new(
655
1087
  ```ruby
656
1088
  response = $client.send(Pokepay::Request::UpdateBill.new(
657
1089
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
658
- amount: 2045, # 支払い額
1090
+ amount: 7862, # 支払い額
659
1091
  description: "test bill", # 説明文
660
- is_disabled: true # 無効化されているかどうか
1092
+ is_disabled: false # 無効化されているかどうか
661
1093
  ))
662
1094
  ```
663
1095
 
664
1096
  ---
665
1097
  `bill_id`
1098
+ ```json
1099
+ {
1100
+ "type": "string",
1101
+ "format": "uuid"
1102
+ }
1103
+ ```
666
1104
  更新対象の支払いQRコードのIDです。
667
1105
 
668
1106
  ---
669
1107
  `amount`
1108
+ ```json
1109
+ {
1110
+ "type": "number",
1111
+ "format": "decimal",
1112
+ "minimum": 0
1113
+ }
1114
+ ```
670
1115
  支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
671
1116
 
672
1117
  ---
673
1118
  `description`
1119
+ ```json
1120
+ {
1121
+ "type": "string",
1122
+ "maxLength": 200
1123
+ }
1124
+ ```
674
1125
  支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
675
1126
 
676
1127
  ---
677
1128
  `is_disabled`
1129
+ ```json
1130
+ { "type": "boolean" }
1131
+ ```
678
1132
  支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
679
1133
 
680
1134
  ---
@@ -698,32 +1152,59 @@ Cashtrayを作成します。
698
1152
  response = $client.send(Pokepay::Request::CreateCashtray.new(
699
1153
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
700
1154
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
701
- 1828, # amount: 金額
1155
+ 2752, # amount: 金額
702
1156
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
703
- expires_in: 3161 # 失効時間(秒)
1157
+ expires_in: 1057 # 失効時間(秒)
704
1158
  ))
705
1159
  ```
706
1160
 
707
1161
  ---
708
1162
  `private_money_id`
1163
+ ```json
1164
+ {
1165
+ "type": "string",
1166
+ "format": "uuid"
1167
+ }
1168
+ ```
709
1169
  取引対象のマネーのIDです(必須項目)。
710
1170
 
711
1171
  ---
712
1172
  `shop_id`
1173
+ ```json
1174
+ {
1175
+ "type": "string",
1176
+ "format": "uuid"
1177
+ }
1178
+ ```
713
1179
  店舗のユーザーIDです(必須項目)。
714
1180
 
715
1181
  ---
716
1182
  `amount`
1183
+ ```json
1184
+ { "type": "number" }
1185
+ ```
717
1186
  マネー額です(必須項目)。
718
1187
  正の値を与えるとチャージになり、負の値を与えると支払いとなります。
719
1188
 
720
1189
  ---
721
1190
  `description`
1191
+ ```json
1192
+ {
1193
+ "type": "string",
1194
+ "maxLength": 200
1195
+ }
1196
+ ```
722
1197
  Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
723
1198
  アプリや管理画面などの取引履歴に表示されます。デフォルトでは空文字になります。
724
1199
 
725
1200
  ---
726
1201
  `expires_in`
1202
+ ```json
1203
+ {
1204
+ "type": "integer",
1205
+ "minimum": 1
1206
+ }
1207
+ ```
727
1208
  Cashtrayが失効するまでの時間を秒単位で指定します(任意項目、デフォルト値は1800秒(30分))。
728
1209
 
729
1210
  ---
@@ -794,6 +1275,12 @@ response = $client.send(Pokepay::Request::GetCashtray.new(
794
1275
 
795
1276
  ---
796
1277
  `cashtray_id`
1278
+ ```json
1279
+ {
1280
+ "type": "string",
1281
+ "format": "uuid"
1282
+ }
1283
+ ```
797
1284
  情報を取得するCashtrayのIDです。
798
1285
 
799
1286
  ---
@@ -812,6 +1299,12 @@ response = $client.send(Pokepay::Request::CancelCashtray.new(
812
1299
 
813
1300
  ---
814
1301
  `cashtray_id`
1302
+ ```json
1303
+ {
1304
+ "type": "string",
1305
+ "format": "uuid"
1306
+ }
1307
+ ```
815
1308
  無効化するCashtrayのIDです。
816
1309
 
817
1310
  ---
@@ -822,28 +1315,49 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
822
1315
  ```ruby
823
1316
  response = $client.send(Pokepay::Request::UpdateCashtray.new(
824
1317
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
825
- amount: 987, # 金額
1318
+ amount: 781, # 金額
826
1319
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
827
- expires_in: 5471 # 失効時間(秒)
1320
+ expires_in: 1632 # 失効時間(秒)
828
1321
  ))
829
1322
  ```
830
1323
 
831
1324
  ---
832
1325
  `cashtray_id`
1326
+ ```json
1327
+ {
1328
+ "type": "string",
1329
+ "format": "uuid"
1330
+ }
1331
+ ```
833
1332
  更新対象のCashtrayのIDです。
834
1333
 
835
1334
  ---
836
1335
  `amount`
1336
+ ```json
1337
+ { "type": "number" }
1338
+ ```
837
1339
  マネー額です(任意項目)。
838
1340
  正の値を与えるとチャージになり、負の値を与えると支払いとなります。
839
1341
 
840
1342
  ---
841
1343
  `description`
1344
+ ```json
1345
+ {
1346
+ "type": "string",
1347
+ "maxLength": 200
1348
+ }
1349
+ ```
842
1350
  Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
843
1351
  アプリや管理画面などの取引履歴に表示されます。
844
1352
 
845
1353
  ---
846
1354
  `expires_in`
1355
+ ```json
1356
+ {
1357
+ "type": "integer",
1358
+ "minimum": 1
1359
+ }
1360
+ ```
847
1361
  Cashtrayが失効するまでの時間を秒で指定します(任意項目、デフォルト値は1800秒(30分))。
848
1362
 
849
1363
  ---
@@ -860,6 +1374,12 @@ response = $client.send(Pokepay::Request::GetAccount.new(
860
1374
 
861
1375
  ---
862
1376
  `account_id`
1377
+ ```json
1378
+ {
1379
+ "type": "string",
1380
+ "format": "uuid"
1381
+ }
1382
+ ```
863
1383
  ウォレットIDです。
864
1384
 
865
1385
  フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
@@ -878,12 +1398,21 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
878
1398
 
879
1399
  ---
880
1400
  `account_id`
1401
+ ```json
1402
+ {
1403
+ "type": "string",
1404
+ "format": "uuid"
1405
+ }
1406
+ ```
881
1407
  ウォレットIDです。
882
1408
 
883
1409
  指定したウォレットIDのウォレットの状態を更新します。
884
1410
 
885
1411
  ---
886
1412
  `is_suspended`
1413
+ ```json
1414
+ { "type": "boolean" }
1415
+ ```
887
1416
  ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
888
1417
 
889
1418
  ---
@@ -894,38 +1423,74 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
894
1423
  ```ruby
895
1424
  response = $client.send(Pokepay::Request::ListAccountBalances.new(
896
1425
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
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" # 有効期限によるソート順序
1426
+ page: 1479, # ページ番号
1427
+ per_page: 7500, # 1ページ分の取引数
1428
+ expires_at_from: "2021-02-11T09:11:28.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1429
+ expires_at_to: "2022-08-08T00:02:11.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
1430
+ direction: "asc" # 有効期限によるソート順序
902
1431
  ))
903
1432
  ```
904
1433
 
905
1434
  ---
906
1435
  `account_id`
1436
+ ```json
1437
+ {
1438
+ "type": "string",
1439
+ "format": "uuid"
1440
+ }
1441
+ ```
907
1442
  ウォレットIDです。
908
1443
 
909
1444
  フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
910
1445
 
911
1446
  ---
912
1447
  `page`
1448
+ ```json
1449
+ {
1450
+ "type": "integer",
1451
+ "minimum": 1
1452
+ }
1453
+ ```
913
1454
  取得したいページ番号です。デフォルト値は1です。
914
1455
 
915
1456
  ---
916
1457
  `per_page`
1458
+ ```json
1459
+ {
1460
+ "type": "integer",
1461
+ "minimum": 1
1462
+ }
1463
+ ```
917
1464
  1ページ分のウォレット残高数です。デフォルト値は30です。
918
1465
 
919
1466
  ---
920
1467
  `expires_at_from`
1468
+ ```json
1469
+ {
1470
+ "type": "string",
1471
+ "format": "date-time"
1472
+ }
1473
+ ```
921
1474
  有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
922
1475
 
923
1476
  ---
924
1477
  `expires_at_to`
1478
+ ```json
1479
+ {
1480
+ "type": "string",
1481
+ "format": "date-time"
1482
+ }
1483
+ ```
925
1484
  有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
926
1485
 
927
1486
  ---
928
1487
  `direction`
1488
+ ```json
1489
+ {
1490
+ "type": "string",
1491
+ "enum": { "asc": "desc" }
1492
+ }
1493
+ ```
929
1494
  有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
930
1495
 
931
1496
  ---
@@ -936,42 +1501,153 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
936
1501
  ```ruby
937
1502
  response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
938
1503
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
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", # 有効期限の期間によるフィルター(終了時点)
1504
+ page: 8104, # ページ番号
1505
+ per_page: 1970, # 1ページ分の取引数
1506
+ expires_at_from: "2019-12-01T21:52:13.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1507
+ expires_at_to: "2022-06-02T02:05:40.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
943
1508
  direction: "desc" # 有効期限によるソート順序
944
1509
  ))
945
1510
  ```
946
1511
 
947
1512
  ---
948
1513
  `account_id`
1514
+ ```json
1515
+ {
1516
+ "type": "string",
1517
+ "format": "uuid"
1518
+ }
1519
+ ```
949
1520
  ウォレットIDです。
950
1521
 
951
1522
  フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
952
1523
 
953
1524
  ---
954
1525
  `page`
1526
+ ```json
1527
+ {
1528
+ "type": "integer",
1529
+ "minimum": 1
1530
+ }
1531
+ ```
955
1532
  取得したいページ番号です。デフォルト値は1です。
956
1533
 
957
1534
  ---
958
1535
  `per_page`
1536
+ ```json
1537
+ {
1538
+ "type": "integer",
1539
+ "minimum": 1
1540
+ }
1541
+ ```
959
1542
  1ページ分のウォレット残高数です。デフォルト値は30です。
960
1543
 
961
1544
  ---
962
1545
  `expires_at_from`
1546
+ ```json
1547
+ {
1548
+ "type": "string",
1549
+ "format": "date-time"
1550
+ }
1551
+ ```
963
1552
  有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
964
1553
 
965
1554
  ---
966
1555
  `expires_at_to`
1556
+ ```json
1557
+ {
1558
+ "type": "string",
1559
+ "format": "date-time"
1560
+ }
1561
+ ```
967
1562
  有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
968
1563
 
969
1564
  ---
970
1565
  `direction`
1566
+ ```json
1567
+ {
1568
+ "type": "string",
1569
+ "enum": { "asc": "desc" }
1570
+ }
1571
+ ```
971
1572
  有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
972
1573
 
973
1574
  ---
974
1575
  成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
1576
+ <a name="get-customer-accounts"></a>
1577
+ #### エンドユーザーのウォレット一覧を表示する
1578
+ マネーを指定してエンドユーザーのウォレット一覧を取得します。
1579
+ ```ruby
1580
+ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
1581
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1582
+ page: 3492, # ページ番号
1583
+ per_page: 7179, # 1ページ分のウォレット数
1584
+ created_at_from: "2019-05-15T08:37:19.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1585
+ created_at_to: "2016-06-13T22:28:14.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1586
+ is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
1587
+ ))
1588
+ ```
1589
+
1590
+ ---
1591
+ `private_money_id`
1592
+ ```json
1593
+ {
1594
+ "type": "string",
1595
+ "format": "uuid"
1596
+ }
1597
+ ```
1598
+ マネーIDです。
1599
+
1600
+ 一覧するウォレットのマネーを指定します。このパラメータは必須です。
1601
+
1602
+ ---
1603
+ `page`
1604
+ ```json
1605
+ {
1606
+ "type": "integer",
1607
+ "minimum": 1
1608
+ }
1609
+ ```
1610
+ 取得したいページ番号です。デフォルト値は1です。
1611
+
1612
+ ---
1613
+ `per_page`
1614
+ ```json
1615
+ {
1616
+ "type": "integer",
1617
+ "minimum": 1
1618
+ }
1619
+ ```
1620
+ 1ページ分のウォレット数です。デフォルト値は30です。
1621
+
1622
+ ---
1623
+ `created_at_from`
1624
+ ```json
1625
+ {
1626
+ "type": "string",
1627
+ "format": "date-time"
1628
+ }
1629
+ ```
1630
+ ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
1631
+
1632
+ ---
1633
+ `created_at_to`
1634
+ ```json
1635
+ {
1636
+ "type": "string",
1637
+ "format": "date-time"
1638
+ }
1639
+ ```
1640
+ ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
1641
+
1642
+ ---
1643
+ `is_suspended`
1644
+ ```json
1645
+ { "type": "boolean" }
1646
+ ```
1647
+ このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
1648
+
1649
+ ---
1650
+ 成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
975
1651
  <a name="create-customer-account"></a>
976
1652
  #### 新規エンドユーザーウォレットを追加する
977
1653
  指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
@@ -985,20 +1661,113 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
985
1661
 
986
1662
  ---
987
1663
  `private_money_id`
1664
+ ```json
1665
+ {
1666
+ "type": "string",
1667
+ "format": "uuid"
1668
+ }
1669
+ ```
988
1670
  マネーIDです。
989
1671
 
990
1672
  これによって作成するウォレットのマネーを指定します。
991
1673
 
992
1674
  ---
993
1675
  `user_name`
1676
+ ```json
1677
+ {
1678
+ "type": "string",
1679
+ "maxLength": 256
1680
+ }
1681
+ ```
994
1682
  ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
995
1683
 
996
1684
  ---
997
1685
  `account_name`
1686
+ ```json
1687
+ {
1688
+ "type": "string",
1689
+ "maxLength": 256
1690
+ }
1691
+ ```
998
1692
  作成するウォレット名です。省略した場合は空文字となります。
999
1693
 
1000
1694
  ---
1001
1695
  成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
1696
+ <a name="get-shop-accounts"></a>
1697
+ #### 店舗ユーザーのウォレット一覧を表示する
1698
+ マネーを指定して店舗ユーザーのウォレット一覧を取得します。
1699
+ ```ruby
1700
+ response = $client.send(Pokepay::Request::GetShopAccounts.new(
1701
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1702
+ page: 6974, # ページ番号
1703
+ per_page: 6258, # 1ページ分のウォレット数
1704
+ created_at_from: "2021-12-09T06:29:53.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1705
+ created_at_to: "2022-01-08T09:28:00.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1706
+ is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
1707
+ ))
1708
+ ```
1709
+
1710
+ ---
1711
+ `private_money_id`
1712
+ ```json
1713
+ {
1714
+ "type": "string",
1715
+ "format": "uuid"
1716
+ }
1717
+ ```
1718
+ マネーIDです。
1719
+
1720
+ 一覧するウォレットのマネーを指定します。このパラメータは必須です。
1721
+
1722
+ ---
1723
+ `page`
1724
+ ```json
1725
+ {
1726
+ "type": "integer",
1727
+ "minimum": 1
1728
+ }
1729
+ ```
1730
+ 取得したいページ番号です。デフォルト値は1です。
1731
+
1732
+ ---
1733
+ `per_page`
1734
+ ```json
1735
+ {
1736
+ "type": "integer",
1737
+ "minimum": 1
1738
+ }
1739
+ ```
1740
+ 1ページ分のウォレット数です。デフォルト値は30です。
1741
+
1742
+ ---
1743
+ `created_at_from`
1744
+ ```json
1745
+ {
1746
+ "type": "string",
1747
+ "format": "date-time"
1748
+ }
1749
+ ```
1750
+ ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
1751
+
1752
+ ---
1753
+ `created_at_to`
1754
+ ```json
1755
+ {
1756
+ "type": "string",
1757
+ "format": "date-time"
1758
+ }
1759
+ ```
1760
+ ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
1761
+
1762
+ ---
1763
+ `is_suspended`
1764
+ ```json
1765
+ { "type": "boolean" }
1766
+ ```
1767
+ このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
1768
+
1769
+ ---
1770
+ 成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
1002
1771
  <a name="list-customer-transactions"></a>
1003
1772
  #### 取引履歴を取得する
1004
1773
  取引一覧を返します。
@@ -1007,10 +1776,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
1007
1776
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1008
1777
  sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
1009
1778
  receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
1010
- type: "L", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
1779
+ type: "N9jftsBTkZ", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
1011
1780
  is_modified: true, # キャンセル済みかどうか
1012
- from: "2017-03-01T02:18:01.000000+09:00", # 開始日時
1013
- to: "2021-08-14T21:55:36.000000+09:00", # 終了日時
1781
+ from: "2019-07-11T14:20:45.000000+09:00", # 開始日時
1782
+ to: "2019-01-16T06:48:10.000000+09:00", # 終了日時
1014
1783
  page: 1, # ページ番号
1015
1784
  per_page: 50 # 1ページ分の取引数
1016
1785
  ))
@@ -1018,23 +1787,44 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
1018
1787
 
1019
1788
  ---
1020
1789
  `private_money_id`
1790
+ ```json
1791
+ {
1792
+ "type": "string",
1793
+ "format": "uuid"
1794
+ }
1795
+ ```
1021
1796
  マネーIDです。
1022
1797
  フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
1023
1798
 
1024
1799
  ---
1025
1800
  `sender_customer_id`
1801
+ ```json
1802
+ {
1803
+ "type": "string",
1804
+ "format": "uuid"
1805
+ }
1806
+ ```
1026
1807
  送金ユーザーIDです。
1027
1808
 
1028
1809
  フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
1029
1810
 
1030
1811
  ---
1031
1812
  `receiver_customer_id`
1813
+ ```json
1814
+ {
1815
+ "type": "string",
1816
+ "format": "uuid"
1817
+ }
1818
+ ```
1032
1819
  受取ユーザーIDです。
1033
1820
 
1034
1821
  フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
1035
1822
 
1036
1823
  ---
1037
1824
  `type`
1825
+ ```json
1826
+ { "type": "string" }
1827
+ ```
1038
1828
  取引の種類でフィルターします。
1039
1829
 
1040
1830
  以下の種類を指定できます。
@@ -1050,6 +1840,9 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
1050
1840
 
1051
1841
  ---
1052
1842
  `is_modified`
1843
+ ```json
1844
+ { "type": "boolean" }
1845
+ ```
1053
1846
  キャンセル済みかどうかを判定するフラグです。
1054
1847
 
1055
1848
  これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
@@ -1058,22 +1851,46 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
1058
1851
 
1059
1852
  ---
1060
1853
  `from`
1854
+ ```json
1855
+ {
1856
+ "type": "string",
1857
+ "format": "date-time"
1858
+ }
1859
+ ```
1061
1860
  抽出期間の開始日時です。
1062
1861
 
1063
1862
  フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
1064
1863
 
1065
1864
  ---
1066
1865
  `to`
1866
+ ```json
1867
+ {
1868
+ "type": "string",
1869
+ "format": "date-time"
1870
+ }
1871
+ ```
1067
1872
  抽出期間の終了日時です。
1068
1873
 
1069
1874
  フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
1070
1875
 
1071
1876
  ---
1072
1877
  `page`
1878
+ ```json
1879
+ {
1880
+ "type": "integer",
1881
+ "minimum": 1
1882
+ }
1883
+ ```
1073
1884
  取得したいページ番号です。
1074
1885
 
1075
1886
  ---
1076
1887
  `per_page`
1888
+ ```json
1889
+ {
1890
+ "type": "integer",
1891
+ "minimum": 1
1892
+ }
1893
+ ```
1077
1894
  1ページ分の取引数です。
1078
1895
 
1079
1896
  ---
@@ -1087,11 +1904,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
1087
1904
  organization_code: "pocketchange", # 組織コード
1088
1905
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
1089
1906
  name: "oxスーパー三田店", # 店舗名
1090
- postal_code: "624-0001", # 店舗の郵便番号
1907
+ postal_code: "9793795", # 店舗の郵便番号
1091
1908
  address: "東京都港区芝...", # 店舗の住所
1092
- tel: "077-41-284", # 店舗の電話番号
1093
- email: "fAUj6MGuDC@QRgb.com", # 店舗のメールアドレス
1094
- external_id: "h69IfOOqdFvcvTYHWhMSc2JtDSCuxpXIBKj", # 店舗の外部ID
1909
+ tel: "03-45-292", # 店舗の電話番号
1910
+ email: "gXoYNaRDH3@xa5Z.com", # 店舗のメールアドレス
1911
+ external_id: "Xl3L94kmDiQZVmfdCV9wG", # 店舗の外部ID
1095
1912
  page: 1, # ページ番号
1096
1913
  per_page: 50 # 1ページ分の取引数
1097
1914
  ))
@@ -1099,50 +1916,113 @@ response = $client.send(Pokepay::Request::ListShops.new(
1099
1916
 
1100
1917
  ---
1101
1918
  `organization_code`
1919
+ ```json
1920
+ {
1921
+ "type": "string",
1922
+ "maxLength": 32,
1923
+ "pattern": "^[a-zA-Z0-9-]*$"
1924
+ }
1925
+ ```
1102
1926
  このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
1103
1927
 
1104
1928
 
1105
1929
  ---
1106
1930
  `private_money_id`
1931
+ ```json
1932
+ {
1933
+ "type": "string",
1934
+ "format": "uuid"
1935
+ }
1936
+ ```
1107
1937
  このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
1108
1938
 
1109
1939
 
1110
1940
  ---
1111
1941
  `name`
1942
+ ```json
1943
+ {
1944
+ "type": "string",
1945
+ "minLength": 1,
1946
+ "maxLength": 256
1947
+ }
1948
+ ```
1112
1949
  このパラメータを渡すとその名前の店舗のみが返されます。
1113
1950
 
1114
1951
 
1115
1952
  ---
1116
1953
  `postal_code`
1954
+ ```json
1955
+ {
1956
+ "type": "string",
1957
+ "pattern": "^[0-9]{3}-?[0-9]{4}$"
1958
+ }
1959
+ ```
1117
1960
  このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
1118
1961
 
1119
1962
 
1120
1963
  ---
1121
1964
  `address`
1965
+ ```json
1966
+ {
1967
+ "type": "string",
1968
+ "maxLength": 256
1969
+ }
1970
+ ```
1122
1971
  このパラメータを渡すとその住所が登録された店舗のみが返されます。
1123
1972
 
1124
1973
 
1125
1974
  ---
1126
1975
  `tel`
1976
+ ```json
1977
+ {
1978
+ "type": "string",
1979
+ "pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
1980
+ }
1981
+ ```
1127
1982
  このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
1128
1983
 
1129
1984
 
1130
1985
  ---
1131
1986
  `email`
1987
+ ```json
1988
+ {
1989
+ "type": "string",
1990
+ "format": "email",
1991
+ "maxLength": 256
1992
+ }
1993
+ ```
1132
1994
  このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
1133
1995
 
1134
1996
 
1135
1997
  ---
1136
1998
  `external_id`
1999
+ ```json
2000
+ {
2001
+ "type": "string",
2002
+ "maxLength": 36
2003
+ }
2004
+ ```
1137
2005
  このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
1138
2006
 
1139
2007
 
1140
2008
  ---
1141
2009
  `page`
2010
+ ```json
2011
+ {
2012
+ "type": "integer",
2013
+ "minimum": 1
2014
+ }
2015
+ ```
1142
2016
  取得したいページ番号です。
1143
2017
 
1144
2018
  ---
1145
2019
  `per_page`
2020
+ ```json
2021
+ {
2022
+ "type": "integer",
2023
+ "minimum": 1
2024
+ }
2025
+ ```
1146
2026
  1ページ分の取引数です。
1147
2027
 
1148
2028
  ---
@@ -1153,25 +2033,25 @@ response = $client.send(Pokepay::Request::ListShops.new(
1153
2033
  ```ruby
1154
2034
  response = $client.send(Pokepay::Request::CreateShop.new(
1155
2035
  "oxスーパー三田店", # shop_name: 店舗名
1156
- shop_postal_code: "8072594", # 店舗の郵便番号
2036
+ shop_postal_code: "5270015", # 店舗の郵便番号
1157
2037
  shop_address: "東京都港区芝...", # 店舗の住所
1158
- shop_tel: "083-7936908", # 店舗の電話番号
1159
- shop_email: "hctiEpL1Kl@L20S.com", # 店舗のメールアドレス
1160
- shop_external_id: "Y28CEIpXvCz2lX0WFgkUTJYHHO", # 店舗の外部ID
2038
+ shop_tel: "0434-32-763", # 店舗の電話番号
2039
+ shop_email: "ZmJCZwuee4@w9Rk.com", # 店舗のメールアドレス
2040
+ shop_external_id: "vag9C19xRl1IlJpGXqlhd5uwOg", # 店舗の外部ID
1161
2041
  organization_code: "ox-supermarket" # 組織コード
1162
2042
  ))
1163
2043
  ```
1164
2044
  成功したときは[User](#user)オブジェクトを返します
1165
- <a name="create-shop-v"></a>
2045
+ <a name="create-shop-v2"></a>
1166
2046
  #### 新規店舗を追加する
1167
2047
  ```ruby
1168
- response = $client.send(Pokepay::Request::CreateShopV.new(
2048
+ response = $client.send(Pokepay::Request::CreateShopV2.new(
1169
2049
  "oxスーパー三田店", # name: 店舗名
1170
- postal_code: "6626381", # 店舗の郵便番号
2050
+ postal_code: "534-0319", # 店舗の郵便番号
1171
2051
  address: "東京都港区芝...", # 店舗の住所
1172
- tel: "05763334042", # 店舗の電話番号
1173
- email: "jCOwyap0ls@b8d4.com", # 店舗のメールアドレス
1174
- external_id: "Dc5yMU1TN0yX6wxY6IPoPyEr8klnc", # 店舗の外部ID
2052
+ tel: "09598-3740", # 店舗の電話番号
2053
+ email: "nZxaZi9iCa@2kj9.com", # 店舗のメールアドレス
2054
+ external_id: "DD4FLU53H4", # 店舗の外部ID
1175
2055
  organization_code: "ox-supermarket", # 組織コード
1176
2056
  private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
1177
2057
  can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
@@ -1180,12 +2060,29 @@ response = $client.send(Pokepay::Request::CreateShopV.new(
1180
2060
 
1181
2061
  ---
1182
2062
  `name`
2063
+ ```json
2064
+ {
2065
+ "type": "string",
2066
+ "minLength": 1,
2067
+ "maxLength": 256
2068
+ }
2069
+ ```
1183
2070
  店舗名です。
1184
2071
 
1185
2072
  同一組織内に同名の店舗があった場合は`name_conflict`エラーが返ります。
1186
2073
 
1187
2074
  ---
1188
2075
  `private_money_ids`
2076
+ ```json
2077
+ {
2078
+ "type": "array",
2079
+ "minItems": 1,
2080
+ "items": {
2081
+ "type": "string",
2082
+ "format": "uuid"
2083
+ }
2084
+ }
2085
+ ```
1189
2086
  店舗で有効にするマネーIDの配列を指定します。
1190
2087
 
1191
2088
  店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
@@ -1193,6 +2090,16 @@ response = $client.send(Pokepay::Request::CreateShopV.new(
1193
2090
 
1194
2091
  ---
1195
2092
  `can_topup_private_money_ids`
2093
+ ```json
2094
+ {
2095
+ "type": "array",
2096
+ "minItems": 0,
2097
+ "items": {
2098
+ "type": "string",
2099
+ "format": "uuid"
2100
+ }
2101
+ }
2102
+ ```
1196
2103
  店舗でチャージ可能にするマネーIDの配列を指定します。
1197
2104
 
1198
2105
  このパラメータは発行体のみが指定でき、自身が発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
@@ -1218,40 +2125,82 @@ response = $client.send(Pokepay::Request::GetShop.new(
1218
2125
  response = $client.send(Pokepay::Request::UpdateShop.new(
1219
2126
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
1220
2127
  name: "oxスーパー三田店", # 店舗名
1221
- postal_code: "5576227", # 店舗の郵便番号
2128
+ postal_code: "445-1656", # 店舗の郵便番号
1222
2129
  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の配列
2130
+ tel: "008767500", # 店舗の電話番号
2131
+ email: "SdiADG37ey@dGEN.com", # 店舗のメールアドレス
2132
+ external_id: "PuSUGCPNHip0Y3", # 店舗の外部ID
2133
+ private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2134
+ can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
1228
2135
  ))
1229
2136
  ```
1230
2137
 
1231
2138
  ---
1232
2139
  `name`
2140
+ ```json
2141
+ {
2142
+ "type": "string",
2143
+ "minLength": 1,
2144
+ "maxLength": 256
2145
+ }
2146
+ ```
1233
2147
  店舗名です。
1234
2148
 
1235
2149
  同一組織内に同名の店舗があった場合は`shop_name_conflict`エラーが返ります。
1236
2150
 
1237
2151
  ---
1238
2152
  `postal_code`
2153
+ ```json
2154
+ {
2155
+ "type": "string",
2156
+ "pattern": "^[0-9]{3}-?[0-9]{4}$"
2157
+ }
2158
+ ```
1239
2159
  店舗住所の郵便番号(7桁の数字)です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
1240
2160
 
1241
2161
  ---
1242
2162
  `tel`
2163
+ ```json
2164
+ {
2165
+ "type": "string",
2166
+ "pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
2167
+ }
2168
+ ```
1243
2169
  店舗の電話番号です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
1244
2170
 
1245
2171
  ---
1246
2172
  `email`
2173
+ ```json
2174
+ {
2175
+ "type": "string",
2176
+ "format": "email",
2177
+ "maxLength": 256
2178
+ }
2179
+ ```
1247
2180
  店舗の連絡先メールアドレスです。明示的に空の値を設定するにはNULLを指定します。
1248
2181
 
1249
2182
  ---
1250
2183
  `external_id`
2184
+ ```json
2185
+ {
2186
+ "type": "string",
2187
+ "maxLength": 36
2188
+ }
2189
+ ```
1251
2190
  店舗の外部IDです(最大36文字)。明示的に空の値を設定するにはNULLを指定します。
1252
2191
 
1253
2192
  ---
1254
2193
  `private_money_ids`
2194
+ ```json
2195
+ {
2196
+ "type": "array",
2197
+ "minItems": 0,
2198
+ "items": {
2199
+ "type": "string",
2200
+ "format": "uuid"
2201
+ }
2202
+ }
2203
+ ```
1255
2204
  店舗で有効にするマネーIDの配列を指定します。
1256
2205
 
1257
2206
  店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
@@ -1259,6 +2208,16 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
1259
2208
 
1260
2209
  ---
1261
2210
  `can_topup_private_money_ids`
2211
+ ```json
2212
+ {
2213
+ "type": "array",
2214
+ "minItems": 0,
2215
+ "items": {
2216
+ "type": "string",
2217
+ "format": "uuid"
2218
+ }
2219
+ }
2220
+ ```
1262
2221
  店舗でチャージ可能にするマネーIDの配列を指定します。
1263
2222
 
1264
2223
  このパラメータは発行体のみが指定でき、発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
@@ -1278,6 +2237,12 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
1278
2237
 
1279
2238
  ---
1280
2239
  `user_id`
2240
+ ```json
2241
+ {
2242
+ "type": "string",
2243
+ "format": "uuid"
2244
+ }
2245
+ ```
1281
2246
  ユーザーIDです。
1282
2247
 
1283
2248
  指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
@@ -1300,6 +2265,13 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
1300
2265
 
1301
2266
  ---
1302
2267
  `organization_code`
2268
+ ```json
2269
+ {
2270
+ "type": "string",
2271
+ "maxLength": 32,
2272
+ "pattern": "^[a-zA-Z0-9-]*$"
2273
+ }
2274
+ ```
1303
2275
  パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
1304
2276
 
1305
2277
  ---
@@ -1309,8 +2281,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
1309
2281
  ```ruby
1310
2282
  response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
1311
2283
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1312
- from: "2017-03-23T12:47:17.000000+09:00", # 開始日時(toと同時に指定する必要有)
1313
- to: "2024-06-20T02:27:27.000000+09:00", # 終了日時(fromと同時に指定する必要有)
2284
+ from: "2022-03-23T13:20:28.000000+09:00", # 開始日時(toと同時に指定する必要有)
2285
+ to: "2016-02-11T07:58:41.000000+09:00", # 終了日時(fromと同時に指定する必要有)
1314
2286
  page: 1, # ページ番号
1315
2287
  per_page: 50 # 1ページ分の取引数
1316
2288
  ))
@@ -1324,23 +2296,38 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
1324
2296
  CSVファイルから一括取引をします。
1325
2297
  ```ruby
1326
2298
  response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1327
- "GFY2SrpQfm9Le0rSPWlrPa8fbLwdjVa", # name: 一括取引タスク名
1328
- "9Jyd", # content: 取引する情報のCSV
1329
- "pHqXjqW7D3uCGCdE3Z7gIcLSudPl4JIrQmLF", # request_id: リクエストID
1330
- description: "JxcGB9NLriuIsMTYyCUoOEa9YZaUNPTMagDSPeHLGCGYvgqbqCIdoPTyGfjAlvbOwBRftL3mTfJhTjDs9c8QNUGv" # 一括取引の説明
2299
+ "cNdXe1sI", # name: 一括取引タスク名
2300
+ "S", # content: 取引する情報のCSV
2301
+ "VztCspdpKcDGU85LATApzQ2dQG1XtK0UfX1f", # request_id: リクエストID
2302
+ description: "zmKZw4jAX5TdVMZA3FsBWHTaR7q8iHovbTWoPNbCUX3WmvU0lnYW7MWulxJqejEo" # 一括取引の説明
1331
2303
  ))
1332
2304
  ```
1333
2305
 
1334
2306
  ---
1335
2307
  `name`
2308
+ ```json
2309
+ {
2310
+ "type": "string",
2311
+ "maxLength": 32
2312
+ }
2313
+ ```
1336
2314
  一括取引タスクの管理用の名前です。
1337
2315
 
1338
2316
  ---
1339
2317
  `description`
2318
+ ```json
2319
+ {
2320
+ "type": "string",
2321
+ "maxLength": 128
2322
+ }
2323
+ ```
1340
2324
  一括取引タスクの管理用の説明文です。
1341
2325
 
1342
2326
  ---
1343
2327
  `content`
2328
+ ```json
2329
+ { "type": "string" }
2330
+ ```
1344
2331
  一括取引する情報を書いたCSVの文字列です。
1345
2332
  1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
1346
2333
  カラムは以下の7つです。任意のカラムには空文字を指定します。
@@ -1366,6 +2353,13 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1366
2353
 
1367
2354
  ---
1368
2355
  `request_id`
2356
+ ```json
2357
+ {
2358
+ "type": "string",
2359
+ "minLength": 36,
2360
+ "maxLength": 36
2361
+ }
2362
+ ```
1369
2363
  重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
1370
2364
 
1371
2365
  ---
@@ -1531,6 +2525,16 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1531
2525
 
1532
2526
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
1533
2527
 
2528
+ <a name="paginated-account-with-users"></a>
2529
+ ## PaginatedAccountWithUsers
2530
+ * `rows (array of AccountWithUsers)`:
2531
+ * `count (integer)`:
2532
+ * `pagination (Pagination)`:
2533
+
2534
+ `rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
2535
+
2536
+ `pagination`は [Pagination](#pagination) オブジェクトを返します。
2537
+
1534
2538
  <a name="paginated-account-balance"></a>
1535
2539
  ## PaginatedAccountBalance
1536
2540
  * `rows (array of AccountBalances)`:
@@ -1664,3 +2668,26 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
1664
2668
  * `tel (string)`: 店舗の電話番号
1665
2669
  * `email (string)`: 店舗のメールアドレス
1666
2670
  * `external_id (string)`: 店舗の外部ID
2671
+
2672
+ <a name="organization"></a>
2673
+ ## Organization
2674
+ * `code (string)`: 組織コード
2675
+ * `name (string)`: 組織名
2676
+
2677
+ <a name="organization-summary"></a>
2678
+ ## OrganizationSummary
2679
+ * `count (integer)`:
2680
+ * `money_amount (double)`:
2681
+ * `money_count (integer)`:
2682
+ * `point_amount (double)`:
2683
+ * `point_count (integer)`:
2684
+
2685
+ <a name="account-without-private-money-detail"></a>
2686
+ ## AccountWithoutPrivateMoneyDetail
2687
+ * `id (string)`:
2688
+ * `name (string)`:
2689
+ * `is_suspended (boolean)`:
2690
+ * `private_money_id (string)`:
2691
+ * `user (User)`:
2692
+
2693
+ `user`は [User](#user) オブジェクトを返します。