pokepay_partner_ruby_sdk 0.1.9 → 0.1.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -5
- data/docs/index.md +808 -77
- data/lib/pokepay_partner_ruby_sdk.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/client.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/request/{create_shop_v.rb → create_shop_v2.rb} +0 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/partner.yaml +273 -273
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c28ec9c4930d1e34735afd2550d91a054e4009d5a859c6facb11f981989ba508
|
4
|
+
data.tar.gz: 0de71cd2696b31ce00e144a8ba7cb73f4fdfa0c2d9e9c86e1b29935ba31ef373
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a4c85bbe247554742c10ff1a99f410e216546b2c37419946ab0f58dbbc952b2e52c53936d8989fab38f82e4c76678dc8b0707d8381719276029da719bb268da4
|
7
|
+
data.tar.gz: 335f50afd34426875a8294c5938bb2860680fafe4d6fe06ef20214a9b2bd1868014dc5976865595144c26d69366bc3800ecde68a73e43ab5ef0da7a8a6d124b3
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
pokepay_partner_ruby_sdk (0.1.
|
4
|
+
pokepay_partner_ruby_sdk (0.1.10)
|
5
5
|
inifile (~> 3.0.0)
|
6
6
|
json (~> 2.3.0)
|
7
7
|
openssl (~> 2.1.2)
|
@@ -10,11 +10,9 @@ GEM
|
|
10
10
|
remote: https://rubygems.org/
|
11
11
|
specs:
|
12
12
|
inifile (3.0.0)
|
13
|
-
ipaddr (1.2.2)
|
14
13
|
json (2.3.1)
|
15
|
-
minitest (5.14.
|
14
|
+
minitest (5.14.4)
|
16
15
|
openssl (2.1.2)
|
17
|
-
ipaddr
|
18
16
|
rake (13.0.1)
|
19
17
|
|
20
18
|
PLATFORMS
|
@@ -27,4 +25,4 @@ DEPENDENCIES
|
|
27
25
|
rake (~> 13.0)
|
28
26
|
|
29
27
|
BUNDLED WITH
|
30
|
-
2.
|
28
|
+
2.2.3
|
data/docs/index.md
CHANGED
@@ -166,7 +166,7 @@ response.body
|
|
166
166
|
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
167
167
|
- [ListShops](#list-shops): 店舗一覧を取得する
|
168
168
|
- [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
|
169
|
-
- [CreateShopV2](#create-shop-
|
169
|
+
- [CreateShopV2](#create-shop-v2): 新規店舗を追加する
|
170
170
|
- [GetShop](#get-shop): 店舗情報を表示する
|
171
171
|
- [UpdateShop](#update-shop): 店舗情報を更新する
|
172
172
|
- [ListUserAccounts](#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
|
@@ -179,8 +179,8 @@ response.body
|
|
179
179
|
取引一覧を返します。
|
180
180
|
```ruby
|
181
181
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
182
|
-
from: "
|
183
|
-
to: "
|
182
|
+
from: "2021-03-07T22:47:08.000000+09:00", # 開始日時
|
183
|
+
to: "2022-03-08T10:30:46.000000+09:00", # 終了日時
|
184
184
|
page: 1, # ページ番号
|
185
185
|
per_page: 50, # 1ページ分の取引数
|
186
186
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
@@ -197,68 +197,138 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
197
197
|
|
198
198
|
---
|
199
199
|
`from`
|
200
|
+
```json
|
201
|
+
{
|
202
|
+
"type": "string",
|
203
|
+
"format": "date-time"
|
204
|
+
}
|
205
|
+
```
|
200
206
|
抽出期間の開始日時です。
|
201
207
|
|
202
208
|
フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
|
203
209
|
|
204
210
|
---
|
205
211
|
`to`
|
212
|
+
```json
|
213
|
+
{
|
214
|
+
"type": "string",
|
215
|
+
"format": "date-time"
|
216
|
+
}
|
217
|
+
```
|
206
218
|
抽出期間の終了日時です。
|
207
219
|
|
208
220
|
フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
|
209
221
|
|
210
222
|
---
|
211
223
|
`page`
|
224
|
+
```json
|
225
|
+
{
|
226
|
+
"type": "integer",
|
227
|
+
"minimum": 1
|
228
|
+
}
|
229
|
+
```
|
212
230
|
取得したいページ番号です。
|
213
231
|
|
214
232
|
---
|
215
233
|
`per_page`
|
234
|
+
```json
|
235
|
+
{
|
236
|
+
"type": "integer",
|
237
|
+
"minimum": 1
|
238
|
+
}
|
239
|
+
```
|
216
240
|
1ページ分の取引数です。
|
217
241
|
|
218
242
|
---
|
219
243
|
`shop_id`
|
244
|
+
```json
|
245
|
+
{
|
246
|
+
"type": "string",
|
247
|
+
"format": "uuid"
|
248
|
+
}
|
249
|
+
```
|
220
250
|
店舗IDです。
|
221
251
|
|
222
252
|
フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
|
223
253
|
|
224
254
|
---
|
225
255
|
`customer_id`
|
256
|
+
```json
|
257
|
+
{
|
258
|
+
"type": "string",
|
259
|
+
"format": "uuid"
|
260
|
+
}
|
261
|
+
```
|
226
262
|
エンドユーザーIDです。
|
227
263
|
|
228
264
|
フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
|
229
265
|
|
230
266
|
---
|
231
267
|
`customer_name`
|
268
|
+
```json
|
269
|
+
{
|
270
|
+
"type": "string",
|
271
|
+
"maxLength": 256
|
272
|
+
}
|
273
|
+
```
|
232
274
|
エンドユーザー名です。
|
233
275
|
|
234
276
|
フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
|
235
277
|
|
236
278
|
---
|
237
279
|
`terminal_id`
|
280
|
+
```json
|
281
|
+
{
|
282
|
+
"type": "string",
|
283
|
+
"format": "uuid"
|
284
|
+
}
|
285
|
+
```
|
238
286
|
端末IDです。
|
239
287
|
|
240
288
|
フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
|
241
289
|
|
242
290
|
---
|
243
291
|
`transaction_id`
|
292
|
+
```json
|
293
|
+
{
|
294
|
+
"type": "string",
|
295
|
+
"format": "uuid"
|
296
|
+
}
|
297
|
+
```
|
244
298
|
取引IDです。
|
245
299
|
|
246
300
|
フィルターとして使われ、指定された取引のみ一覧に表示されます。
|
247
301
|
|
248
302
|
---
|
249
303
|
`organization_code`
|
304
|
+
```json
|
305
|
+
{
|
306
|
+
"type": "string",
|
307
|
+
"maxLength": 32,
|
308
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
309
|
+
}
|
310
|
+
```
|
250
311
|
組織コードです。
|
251
312
|
|
252
313
|
フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
|
253
314
|
|
254
315
|
---
|
255
316
|
`private_money_id`
|
317
|
+
```json
|
318
|
+
{
|
319
|
+
"type": "string",
|
320
|
+
"format": "uuid"
|
321
|
+
}
|
322
|
+
```
|
256
323
|
マネーIDです。
|
257
324
|
|
258
325
|
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
259
326
|
|
260
327
|
---
|
261
328
|
`is_modified`
|
329
|
+
```json
|
330
|
+
{ "type": "boolean" }
|
331
|
+
```
|
262
332
|
キャンセルフラグです。
|
263
333
|
|
264
334
|
これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
|
@@ -266,6 +336,18 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
266
336
|
|
267
337
|
---
|
268
338
|
`types`
|
339
|
+
```json
|
340
|
+
{
|
341
|
+
"type": "array",
|
342
|
+
"items": {
|
343
|
+
"type": "string",
|
344
|
+
"enum": {
|
345
|
+
"topup": "payment",
|
346
|
+
"exchange_outflow": "exchange_inflow"
|
347
|
+
}
|
348
|
+
}
|
349
|
+
}
|
350
|
+
```
|
269
351
|
取引の種類でフィルターします。
|
270
352
|
|
271
353
|
以下の種類を指定できます。
|
@@ -292,15 +374,21 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
292
374
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
293
375
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
294
376
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
295
|
-
money_amount:
|
296
|
-
point_amount:
|
297
|
-
point_expires_at: "
|
298
|
-
description: "
|
377
|
+
money_amount: 1421,
|
378
|
+
point_amount: 2284,
|
379
|
+
point_expires_at: "2024-09-29T14:09:13.000000+09:00", # ポイント有効期限
|
380
|
+
description: "dnW1ooZFRDSiyltrhPzNi7jenj4X3xdXKxR7POl5XLEB6rdcoyFq3Dy2RXyPUAe3PgOIxNaz33MDlMm45c417ClVPZadCz21oTLg0Zh082rSUmgTJgltXUvopMAE6nKVgCC79b4Ei190OQ71CLczodkHUHlo8UiDVjyL"
|
299
381
|
))
|
300
382
|
```
|
301
383
|
|
302
384
|
---
|
303
385
|
`point_expires_at`
|
386
|
+
```json
|
387
|
+
{
|
388
|
+
"type": "string",
|
389
|
+
"format": "date-time"
|
390
|
+
}
|
391
|
+
```
|
304
392
|
ポイントをチャージした場合の、付与されるポイントの有効期限です。
|
305
393
|
省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
|
306
394
|
|
@@ -315,56 +403,104 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
315
403
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
316
404
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
317
405
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
318
|
-
money_amount:
|
319
|
-
point_amount:
|
320
|
-
point_expires_at: "
|
406
|
+
money_amount: 8760, # マネー額
|
407
|
+
point_amount: 2312, # ポイント額
|
408
|
+
point_expires_at: "2023-08-31T03:26:11.000000+09:00", # ポイント有効期限
|
321
409
|
description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
|
322
410
|
))
|
323
411
|
```
|
324
412
|
|
325
413
|
---
|
326
414
|
`shop_id`
|
415
|
+
```json
|
416
|
+
{
|
417
|
+
"type": "string",
|
418
|
+
"format": "uuid"
|
419
|
+
}
|
420
|
+
```
|
327
421
|
店舗IDです。
|
328
422
|
|
329
423
|
送金元の店舗を指定します。
|
330
424
|
|
331
425
|
---
|
332
426
|
`customer_id`
|
427
|
+
```json
|
428
|
+
{
|
429
|
+
"type": "string",
|
430
|
+
"format": "uuid"
|
431
|
+
}
|
432
|
+
```
|
333
433
|
エンドユーザーIDです。
|
334
434
|
|
335
435
|
送金先のエンドユーザーを指定します。
|
336
436
|
|
337
437
|
---
|
338
438
|
`private_money_id`
|
439
|
+
```json
|
440
|
+
{
|
441
|
+
"type": "string",
|
442
|
+
"format": "uuid"
|
443
|
+
}
|
444
|
+
```
|
339
445
|
マネーIDです。
|
340
446
|
|
341
447
|
マネーを指定します。
|
342
448
|
|
343
449
|
---
|
344
450
|
`bear_point_shop_id`
|
451
|
+
```json
|
452
|
+
{
|
453
|
+
"type": "string",
|
454
|
+
"format": "uuid"
|
455
|
+
}
|
456
|
+
```
|
345
457
|
ポイント支払時の負担店舗IDです。
|
346
458
|
|
347
459
|
ポイント支払い時に実際お金を負担する店舗を指定します。
|
348
460
|
|
349
461
|
---
|
350
462
|
`money_amount`
|
463
|
+
```json
|
464
|
+
{
|
465
|
+
"type": "number",
|
466
|
+
"minimum": 0
|
467
|
+
}
|
468
|
+
```
|
351
469
|
マネー額です。
|
352
470
|
|
353
471
|
送金するマネー額を指定します。
|
354
472
|
|
355
473
|
---
|
356
474
|
`point_amount`
|
475
|
+
```json
|
476
|
+
{
|
477
|
+
"type": "number",
|
478
|
+
"minimum": 0
|
479
|
+
}
|
480
|
+
```
|
357
481
|
ポイント額です。
|
358
482
|
|
359
483
|
送金するポイント額を指定します。
|
360
484
|
|
361
485
|
---
|
362
486
|
`point_expires_at`
|
487
|
+
```json
|
488
|
+
{
|
489
|
+
"type": "string",
|
490
|
+
"format": "date-time"
|
491
|
+
}
|
492
|
+
```
|
363
493
|
ポイントをチャージした場合の、付与されるポイントの有効期限です。
|
364
494
|
省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
|
365
495
|
|
366
496
|
---
|
367
497
|
`description`
|
498
|
+
```json
|
499
|
+
{
|
500
|
+
"type": "string",
|
501
|
+
"maxLength": 200
|
502
|
+
}
|
503
|
+
```
|
368
504
|
取引説明文です。
|
369
505
|
|
370
506
|
任意入力で、取引履歴に表示される説明文です。
|
@@ -381,37 +517,67 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
381
517
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
382
518
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
383
519
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
384
|
-
|
520
|
+
3693, # amount: 支払い額
|
385
521
|
description: "たい焼き(小倉)" # 取引履歴に表示する説明文
|
386
522
|
))
|
387
523
|
```
|
388
524
|
|
389
525
|
---
|
390
526
|
`shop_id`
|
527
|
+
```json
|
528
|
+
{
|
529
|
+
"type": "string",
|
530
|
+
"format": "uuid"
|
531
|
+
}
|
532
|
+
```
|
391
533
|
店舗IDです。
|
392
534
|
|
393
535
|
送金先の店舗を指定します。
|
394
536
|
|
395
537
|
---
|
396
538
|
`customer_id`
|
539
|
+
```json
|
540
|
+
{
|
541
|
+
"type": "string",
|
542
|
+
"format": "uuid"
|
543
|
+
}
|
544
|
+
```
|
397
545
|
エンドユーザーIDです。
|
398
546
|
|
399
547
|
送金元のエンドユーザーを指定します。
|
400
548
|
|
401
549
|
---
|
402
550
|
`private_money_id`
|
551
|
+
```json
|
552
|
+
{
|
553
|
+
"type": "string",
|
554
|
+
"format": "uuid"
|
555
|
+
}
|
556
|
+
```
|
403
557
|
マネーIDです。
|
404
558
|
|
405
559
|
マネーを指定します。
|
406
560
|
|
407
561
|
---
|
408
562
|
`amount`
|
563
|
+
```json
|
564
|
+
{
|
565
|
+
"type": "number",
|
566
|
+
"minimum": 0
|
567
|
+
}
|
568
|
+
```
|
409
569
|
マネー額です。
|
410
570
|
|
411
571
|
送金するマネー額を指定します。
|
412
572
|
|
413
573
|
---
|
414
574
|
`description`
|
575
|
+
```json
|
576
|
+
{
|
577
|
+
"type": "string",
|
578
|
+
"maxLength": 200
|
579
|
+
}
|
580
|
+
```
|
415
581
|
取引説明文です。
|
416
582
|
|
417
583
|
任意入力で、取引履歴に表示される説明文です。
|
@@ -428,37 +594,67 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
428
594
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
429
595
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
430
596
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
431
|
-
|
597
|
+
6392, # amount: 送金額
|
432
598
|
description: "たい焼き(小倉)" # 取引履歴に表示する説明文
|
433
599
|
))
|
434
600
|
```
|
435
601
|
|
436
602
|
---
|
437
603
|
`sender_id`
|
604
|
+
```json
|
605
|
+
{
|
606
|
+
"type": "string",
|
607
|
+
"format": "uuid"
|
608
|
+
}
|
609
|
+
```
|
438
610
|
エンドユーザーIDです。
|
439
611
|
|
440
612
|
送金元のエンドユーザー(送り主)を指定します。
|
441
613
|
|
442
614
|
---
|
443
615
|
`receiver_id`
|
616
|
+
```json
|
617
|
+
{
|
618
|
+
"type": "string",
|
619
|
+
"format": "uuid"
|
620
|
+
}
|
621
|
+
```
|
444
622
|
エンドユーザーIDです。
|
445
623
|
|
446
624
|
送金先のエンドユーザー(受け取り人)を指定します。
|
447
625
|
|
448
626
|
---
|
449
627
|
`private_money_id`
|
628
|
+
```json
|
629
|
+
{
|
630
|
+
"type": "string",
|
631
|
+
"format": "uuid"
|
632
|
+
}
|
633
|
+
```
|
450
634
|
マネーIDです。
|
451
635
|
|
452
636
|
マネーを指定します。
|
453
637
|
|
454
638
|
---
|
455
639
|
`amount`
|
640
|
+
```json
|
641
|
+
{
|
642
|
+
"type": "number",
|
643
|
+
"minimum": 0
|
644
|
+
}
|
645
|
+
```
|
456
646
|
マネー額です。
|
457
647
|
|
458
648
|
送金するマネー額を指定します。
|
459
649
|
|
460
650
|
---
|
461
651
|
`description`
|
652
|
+
```json
|
653
|
+
{
|
654
|
+
"type": "string",
|
655
|
+
"maxLength": 200
|
656
|
+
}
|
657
|
+
```
|
462
658
|
取引説明文です。
|
463
659
|
|
464
660
|
任意入力で、取引履歴に表示される説明文です。
|
@@ -472,8 +668,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
472
668
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
473
669
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
474
670
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
475
|
-
|
476
|
-
description: "
|
671
|
+
9228,
|
672
|
+
description: "NxSNDBAB21jRDnDfUt4YgIyZaTsiHOmcCShoExxXDzwmu0NmtxroKVUk7sDu4lw8ZxL5ooBCUmbexHlOYPdRDRXfcFEKebPAHiatKRmL7K8IMJIBW1vB1RC8WQ75Zq2CPEph5LyiHrKKZHYeA6K"
|
477
673
|
))
|
478
674
|
```
|
479
675
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
@@ -488,6 +684,12 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
488
684
|
|
489
685
|
---
|
490
686
|
`transaction_id`
|
687
|
+
```json
|
688
|
+
{
|
689
|
+
"type": "string",
|
690
|
+
"format": "uuid"
|
691
|
+
}
|
692
|
+
```
|
491
693
|
取引IDです。
|
492
694
|
|
493
695
|
フィルターとして使われ、指定した取引IDの取引を取得します。
|
@@ -498,19 +700,19 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
498
700
|
####
|
499
701
|
```ruby
|
500
702
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
501
|
-
from: "2017-
|
502
|
-
to: "
|
503
|
-
page:
|
504
|
-
per_page:
|
703
|
+
from: "2017-10-07T19:44:21.000000+09:00",
|
704
|
+
to: "2018-06-17T19:03:29.000000+09:00",
|
705
|
+
page: 4180,
|
706
|
+
per_page: 4035,
|
505
707
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
506
|
-
shop_name: "
|
708
|
+
shop_name: "kbfNhFw",
|
507
709
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
508
|
-
customer_name: "
|
710
|
+
customer_name: "jSSUkqouGV2ULftf3KLiOm0u6OdTYvY1WMa6BMdHbor9Bi8VjYjeAF8N8XvRYyNjj6LzPNoFY0NPc7gW3tdaerbfAUj6MGuDCQRgbbh69IfOOqdFvcvTYHWhMSc2JtDSCuxpXIBKjX0wbEINtuhWyJmxhctiEpL1KlL20SY28CEIpXvCz2lX0WFgkUTJYHHOr63hjnglJCcSZdRjCOwyap0lsb8d4Dc5yMU1TN0yX6wxY6IPoPyEr8klncfG",
|
509
711
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
510
712
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
511
|
-
is_modified:
|
512
|
-
transaction_types: ["
|
513
|
-
transfer_types: ["exchange", "payment"]
|
713
|
+
is_modified: false,
|
714
|
+
transaction_types: ["exchange", "transfer", "payment", "topup"],
|
715
|
+
transfer_types: ["topup", "transfer", "exchange", "payment"]
|
514
716
|
))
|
515
717
|
```
|
516
718
|
成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
|
@@ -538,12 +740,24 @@ response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
|
|
538
740
|
|
539
741
|
---
|
540
742
|
`check_id`
|
743
|
+
```json
|
744
|
+
{
|
745
|
+
"type": "string",
|
746
|
+
"format": "uuid"
|
747
|
+
}
|
748
|
+
```
|
541
749
|
チャージ用QRコードのIDです。
|
542
750
|
|
543
751
|
QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
|
544
752
|
|
545
753
|
---
|
546
754
|
`customer_id`
|
755
|
+
```json
|
756
|
+
{
|
757
|
+
"type": "string",
|
758
|
+
"format": "uuid"
|
759
|
+
}
|
760
|
+
```
|
547
761
|
エンドユーザーIDです。
|
548
762
|
|
549
763
|
送金先のエンドユーザーを指定します。
|
@@ -557,76 +771,151 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
557
771
|
支払いQRコード一覧を表示します。
|
558
772
|
```ruby
|
559
773
|
response = $client.send(Pokepay::Request::ListBills.new(
|
560
|
-
page:
|
561
|
-
per_page:
|
562
|
-
bill_id: "
|
774
|
+
page: 1083, # ページ番号
|
775
|
+
per_page: 8979, # 1ページの表示数
|
776
|
+
bill_id: "OqOmjPQj", # 支払いQRコードのID
|
563
777
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
564
|
-
organization_code: "
|
778
|
+
organization_code: "v-n", # 組織コード
|
565
779
|
description: "test bill", # 取引説明文
|
566
|
-
created_from: "
|
567
|
-
created_to: "
|
780
|
+
created_from: "2022-01-25T23:24:31.000000+09:00", # 作成日時(起点)
|
781
|
+
created_to: "2016-11-01T22:58:21.000000+09:00", # 作成日時(終点)
|
568
782
|
shop_name: "bill test shop1", # 店舗名
|
569
783
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
570
|
-
lower_limit_amount:
|
571
|
-
upper_limit_amount:
|
784
|
+
lower_limit_amount: 5690, # 金額の範囲によるフィルタ(下限)
|
785
|
+
upper_limit_amount: 7721, # 金額の範囲によるフィルタ(上限)
|
572
786
|
is_disabled: true # 支払いQRコードが無効化されているかどうか
|
573
787
|
))
|
574
788
|
```
|
575
789
|
|
576
790
|
---
|
577
791
|
`page`
|
792
|
+
```json
|
793
|
+
{
|
794
|
+
"type": "integer",
|
795
|
+
"minimum": 1
|
796
|
+
}
|
797
|
+
```
|
578
798
|
取得したいページ番号です。
|
579
799
|
|
580
800
|
---
|
581
801
|
`per_page`
|
802
|
+
```json
|
803
|
+
{
|
804
|
+
"type": "integer",
|
805
|
+
"minimum": 1
|
806
|
+
}
|
807
|
+
```
|
582
808
|
1ページに表示する支払いQRコードの数です。
|
583
809
|
|
584
810
|
---
|
585
811
|
`bill_id`
|
812
|
+
```json
|
813
|
+
{ "type": "string" }
|
814
|
+
```
|
586
815
|
支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
|
587
816
|
|
588
817
|
---
|
589
818
|
`private_money_id`
|
819
|
+
```json
|
820
|
+
{
|
821
|
+
"type": "string",
|
822
|
+
"format": "uuid"
|
823
|
+
}
|
824
|
+
```
|
590
825
|
支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
|
591
826
|
|
592
827
|
---
|
593
828
|
`organization_code`
|
829
|
+
```json
|
830
|
+
{
|
831
|
+
"type": "string",
|
832
|
+
"maxLength": 32,
|
833
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
834
|
+
}
|
835
|
+
```
|
594
836
|
支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
|
595
837
|
|
596
838
|
---
|
597
839
|
`description`
|
840
|
+
```json
|
841
|
+
{
|
842
|
+
"type": "string",
|
843
|
+
"maxLength": 200
|
844
|
+
}
|
845
|
+
```
|
598
846
|
支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
|
599
847
|
|
600
848
|
---
|
601
849
|
`created_from`
|
850
|
+
```json
|
851
|
+
{
|
852
|
+
"type": "string",
|
853
|
+
"format": "date-time"
|
854
|
+
}
|
855
|
+
```
|
602
856
|
支払いQRコードの作成日時でフィルターします。
|
603
857
|
|
604
858
|
これ以降に作成された支払いQRコードのみ一覧に表示されます。
|
605
859
|
|
606
860
|
---
|
607
861
|
`created_to`
|
862
|
+
```json
|
863
|
+
{
|
864
|
+
"type": "string",
|
865
|
+
"format": "date-time"
|
866
|
+
}
|
867
|
+
```
|
608
868
|
支払いQRコードの作成日時でフィルターします。
|
609
869
|
|
610
870
|
これ以前に作成された支払いQRコードのみ一覧に表示されます。
|
611
871
|
|
612
872
|
---
|
613
873
|
`shop_name`
|
874
|
+
```json
|
875
|
+
{
|
876
|
+
"type": "string",
|
877
|
+
"maxLength": 256
|
878
|
+
}
|
879
|
+
```
|
614
880
|
支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
|
615
881
|
|
616
882
|
---
|
617
883
|
`shop_id`
|
884
|
+
```json
|
885
|
+
{
|
886
|
+
"type": "string",
|
887
|
+
"format": "uuid"
|
888
|
+
}
|
889
|
+
```
|
618
890
|
支払いQRコードを作成した店舗IDでフィルターします。
|
619
891
|
|
620
892
|
---
|
621
893
|
`lower_limit_amount`
|
894
|
+
```json
|
895
|
+
{
|
896
|
+
"type": "integer",
|
897
|
+
"format": "decimal",
|
898
|
+
"minimum": 0
|
899
|
+
}
|
900
|
+
```
|
622
901
|
支払いQRコードの金額の下限を指定してフィルターします。
|
623
902
|
|
624
903
|
---
|
625
904
|
`upper_limit_amount`
|
905
|
+
```json
|
906
|
+
{
|
907
|
+
"type": "integer",
|
908
|
+
"format": "decimal",
|
909
|
+
"minimum": 0
|
910
|
+
}
|
911
|
+
```
|
626
912
|
支払いQRコードの金額の上限を指定してフィルターします。
|
627
913
|
|
628
914
|
---
|
629
915
|
`is_disabled`
|
916
|
+
```json
|
917
|
+
{ "type": "boolean" }
|
918
|
+
```
|
630
919
|
支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
|
631
920
|
|
632
921
|
---
|
@@ -638,13 +927,20 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
638
927
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
639
928
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
640
929
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
641
|
-
amount:
|
930
|
+
amount: 4286, # 支払い額
|
642
931
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
643
932
|
))
|
644
933
|
```
|
645
934
|
|
646
935
|
---
|
647
936
|
`amount`
|
937
|
+
```json
|
938
|
+
{
|
939
|
+
"type": "number",
|
940
|
+
"format": "decimal",
|
941
|
+
"minimum": 0
|
942
|
+
}
|
943
|
+
```
|
648
944
|
支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
|
649
945
|
|
650
946
|
---
|
@@ -655,7 +951,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
655
951
|
```ruby
|
656
952
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
657
953
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
658
|
-
amount:
|
954
|
+
amount: 3562, # 支払い額
|
659
955
|
description: "test bill", # 説明文
|
660
956
|
is_disabled: true # 無効化されているかどうか
|
661
957
|
))
|
@@ -663,18 +959,40 @@ response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
663
959
|
|
664
960
|
---
|
665
961
|
`bill_id`
|
962
|
+
```json
|
963
|
+
{
|
964
|
+
"type": "string",
|
965
|
+
"format": "uuid"
|
966
|
+
}
|
967
|
+
```
|
666
968
|
更新対象の支払いQRコードのIDです。
|
667
969
|
|
668
970
|
---
|
669
971
|
`amount`
|
972
|
+
```json
|
973
|
+
{
|
974
|
+
"type": "number",
|
975
|
+
"format": "decimal",
|
976
|
+
"minimum": 0
|
977
|
+
}
|
978
|
+
```
|
670
979
|
支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
|
671
980
|
|
672
981
|
---
|
673
982
|
`description`
|
983
|
+
```json
|
984
|
+
{
|
985
|
+
"type": "string",
|
986
|
+
"maxLength": 200
|
987
|
+
}
|
988
|
+
```
|
674
989
|
支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
|
675
990
|
|
676
991
|
---
|
677
992
|
`is_disabled`
|
993
|
+
```json
|
994
|
+
{ "type": "boolean" }
|
995
|
+
```
|
678
996
|
支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
|
679
997
|
|
680
998
|
---
|
@@ -698,32 +1016,59 @@ Cashtrayを作成します。
|
|
698
1016
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
699
1017
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
700
1018
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
701
|
-
|
1019
|
+
3128, # amount: 金額
|
702
1020
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
703
|
-
expires_in:
|
1021
|
+
expires_in: 8103 # 失効時間(秒)
|
704
1022
|
))
|
705
1023
|
```
|
706
1024
|
|
707
1025
|
---
|
708
1026
|
`private_money_id`
|
1027
|
+
```json
|
1028
|
+
{
|
1029
|
+
"type": "string",
|
1030
|
+
"format": "uuid"
|
1031
|
+
}
|
1032
|
+
```
|
709
1033
|
取引対象のマネーのIDです(必須項目)。
|
710
1034
|
|
711
1035
|
---
|
712
1036
|
`shop_id`
|
1037
|
+
```json
|
1038
|
+
{
|
1039
|
+
"type": "string",
|
1040
|
+
"format": "uuid"
|
1041
|
+
}
|
1042
|
+
```
|
713
1043
|
店舗のユーザーIDです(必須項目)。
|
714
1044
|
|
715
1045
|
---
|
716
1046
|
`amount`
|
1047
|
+
```json
|
1048
|
+
{ "type": "number" }
|
1049
|
+
```
|
717
1050
|
マネー額です(必須項目)。
|
718
1051
|
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
719
1052
|
|
720
1053
|
---
|
721
1054
|
`description`
|
1055
|
+
```json
|
1056
|
+
{
|
1057
|
+
"type": "string",
|
1058
|
+
"maxLength": 200
|
1059
|
+
}
|
1060
|
+
```
|
722
1061
|
Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
|
723
1062
|
アプリや管理画面などの取引履歴に表示されます。デフォルトでは空文字になります。
|
724
1063
|
|
725
1064
|
---
|
726
1065
|
`expires_in`
|
1066
|
+
```json
|
1067
|
+
{
|
1068
|
+
"type": "integer",
|
1069
|
+
"minimum": 1
|
1070
|
+
}
|
1071
|
+
```
|
727
1072
|
Cashtrayが失効するまでの時間を秒単位で指定します(任意項目、デフォルト値は1800秒(30分))。
|
728
1073
|
|
729
1074
|
---
|
@@ -794,6 +1139,12 @@ response = $client.send(Pokepay::Request::GetCashtray.new(
|
|
794
1139
|
|
795
1140
|
---
|
796
1141
|
`cashtray_id`
|
1142
|
+
```json
|
1143
|
+
{
|
1144
|
+
"type": "string",
|
1145
|
+
"format": "uuid"
|
1146
|
+
}
|
1147
|
+
```
|
797
1148
|
情報を取得するCashtrayのIDです。
|
798
1149
|
|
799
1150
|
---
|
@@ -812,6 +1163,12 @@ response = $client.send(Pokepay::Request::CancelCashtray.new(
|
|
812
1163
|
|
813
1164
|
---
|
814
1165
|
`cashtray_id`
|
1166
|
+
```json
|
1167
|
+
{
|
1168
|
+
"type": "string",
|
1169
|
+
"format": "uuid"
|
1170
|
+
}
|
1171
|
+
```
|
815
1172
|
無効化するCashtrayのIDです。
|
816
1173
|
|
817
1174
|
---
|
@@ -822,28 +1179,49 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
822
1179
|
```ruby
|
823
1180
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
824
1181
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
825
|
-
amount:
|
1182
|
+
amount: 9905, # 金額
|
826
1183
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
827
|
-
expires_in:
|
1184
|
+
expires_in: 2635 # 失効時間(秒)
|
828
1185
|
))
|
829
1186
|
```
|
830
1187
|
|
831
1188
|
---
|
832
1189
|
`cashtray_id`
|
1190
|
+
```json
|
1191
|
+
{
|
1192
|
+
"type": "string",
|
1193
|
+
"format": "uuid"
|
1194
|
+
}
|
1195
|
+
```
|
833
1196
|
更新対象のCashtrayのIDです。
|
834
1197
|
|
835
1198
|
---
|
836
1199
|
`amount`
|
1200
|
+
```json
|
1201
|
+
{ "type": "number" }
|
1202
|
+
```
|
837
1203
|
マネー額です(任意項目)。
|
838
1204
|
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
839
1205
|
|
840
1206
|
---
|
841
1207
|
`description`
|
1208
|
+
```json
|
1209
|
+
{
|
1210
|
+
"type": "string",
|
1211
|
+
"maxLength": 200
|
1212
|
+
}
|
1213
|
+
```
|
842
1214
|
Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
|
843
1215
|
アプリや管理画面などの取引履歴に表示されます。
|
844
1216
|
|
845
1217
|
---
|
846
1218
|
`expires_in`
|
1219
|
+
```json
|
1220
|
+
{
|
1221
|
+
"type": "integer",
|
1222
|
+
"minimum": 1
|
1223
|
+
}
|
1224
|
+
```
|
847
1225
|
Cashtrayが失効するまでの時間を秒で指定します(任意項目、デフォルト値は1800秒(30分))。
|
848
1226
|
|
849
1227
|
---
|
@@ -860,6 +1238,12 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
860
1238
|
|
861
1239
|
---
|
862
1240
|
`account_id`
|
1241
|
+
```json
|
1242
|
+
{
|
1243
|
+
"type": "string",
|
1244
|
+
"format": "uuid"
|
1245
|
+
}
|
1246
|
+
```
|
863
1247
|
ウォレットIDです。
|
864
1248
|
|
865
1249
|
フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
|
@@ -878,12 +1262,21 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
878
1262
|
|
879
1263
|
---
|
880
1264
|
`account_id`
|
1265
|
+
```json
|
1266
|
+
{
|
1267
|
+
"type": "string",
|
1268
|
+
"format": "uuid"
|
1269
|
+
}
|
1270
|
+
```
|
881
1271
|
ウォレットIDです。
|
882
1272
|
|
883
1273
|
指定したウォレットIDのウォレットの状態を更新します。
|
884
1274
|
|
885
1275
|
---
|
886
1276
|
`is_suspended`
|
1277
|
+
```json
|
1278
|
+
{ "type": "boolean" }
|
1279
|
+
```
|
887
1280
|
ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
|
888
1281
|
|
889
1282
|
---
|
@@ -894,38 +1287,74 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
894
1287
|
```ruby
|
895
1288
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
896
1289
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
897
|
-
page:
|
898
|
-
per_page:
|
899
|
-
expires_at_from: "
|
900
|
-
expires_at_to: "
|
901
|
-
direction: "
|
1290
|
+
page: 6492, # ページ番号
|
1291
|
+
per_page: 8200, # 1ページ分の取引数
|
1292
|
+
expires_at_from: "2023-02-10T06:31:24.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
1293
|
+
expires_at_to: "2015-10-25T22:32:38.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
1294
|
+
direction: "asc" # 有効期限によるソート順序
|
902
1295
|
))
|
903
1296
|
```
|
904
1297
|
|
905
1298
|
---
|
906
1299
|
`account_id`
|
1300
|
+
```json
|
1301
|
+
{
|
1302
|
+
"type": "string",
|
1303
|
+
"format": "uuid"
|
1304
|
+
}
|
1305
|
+
```
|
907
1306
|
ウォレットIDです。
|
908
1307
|
|
909
1308
|
フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
|
910
1309
|
|
911
1310
|
---
|
912
1311
|
`page`
|
1312
|
+
```json
|
1313
|
+
{
|
1314
|
+
"type": "integer",
|
1315
|
+
"minimum": 1
|
1316
|
+
}
|
1317
|
+
```
|
913
1318
|
取得したいページ番号です。デフォルト値は1です。
|
914
1319
|
|
915
1320
|
---
|
916
1321
|
`per_page`
|
1322
|
+
```json
|
1323
|
+
{
|
1324
|
+
"type": "integer",
|
1325
|
+
"minimum": 1
|
1326
|
+
}
|
1327
|
+
```
|
917
1328
|
1ページ分のウォレット残高数です。デフォルト値は30です。
|
918
1329
|
|
919
1330
|
---
|
920
1331
|
`expires_at_from`
|
1332
|
+
```json
|
1333
|
+
{
|
1334
|
+
"type": "string",
|
1335
|
+
"format": "date-time"
|
1336
|
+
}
|
1337
|
+
```
|
921
1338
|
有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
922
1339
|
|
923
1340
|
---
|
924
1341
|
`expires_at_to`
|
1342
|
+
```json
|
1343
|
+
{
|
1344
|
+
"type": "string",
|
1345
|
+
"format": "date-time"
|
1346
|
+
}
|
1347
|
+
```
|
925
1348
|
有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
926
1349
|
|
927
1350
|
---
|
928
1351
|
`direction`
|
1352
|
+
```json
|
1353
|
+
{
|
1354
|
+
"type": "string",
|
1355
|
+
"enum": { "asc": "desc" }
|
1356
|
+
}
|
1357
|
+
```
|
929
1358
|
有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
|
930
1359
|
|
931
1360
|
---
|
@@ -936,38 +1365,74 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
936
1365
|
```ruby
|
937
1366
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
938
1367
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
939
|
-
page:
|
940
|
-
per_page:
|
941
|
-
expires_at_from: "2022-
|
942
|
-
expires_at_to: "2017-
|
1368
|
+
page: 6728, # ページ番号
|
1369
|
+
per_page: 2052, # 1ページ分の取引数
|
1370
|
+
expires_at_from: "2022-12-01T19:24:55.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
1371
|
+
expires_at_to: "2017-01-20T20:17:45.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
943
1372
|
direction: "desc" # 有効期限によるソート順序
|
944
1373
|
))
|
945
1374
|
```
|
946
1375
|
|
947
1376
|
---
|
948
1377
|
`account_id`
|
1378
|
+
```json
|
1379
|
+
{
|
1380
|
+
"type": "string",
|
1381
|
+
"format": "uuid"
|
1382
|
+
}
|
1383
|
+
```
|
949
1384
|
ウォレットIDです。
|
950
1385
|
|
951
1386
|
フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
|
952
1387
|
|
953
1388
|
---
|
954
1389
|
`page`
|
1390
|
+
```json
|
1391
|
+
{
|
1392
|
+
"type": "integer",
|
1393
|
+
"minimum": 1
|
1394
|
+
}
|
1395
|
+
```
|
955
1396
|
取得したいページ番号です。デフォルト値は1です。
|
956
1397
|
|
957
1398
|
---
|
958
1399
|
`per_page`
|
1400
|
+
```json
|
1401
|
+
{
|
1402
|
+
"type": "integer",
|
1403
|
+
"minimum": 1
|
1404
|
+
}
|
1405
|
+
```
|
959
1406
|
1ページ分のウォレット残高数です。デフォルト値は30です。
|
960
1407
|
|
961
1408
|
---
|
962
1409
|
`expires_at_from`
|
1410
|
+
```json
|
1411
|
+
{
|
1412
|
+
"type": "string",
|
1413
|
+
"format": "date-time"
|
1414
|
+
}
|
1415
|
+
```
|
963
1416
|
有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
964
1417
|
|
965
1418
|
---
|
966
1419
|
`expires_at_to`
|
1420
|
+
```json
|
1421
|
+
{
|
1422
|
+
"type": "string",
|
1423
|
+
"format": "date-time"
|
1424
|
+
}
|
1425
|
+
```
|
967
1426
|
有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
968
1427
|
|
969
1428
|
---
|
970
1429
|
`direction`
|
1430
|
+
```json
|
1431
|
+
{
|
1432
|
+
"type": "string",
|
1433
|
+
"enum": { "asc": "desc" }
|
1434
|
+
}
|
1435
|
+
```
|
971
1436
|
有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
|
972
1437
|
|
973
1438
|
---
|
@@ -985,16 +1450,34 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
985
1450
|
|
986
1451
|
---
|
987
1452
|
`private_money_id`
|
1453
|
+
```json
|
1454
|
+
{
|
1455
|
+
"type": "string",
|
1456
|
+
"format": "uuid"
|
1457
|
+
}
|
1458
|
+
```
|
988
1459
|
マネーIDです。
|
989
1460
|
|
990
1461
|
これによって作成するウォレットのマネーを指定します。
|
991
1462
|
|
992
1463
|
---
|
993
1464
|
`user_name`
|
1465
|
+
```json
|
1466
|
+
{
|
1467
|
+
"type": "string",
|
1468
|
+
"maxLength": 256
|
1469
|
+
}
|
1470
|
+
```
|
994
1471
|
ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
|
995
1472
|
|
996
1473
|
---
|
997
1474
|
`account_name`
|
1475
|
+
```json
|
1476
|
+
{
|
1477
|
+
"type": "string",
|
1478
|
+
"maxLength": 256
|
1479
|
+
}
|
1480
|
+
```
|
998
1481
|
作成するウォレット名です。省略した場合は空文字となります。
|
999
1482
|
|
1000
1483
|
---
|
@@ -1007,10 +1490,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
1007
1490
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1008
1491
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
1009
1492
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
1010
|
-
type: "
|
1011
|
-
is_modified:
|
1012
|
-
from: "2017-
|
1013
|
-
to: "
|
1493
|
+
type: "Srp", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
|
1494
|
+
is_modified: false, # キャンセル済みかどうか
|
1495
|
+
from: "2017-07-25T12:50:19.000000+09:00", # 開始日時
|
1496
|
+
to: "2016-03-31T11:27:56.000000+09:00", # 終了日時
|
1014
1497
|
page: 1, # ページ番号
|
1015
1498
|
per_page: 50 # 1ページ分の取引数
|
1016
1499
|
))
|
@@ -1018,23 +1501,44 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
1018
1501
|
|
1019
1502
|
---
|
1020
1503
|
`private_money_id`
|
1504
|
+
```json
|
1505
|
+
{
|
1506
|
+
"type": "string",
|
1507
|
+
"format": "uuid"
|
1508
|
+
}
|
1509
|
+
```
|
1021
1510
|
マネーIDです。
|
1022
1511
|
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
1023
1512
|
|
1024
1513
|
---
|
1025
1514
|
`sender_customer_id`
|
1515
|
+
```json
|
1516
|
+
{
|
1517
|
+
"type": "string",
|
1518
|
+
"format": "uuid"
|
1519
|
+
}
|
1520
|
+
```
|
1026
1521
|
送金ユーザーIDです。
|
1027
1522
|
|
1028
1523
|
フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
|
1029
1524
|
|
1030
1525
|
---
|
1031
1526
|
`receiver_customer_id`
|
1527
|
+
```json
|
1528
|
+
{
|
1529
|
+
"type": "string",
|
1530
|
+
"format": "uuid"
|
1531
|
+
}
|
1532
|
+
```
|
1032
1533
|
受取ユーザーIDです。
|
1033
1534
|
|
1034
1535
|
フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
|
1035
1536
|
|
1036
1537
|
---
|
1037
1538
|
`type`
|
1539
|
+
```json
|
1540
|
+
{ "type": "string" }
|
1541
|
+
```
|
1038
1542
|
取引の種類でフィルターします。
|
1039
1543
|
|
1040
1544
|
以下の種類を指定できます。
|
@@ -1050,6 +1554,9 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
1050
1554
|
|
1051
1555
|
---
|
1052
1556
|
`is_modified`
|
1557
|
+
```json
|
1558
|
+
{ "type": "boolean" }
|
1559
|
+
```
|
1053
1560
|
キャンセル済みかどうかを判定するフラグです。
|
1054
1561
|
|
1055
1562
|
これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
|
@@ -1058,22 +1565,46 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
|
|
1058
1565
|
|
1059
1566
|
---
|
1060
1567
|
`from`
|
1568
|
+
```json
|
1569
|
+
{
|
1570
|
+
"type": "string",
|
1571
|
+
"format": "date-time"
|
1572
|
+
}
|
1573
|
+
```
|
1061
1574
|
抽出期間の開始日時です。
|
1062
1575
|
|
1063
1576
|
フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
|
1064
1577
|
|
1065
1578
|
---
|
1066
1579
|
`to`
|
1580
|
+
```json
|
1581
|
+
{
|
1582
|
+
"type": "string",
|
1583
|
+
"format": "date-time"
|
1584
|
+
}
|
1585
|
+
```
|
1067
1586
|
抽出期間の終了日時です。
|
1068
1587
|
|
1069
1588
|
フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
|
1070
1589
|
|
1071
1590
|
---
|
1072
1591
|
`page`
|
1592
|
+
```json
|
1593
|
+
{
|
1594
|
+
"type": "integer",
|
1595
|
+
"minimum": 1
|
1596
|
+
}
|
1597
|
+
```
|
1073
1598
|
取得したいページ番号です。
|
1074
1599
|
|
1075
1600
|
---
|
1076
1601
|
`per_page`
|
1602
|
+
```json
|
1603
|
+
{
|
1604
|
+
"type": "integer",
|
1605
|
+
"minimum": 1
|
1606
|
+
}
|
1607
|
+
```
|
1077
1608
|
1ページ分の取引数です。
|
1078
1609
|
|
1079
1610
|
---
|
@@ -1087,11 +1618,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
1087
1618
|
organization_code: "pocketchange", # 組織コード
|
1088
1619
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1089
1620
|
name: "oxスーパー三田店", # 店舗名
|
1090
|
-
postal_code: "
|
1621
|
+
postal_code: "5102030", # 店舗の郵便番号
|
1091
1622
|
address: "東京都港区芝...", # 店舗の住所
|
1092
|
-
tel: "
|
1093
|
-
email: "
|
1094
|
-
external_id: "
|
1623
|
+
tel: "02-200-2918", # 店舗の電話番号
|
1624
|
+
email: "fbLwdjVaS9@Jydp.com", # 店舗のメールアドレス
|
1625
|
+
external_id: "qXjqW7D3u", # 店舗の外部ID
|
1095
1626
|
page: 1, # ページ番号
|
1096
1627
|
per_page: 50 # 1ページ分の取引数
|
1097
1628
|
))
|
@@ -1099,50 +1630,113 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
1099
1630
|
|
1100
1631
|
---
|
1101
1632
|
`organization_code`
|
1633
|
+
```json
|
1634
|
+
{
|
1635
|
+
"type": "string",
|
1636
|
+
"maxLength": 32,
|
1637
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
1638
|
+
}
|
1639
|
+
```
|
1102
1640
|
このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
|
1103
1641
|
|
1104
1642
|
|
1105
1643
|
---
|
1106
1644
|
`private_money_id`
|
1645
|
+
```json
|
1646
|
+
{
|
1647
|
+
"type": "string",
|
1648
|
+
"format": "uuid"
|
1649
|
+
}
|
1650
|
+
```
|
1107
1651
|
このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
|
1108
1652
|
|
1109
1653
|
|
1110
1654
|
---
|
1111
1655
|
`name`
|
1656
|
+
```json
|
1657
|
+
{
|
1658
|
+
"type": "string",
|
1659
|
+
"minLength": 1,
|
1660
|
+
"maxLength": 256
|
1661
|
+
}
|
1662
|
+
```
|
1112
1663
|
このパラメータを渡すとその名前の店舗のみが返されます。
|
1113
1664
|
|
1114
1665
|
|
1115
1666
|
---
|
1116
1667
|
`postal_code`
|
1668
|
+
```json
|
1669
|
+
{
|
1670
|
+
"type": "string",
|
1671
|
+
"pattern": "^[0-9]{3}-?[0-9]{4}$"
|
1672
|
+
}
|
1673
|
+
```
|
1117
1674
|
このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
|
1118
1675
|
|
1119
1676
|
|
1120
1677
|
---
|
1121
1678
|
`address`
|
1679
|
+
```json
|
1680
|
+
{
|
1681
|
+
"type": "string",
|
1682
|
+
"maxLength": 256
|
1683
|
+
}
|
1684
|
+
```
|
1122
1685
|
このパラメータを渡すとその住所が登録された店舗のみが返されます。
|
1123
1686
|
|
1124
1687
|
|
1125
1688
|
---
|
1126
1689
|
`tel`
|
1690
|
+
```json
|
1691
|
+
{
|
1692
|
+
"type": "string",
|
1693
|
+
"pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
|
1694
|
+
}
|
1695
|
+
```
|
1127
1696
|
このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
|
1128
1697
|
|
1129
1698
|
|
1130
1699
|
---
|
1131
1700
|
`email`
|
1701
|
+
```json
|
1702
|
+
{
|
1703
|
+
"type": "string",
|
1704
|
+
"format": "email",
|
1705
|
+
"maxLength": 256
|
1706
|
+
}
|
1707
|
+
```
|
1132
1708
|
このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
|
1133
1709
|
|
1134
1710
|
|
1135
1711
|
---
|
1136
1712
|
`external_id`
|
1713
|
+
```json
|
1714
|
+
{
|
1715
|
+
"type": "string",
|
1716
|
+
"maxLength": 36
|
1717
|
+
}
|
1718
|
+
```
|
1137
1719
|
このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
|
1138
1720
|
|
1139
1721
|
|
1140
1722
|
---
|
1141
1723
|
`page`
|
1724
|
+
```json
|
1725
|
+
{
|
1726
|
+
"type": "integer",
|
1727
|
+
"minimum": 1
|
1728
|
+
}
|
1729
|
+
```
|
1142
1730
|
取得したいページ番号です。
|
1143
1731
|
|
1144
1732
|
---
|
1145
1733
|
`per_page`
|
1734
|
+
```json
|
1735
|
+
{
|
1736
|
+
"type": "integer",
|
1737
|
+
"minimum": 1
|
1738
|
+
}
|
1739
|
+
```
|
1146
1740
|
1ページ分の取引数です。
|
1147
1741
|
|
1148
1742
|
---
|
@@ -1153,39 +1747,56 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
1153
1747
|
```ruby
|
1154
1748
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
1155
1749
|
"oxスーパー三田店", # shop_name: 店舗名
|
1156
|
-
shop_postal_code: "
|
1750
|
+
shop_postal_code: "373-4054", # 店舗の郵便番号
|
1157
1751
|
shop_address: "東京都港区芝...", # 店舗の住所
|
1158
|
-
shop_tel: "083-
|
1159
|
-
shop_email: "
|
1160
|
-
shop_external_id: "
|
1752
|
+
shop_tel: "083-779-345", # 店舗の電話番号
|
1753
|
+
shop_email: "dPl4JIrQmL@FWJx.com", # 店舗のメールアドレス
|
1754
|
+
shop_external_id: "GB9NLriuIsMTYyCUoOEa9YZaUNPTMagDSPeH", # 店舗の外部ID
|
1161
1755
|
organization_code: "ox-supermarket" # 組織コード
|
1162
1756
|
))
|
1163
1757
|
```
|
1164
1758
|
成功したときは[User](#user)オブジェクトを返します
|
1165
|
-
<a name="create-shop-
|
1759
|
+
<a name="create-shop-v2"></a>
|
1166
1760
|
#### 新規店舗を追加する
|
1167
1761
|
```ruby
|
1168
|
-
response = $client.send(Pokepay::Request::
|
1762
|
+
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
1169
1763
|
"oxスーパー三田店", # name: 店舗名
|
1170
|
-
postal_code: "
|
1764
|
+
postal_code: "9873173", # 店舗の郵便番号
|
1171
1765
|
address: "東京都港区芝...", # 店舗の住所
|
1172
|
-
tel: "
|
1173
|
-
email: "
|
1174
|
-
external_id: "
|
1766
|
+
tel: "0097712-9463", # 店舗の電話番号
|
1767
|
+
email: "oPTyGfjAlv@bOwB.com", # 店舗のメールアドレス
|
1768
|
+
external_id: "ftL3mTfJhTjDs9c8QNU", # 店舗の外部ID
|
1175
1769
|
organization_code: "ox-supermarket", # 組織コード
|
1176
1770
|
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"
|
1771
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
1178
1772
|
))
|
1179
1773
|
```
|
1180
1774
|
|
1181
1775
|
---
|
1182
1776
|
`name`
|
1777
|
+
```json
|
1778
|
+
{
|
1779
|
+
"type": "string",
|
1780
|
+
"minLength": 1,
|
1781
|
+
"maxLength": 256
|
1782
|
+
}
|
1783
|
+
```
|
1183
1784
|
店舗名です。
|
1184
1785
|
|
1185
1786
|
同一組織内に同名の店舗があった場合は`name_conflict`エラーが返ります。
|
1186
1787
|
|
1187
1788
|
---
|
1188
1789
|
`private_money_ids`
|
1790
|
+
```json
|
1791
|
+
{
|
1792
|
+
"type": "array",
|
1793
|
+
"minItems": 1,
|
1794
|
+
"items": {
|
1795
|
+
"type": "string",
|
1796
|
+
"format": "uuid"
|
1797
|
+
}
|
1798
|
+
}
|
1799
|
+
```
|
1189
1800
|
店舗で有効にするマネーIDの配列を指定します。
|
1190
1801
|
|
1191
1802
|
店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
|
@@ -1193,6 +1804,16 @@ response = $client.send(Pokepay::Request::CreateShopV.new(
|
|
1193
1804
|
|
1194
1805
|
---
|
1195
1806
|
`can_topup_private_money_ids`
|
1807
|
+
```json
|
1808
|
+
{
|
1809
|
+
"type": "array",
|
1810
|
+
"minItems": 0,
|
1811
|
+
"items": {
|
1812
|
+
"type": "string",
|
1813
|
+
"format": "uuid"
|
1814
|
+
}
|
1815
|
+
}
|
1816
|
+
```
|
1196
1817
|
店舗でチャージ可能にするマネーIDの配列を指定します。
|
1197
1818
|
|
1198
1819
|
このパラメータは発行体のみが指定でき、自身が発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
|
@@ -1218,40 +1839,82 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
1218
1839
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
1219
1840
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
1220
1841
|
name: "oxスーパー三田店", # 店舗名
|
1221
|
-
postal_code: "
|
1842
|
+
postal_code: "841-5932", # 店舗の郵便番号
|
1222
1843
|
address: "東京都港区芝...", # 店舗の住所
|
1223
|
-
tel: "
|
1224
|
-
email: "
|
1225
|
-
external_id: "
|
1226
|
-
private_money_ids: [],
|
1227
|
-
can_topup_private_money_ids: [
|
1844
|
+
tel: "0870057651", # 店舗の電話番号
|
1845
|
+
email: "6qe5BUa3mr@tCxk.com", # 店舗のメールアドレス
|
1846
|
+
external_id: "ktMbdZ0Ff5nebRZC0vDYNEW", # 店舗の外部ID
|
1847
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
1848
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
1228
1849
|
))
|
1229
1850
|
```
|
1230
1851
|
|
1231
1852
|
---
|
1232
1853
|
`name`
|
1854
|
+
```json
|
1855
|
+
{
|
1856
|
+
"type": "string",
|
1857
|
+
"minLength": 1,
|
1858
|
+
"maxLength": 256
|
1859
|
+
}
|
1860
|
+
```
|
1233
1861
|
店舗名です。
|
1234
1862
|
|
1235
1863
|
同一組織内に同名の店舗があった場合は`shop_name_conflict`エラーが返ります。
|
1236
1864
|
|
1237
1865
|
---
|
1238
1866
|
`postal_code`
|
1867
|
+
```json
|
1868
|
+
{
|
1869
|
+
"type": "string",
|
1870
|
+
"pattern": "^[0-9]{3}-?[0-9]{4}$"
|
1871
|
+
}
|
1872
|
+
```
|
1239
1873
|
店舗住所の郵便番号(7桁の数字)です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
|
1240
1874
|
|
1241
1875
|
---
|
1242
1876
|
`tel`
|
1877
|
+
```json
|
1878
|
+
{
|
1879
|
+
"type": "string",
|
1880
|
+
"pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
|
1881
|
+
}
|
1882
|
+
```
|
1243
1883
|
店舗の電話番号です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
|
1244
1884
|
|
1245
1885
|
---
|
1246
1886
|
`email`
|
1887
|
+
```json
|
1888
|
+
{
|
1889
|
+
"type": "string",
|
1890
|
+
"format": "email",
|
1891
|
+
"maxLength": 256
|
1892
|
+
}
|
1893
|
+
```
|
1247
1894
|
店舗の連絡先メールアドレスです。明示的に空の値を設定するにはNULLを指定します。
|
1248
1895
|
|
1249
1896
|
---
|
1250
1897
|
`external_id`
|
1898
|
+
```json
|
1899
|
+
{
|
1900
|
+
"type": "string",
|
1901
|
+
"maxLength": 36
|
1902
|
+
}
|
1903
|
+
```
|
1251
1904
|
店舗の外部IDです(最大36文字)。明示的に空の値を設定するにはNULLを指定します。
|
1252
1905
|
|
1253
1906
|
---
|
1254
1907
|
`private_money_ids`
|
1908
|
+
```json
|
1909
|
+
{
|
1910
|
+
"type": "array",
|
1911
|
+
"minItems": 0,
|
1912
|
+
"items": {
|
1913
|
+
"type": "string",
|
1914
|
+
"format": "uuid"
|
1915
|
+
}
|
1916
|
+
}
|
1917
|
+
```
|
1255
1918
|
店舗で有効にするマネーIDの配列を指定します。
|
1256
1919
|
|
1257
1920
|
店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
|
@@ -1259,6 +1922,16 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
1259
1922
|
|
1260
1923
|
---
|
1261
1924
|
`can_topup_private_money_ids`
|
1925
|
+
```json
|
1926
|
+
{
|
1927
|
+
"type": "array",
|
1928
|
+
"minItems": 0,
|
1929
|
+
"items": {
|
1930
|
+
"type": "string",
|
1931
|
+
"format": "uuid"
|
1932
|
+
}
|
1933
|
+
}
|
1934
|
+
```
|
1262
1935
|
店舗でチャージ可能にするマネーIDの配列を指定します。
|
1263
1936
|
|
1264
1937
|
このパラメータは発行体のみが指定でき、発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
|
@@ -1278,6 +1951,12 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
1278
1951
|
|
1279
1952
|
---
|
1280
1953
|
`user_id`
|
1954
|
+
```json
|
1955
|
+
{
|
1956
|
+
"type": "string",
|
1957
|
+
"format": "uuid"
|
1958
|
+
}
|
1959
|
+
```
|
1281
1960
|
ユーザーIDです。
|
1282
1961
|
|
1283
1962
|
指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
|
@@ -1300,6 +1979,13 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
1300
1979
|
|
1301
1980
|
---
|
1302
1981
|
`organization_code`
|
1982
|
+
```json
|
1983
|
+
{
|
1984
|
+
"type": "string",
|
1985
|
+
"maxLength": 32,
|
1986
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
1987
|
+
}
|
1988
|
+
```
|
1303
1989
|
パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
|
1304
1990
|
|
1305
1991
|
---
|
@@ -1309,8 +1995,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
1309
1995
|
```ruby
|
1310
1996
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
1311
1997
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1312
|
-
from: "
|
1313
|
-
to: "
|
1998
|
+
from: "2021-10-16T13:57:56.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
1999
|
+
to: "2019-06-24T18:12:50.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
1314
2000
|
page: 1, # ページ番号
|
1315
2001
|
per_page: 50 # 1ページ分の取引数
|
1316
2002
|
))
|
@@ -1324,23 +2010,38 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
1324
2010
|
CSVファイルから一括取引をします。
|
1325
2011
|
```ruby
|
1326
2012
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
1327
|
-
"
|
1328
|
-
"
|
1329
|
-
"
|
1330
|
-
description: "
|
2013
|
+
"XSVHRY4YZdsEswklf9tWgAr9K", # name: 一括取引タスク名
|
2014
|
+
"jsUzeefEv", # content: 取引する情報のCSV
|
2015
|
+
"U98BI4BdtnYVFOF5IXA6lNw66Yqs62ry4EX0", # request_id: リクエストID
|
2016
|
+
description: "5SsjBGi2vt3IVLujfoeXIyA6Ao821XE55hc29pv4sZBooZY5wA4Og2kdAYLVTxSOsaSsUmdY0" # 一括取引の説明
|
1331
2017
|
))
|
1332
2018
|
```
|
1333
2019
|
|
1334
2020
|
---
|
1335
2021
|
`name`
|
2022
|
+
```json
|
2023
|
+
{
|
2024
|
+
"type": "string",
|
2025
|
+
"maxLength": 32
|
2026
|
+
}
|
2027
|
+
```
|
1336
2028
|
一括取引タスクの管理用の名前です。
|
1337
2029
|
|
1338
2030
|
---
|
1339
2031
|
`description`
|
2032
|
+
```json
|
2033
|
+
{
|
2034
|
+
"type": "string",
|
2035
|
+
"maxLength": 128
|
2036
|
+
}
|
2037
|
+
```
|
1340
2038
|
一括取引タスクの管理用の説明文です。
|
1341
2039
|
|
1342
2040
|
---
|
1343
2041
|
`content`
|
2042
|
+
```json
|
2043
|
+
{ "type": "string" }
|
2044
|
+
```
|
1344
2045
|
一括取引する情報を書いたCSVの文字列です。
|
1345
2046
|
1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
|
1346
2047
|
カラムは以下の7つです。任意のカラムには空文字を指定します。
|
@@ -1366,6 +2067,13 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
1366
2067
|
|
1367
2068
|
---
|
1368
2069
|
`request_id`
|
2070
|
+
```json
|
2071
|
+
{
|
2072
|
+
"type": "string",
|
2073
|
+
"minLength": 36,
|
2074
|
+
"maxLength": 36
|
2075
|
+
}
|
2076
|
+
```
|
1369
2077
|
重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
|
1370
2078
|
|
1371
2079
|
---
|
@@ -1664,3 +2372,26 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
1664
2372
|
* `tel (string)`: 店舗の電話番号
|
1665
2373
|
* `email (string)`: 店舗のメールアドレス
|
1666
2374
|
* `external_id (string)`: 店舗の外部ID
|
2375
|
+
|
2376
|
+
<a name="organization"></a>
|
2377
|
+
## Organization
|
2378
|
+
* `code (string)`: 組織コード
|
2379
|
+
* `name (string)`: 組織名
|
2380
|
+
|
2381
|
+
<a name="organization-summary"></a>
|
2382
|
+
## OrganizationSummary
|
2383
|
+
* `count (integer)`:
|
2384
|
+
* `money_amount (double)`:
|
2385
|
+
* `money_count (integer)`:
|
2386
|
+
* `point_amount (double)`:
|
2387
|
+
* `point_count (integer)`:
|
2388
|
+
|
2389
|
+
<a name="account-without-private-money-detail"></a>
|
2390
|
+
## AccountWithoutPrivateMoneyDetail
|
2391
|
+
* `id (string)`:
|
2392
|
+
* `name (string)`:
|
2393
|
+
* `is_suspended (boolean)`:
|
2394
|
+
* `private_money_id (string)`:
|
2395
|
+
* `user (User)`:
|
2396
|
+
|
2397
|
+
`user`は [User](#user) オブジェクトを返します。
|