pokepay_partner_ruby_sdk 0.3.0 → 0.3.2
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 +4 -4
- data/Gemfile.lock +1 -1
- data/docs/index.md +592 -187
- data/lib/pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/request/create_webhook.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb +5 -5
- data/lib/pokepay_partner_ruby_sdk/request/get_coupon.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_bulk_transaction_jobs.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_coupons.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_webhooks.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/update_webhook.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/response/coupon.rb +48 -0
- data/lib/pokepay_partner_ruby_sdk/response/coupon_detail.rb +55 -0
- data/lib/pokepay_partner_ruby_sdk/response/organization_worker_task_webhook.rb +21 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_coupons.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_organization_worker_task_webhook.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/private_money.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/shop_with_accounts.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/shop_with_metadata.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/transaction.rb +4 -0
- data/lib/pokepay_partner_ruby_sdk/response/transaction_detail.rb +4 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +11 -2
- data/partner.yaml +591 -53
- metadata +13 -3
- data/lib/pokepay_partner_ruby_sdk/response/user_transaction.rb +0 -33
data/docs/index.md
CHANGED
|
@@ -208,13 +208,18 @@ response.body
|
|
|
208
208
|
- [ListCampaigns](#list-campaigns): キャンペーン一覧を取得する
|
|
209
209
|
- [GetCampaign](#get-campaign): キャンペーンを取得する
|
|
210
210
|
- [UpdateCampaign](#update-campaign): ポイント付与キャンペーンを更新する
|
|
211
|
+
- [CreateWebhook](#create-webhook): webhookの作成
|
|
212
|
+
- [ListWebhooks](#list-webhooks): 作成したWebhookの一覧を返す
|
|
213
|
+
- [UpdateWebhook](#update-webhook): Webhookの更新
|
|
214
|
+
- [ListCoupons](#list-coupons): クーポン一覧の取得
|
|
215
|
+
- [GetCoupon](#get-coupon): クーポンの取得
|
|
211
216
|
### Transaction
|
|
212
217
|
<a name="get-cpm-token"></a>
|
|
213
218
|
#### CPMトークンの状態取得
|
|
214
219
|
CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
|
|
215
220
|
```ruby
|
|
216
221
|
response = $client.send(Pokepay::Request::GetCpmToken.new(
|
|
217
|
-
"
|
|
222
|
+
"7PJ09whlF6CVlMKFHkTHEG" # cpm_token: CPMトークン
|
|
218
223
|
))
|
|
219
224
|
```
|
|
220
225
|
|
|
@@ -236,15 +241,15 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
|
|
|
236
241
|
取引一覧を返します。
|
|
237
242
|
```ruby
|
|
238
243
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
239
|
-
from: "
|
|
240
|
-
to: "2017-
|
|
244
|
+
from: "2017-10-30T21:52:54.000000+09:00", # 開始日時
|
|
245
|
+
to: "2017-01-04T03:27:45.000000+09:00", # 終了日時
|
|
241
246
|
page: 1, # ページ番号
|
|
242
247
|
per_page: 50, # 1ページ分の取引数
|
|
243
248
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
244
249
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
245
250
|
customer_name: "太郎", # エンドユーザー名
|
|
246
251
|
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
|
247
|
-
transaction_id: "
|
|
252
|
+
transaction_id: "VUZ", # 取引ID
|
|
248
253
|
organization_code: "pocketchange", # 組織コード
|
|
249
254
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
250
255
|
is_modified: false, # キャンセルフラグ
|
|
@@ -448,10 +453,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
|
448
453
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
449
454
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
450
455
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
451
|
-
money_amount:
|
|
452
|
-
point_amount:
|
|
453
|
-
point_expires_at: "2023-
|
|
454
|
-
description: "
|
|
456
|
+
money_amount: 9115,
|
|
457
|
+
point_amount: 9606,
|
|
458
|
+
point_expires_at: "2023-03-22T22:26:15.000000+09:00", # ポイント有効期限
|
|
459
|
+
description: "xzFUF6ihvlI4uoOEnKraNjpsN9SjDxtxrgs7e0dkiAAa8jwX6FLCB1XlvzBazSCE1h"
|
|
455
460
|
))
|
|
456
461
|
```
|
|
457
462
|
|
|
@@ -480,11 +485,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
480
485
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
481
486
|
customer_name: "太郎", # エンドユーザー名
|
|
482
487
|
description: "店頭QRコードによる支払い", # 取引説明文
|
|
483
|
-
transaction_id: "
|
|
484
|
-
is_modified:
|
|
488
|
+
transaction_id: "E", # 取引ID
|
|
489
|
+
is_modified: true, # キャンセルフラグ
|
|
485
490
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
486
|
-
from: "
|
|
487
|
-
to: "
|
|
491
|
+
from: "2022-11-05T14:20:24.000000+09:00", # 開始日時
|
|
492
|
+
to: "2020-02-25T03:45:37.000000+09:00", # 終了日時
|
|
488
493
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransactionのID
|
|
489
494
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransactionのID
|
|
490
495
|
per_page: 50 # 1ページ分の取引数
|
|
@@ -713,9 +718,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
713
718
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
714
719
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
715
720
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
716
|
-
money_amount:
|
|
717
|
-
point_amount:
|
|
718
|
-
point_expires_at: "
|
|
721
|
+
money_amount: 7659, # マネー額
|
|
722
|
+
point_amount: 1630, # ポイント額
|
|
723
|
+
point_expires_at: "2021-06-03T04:49:28.000000+09:00", # ポイント有効期限
|
|
719
724
|
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
|
720
725
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
721
726
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
@@ -857,7 +862,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
857
862
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
858
863
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
859
864
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
860
|
-
|
|
865
|
+
5038, # amount: 支払い額
|
|
861
866
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
862
867
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
863
868
|
products: [{"jan_code":"abc",
|
|
@@ -865,6 +870,16 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
865
870
|
"unit_price":100,
|
|
866
871
|
"price": 100,
|
|
867
872
|
"is_discounted": false,
|
|
873
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
874
|
+
"name":"name1",
|
|
875
|
+
"unit_price":100,
|
|
876
|
+
"price": 100,
|
|
877
|
+
"is_discounted": false,
|
|
878
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
879
|
+
"name":"name1",
|
|
880
|
+
"unit_price":100,
|
|
881
|
+
"price": 100,
|
|
882
|
+
"is_discounted": false,
|
|
868
883
|
"other":"{}"}], # 商品情報データ
|
|
869
884
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
870
885
|
))
|
|
@@ -983,9 +998,9 @@ CPMトークンに設定されたスコープの取引を作ることができ
|
|
|
983
998
|
|
|
984
999
|
```ruby
|
|
985
1000
|
response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
|
986
|
-
"
|
|
1001
|
+
"IPy7HW7Ee7skB9BB1YNClE", # cpm_token: CPMトークン
|
|
987
1002
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
988
|
-
|
|
1003
|
+
3112.0, # amount: 取引金額
|
|
989
1004
|
description: "たい焼き(小倉)", # 取引説明文
|
|
990
1005
|
metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
|
|
991
1006
|
products: [{"jan_code":"abc",
|
|
@@ -998,6 +1013,11 @@ response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
|
|
998
1013
|
"unit_price":100,
|
|
999
1014
|
"price": 100,
|
|
1000
1015
|
"is_discounted": false,
|
|
1016
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
1017
|
+
"name":"name1",
|
|
1018
|
+
"unit_price":100,
|
|
1019
|
+
"price": 100,
|
|
1020
|
+
"is_discounted": false,
|
|
1001
1021
|
"other":"{}"}], # 商品情報データ
|
|
1002
1022
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
1003
1023
|
))
|
|
@@ -1105,7 +1125,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
1105
1125
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
1106
1126
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
1107
1127
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1108
|
-
|
|
1128
|
+
9019.0, # amount: 送金額
|
|
1109
1129
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
1110
1130
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1111
1131
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
@@ -1207,8 +1227,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
|
1207
1227
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1208
1228
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1209
1229
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1210
|
-
|
|
1211
|
-
description: "
|
|
1230
|
+
2105.0,
|
|
1231
|
+
description: "A30l6vspNWH9u8x4Yq2mxjIub5W9d4fa79SnOHSfjKkp3QkI11kPUOWI",
|
|
1212
1232
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
1213
1233
|
))
|
|
1214
1234
|
```
|
|
@@ -1265,7 +1285,7 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
|
1265
1285
|
response = $client.send(Pokepay::Request::RefundTransaction.new(
|
|
1266
1286
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
|
|
1267
1287
|
description: "返品対応のため", # 取引履歴に表示する返金事由
|
|
1268
|
-
returning_point_expires_at: "
|
|
1288
|
+
returning_point_expires_at: "2021-04-20T23:17:51.000000+09:00" # 返却ポイントの有効期限
|
|
1269
1289
|
))
|
|
1270
1290
|
```
|
|
1271
1291
|
|
|
@@ -1324,8 +1344,8 @@ CSVの作成は非同期で行われるため完了まで少しの間待つ必
|
|
|
1324
1344
|
また、指定期間より前の決済を時間をおいてキャンセルした場合などには payment_money_amount, payment_point_amount, payment_transaction_count が負の値になることもあることに留意してください。
|
|
1325
1345
|
```ruby
|
|
1326
1346
|
response = $client.send(Pokepay::Request::RequestUserStats.new(
|
|
1327
|
-
"
|
|
1328
|
-
"
|
|
1347
|
+
"2018-10-07T05:51:38.000000+09:00", # from: 集計期間の開始時刻
|
|
1348
|
+
"2017-09-02T22:46:29.000000+09:00" # to: 集計期間の終了時刻
|
|
1329
1349
|
))
|
|
1330
1350
|
```
|
|
1331
1351
|
|
|
@@ -1360,8 +1380,8 @@ response = $client.send(Pokepay::Request::RequestUserStats.new(
|
|
|
1360
1380
|
```ruby
|
|
1361
1381
|
response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
|
1362
1382
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1363
|
-
from: "
|
|
1364
|
-
to: "
|
|
1383
|
+
from: "2019-03-02T08:20:50.000000+09:00", # 集計期間の開始時刻
|
|
1384
|
+
to: "2024-03-03T23:37:37.000000+09:00", # 集計期間の終了時刻
|
|
1365
1385
|
transfer_types: ["topup", "payment"] # 取引明細種別 (複数指定可)
|
|
1366
1386
|
))
|
|
1367
1387
|
```
|
|
@@ -1430,19 +1450,19 @@ response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
|
|
1430
1450
|
####
|
|
1431
1451
|
```ruby
|
|
1432
1452
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
1433
|
-
from: "
|
|
1434
|
-
to: "
|
|
1435
|
-
page:
|
|
1436
|
-
per_page:
|
|
1453
|
+
from: "2023-07-03T19:49:26.000000+09:00",
|
|
1454
|
+
to: "2016-05-31T03:04:08.000000+09:00",
|
|
1455
|
+
page: 8148,
|
|
1456
|
+
per_page: 6032,
|
|
1437
1457
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1438
|
-
shop_name: "
|
|
1458
|
+
shop_name: "kWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2",
|
|
1439
1459
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1440
|
-
customer_name: "
|
|
1460
|
+
customer_name: "MYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC39nZBUv4F8J7UzyDYEv7bct",
|
|
1441
1461
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1442
1462
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1443
1463
|
is_modified: false,
|
|
1444
|
-
transaction_types: ["
|
|
1445
|
-
transfer_types: ["
|
|
1464
|
+
transaction_types: ["exchange"],
|
|
1465
|
+
transfer_types: ["campaign"], # 取引明細の種類でフィルターします。
|
|
1446
1466
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
1447
1467
|
))
|
|
1448
1468
|
```
|
|
@@ -1507,20 +1527,20 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
|
1507
1527
|
```ruby
|
|
1508
1528
|
response = $client.send(Pokepay::Request::ListTransfersV2.new(
|
|
1509
1529
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
1510
|
-
shop_name: "
|
|
1530
|
+
shop_name: "RBzp0gixsKZWoUeORL98QDv9TW3tonru5DxxR1kiR4daTST401zYU9O5bmxo5R8HDeIrg38UDixRQOsOxJyiut30oRsSLi4FAWjvNFlMGhO7MjoFiHLtN9Yqy7R5Sel4rqjqD6mB2gz0FIdNSbIrXOBo1I3rdkL", # 店舗名
|
|
1511
1531
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
1512
|
-
customer_name: "
|
|
1532
|
+
customer_name: "5vuUQlHHWHdfJKJGJOe4o3A7Ast7GZKKewMQbpvWdRIf0j2NcGpd9kTg7fbzWuGj28b", # エンドユーザー名
|
|
1513
1533
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
|
|
1514
1534
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1515
1535
|
is_modified: false, # キャンセルフラグ
|
|
1516
|
-
transaction_types: ["expire", "payment", "topup", "
|
|
1536
|
+
transaction_types: ["exchange", "expire", "cashback", "payment", "topup", "transfer"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
1517
1537
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransferのID
|
|
1518
1538
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransferのID
|
|
1519
1539
|
per_page: 50, # 1ページ分の取引数
|
|
1520
|
-
transfer_types: ["
|
|
1540
|
+
transfer_types: ["topup", "cashback"], # 取引明細種別 (複数指定可)
|
|
1521
1541
|
description: "店頭QRコードによる支払い", # 取引詳細説明文
|
|
1522
|
-
from: "
|
|
1523
|
-
to: "
|
|
1542
|
+
from: "2024-05-24T18:40:54.000000+09:00", # 開始日時
|
|
1543
|
+
to: "2019-05-17T21:17:02.000000+09:00" # 終了日時
|
|
1524
1544
|
))
|
|
1525
1545
|
```
|
|
1526
1546
|
|
|
@@ -1782,13 +1802,13 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
|
|
|
1782
1802
|
```ruby
|
|
1783
1803
|
response = $client.send(Pokepay::Request::CreateCheck.new(
|
|
1784
1804
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
|
|
1785
|
-
money_amount:
|
|
1786
|
-
point_amount:
|
|
1805
|
+
money_amount: 2033.0, # 付与マネー額
|
|
1806
|
+
point_amount: 748.0, # 付与ポイント額
|
|
1787
1807
|
description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
|
|
1788
|
-
is_onetime:
|
|
1789
|
-
usage_limit:
|
|
1790
|
-
expires_at: "
|
|
1791
|
-
point_expires_at: "
|
|
1808
|
+
is_onetime: false, # ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
|
|
1809
|
+
usage_limit: 7787, # ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
|
|
1810
|
+
expires_at: "2020-11-15T19:34:41.000000+09:00", # チャージQR自体の失効日時
|
|
1811
|
+
point_expires_at: "2022-07-09T22:12:18.000000+09:00", # チャージQRによって付与されるポイントの失効日時
|
|
1792
1812
|
point_expires_in_days: 60, # チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
|
|
1793
1813
|
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗アカウントのID
|
|
1794
1814
|
))
|
|
@@ -1826,7 +1846,8 @@ response = $client.send(Pokepay::Request::CreateCheck.new(
|
|
|
1826
1846
|
```ruby
|
|
1827
1847
|
response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
|
|
1828
1848
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # check_id: チャージ用QRコードのID
|
|
1829
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
1849
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
1850
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
1830
1851
|
))
|
|
1831
1852
|
```
|
|
1832
1853
|
|
|
@@ -1854,6 +1875,20 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
1854
1875
|
|
|
1855
1876
|
送金先のエンドユーザーを指定します。
|
|
1856
1877
|
|
|
1878
|
+
---
|
|
1879
|
+
`request_id`
|
|
1880
|
+
```json
|
|
1881
|
+
{
|
|
1882
|
+
"type": "string",
|
|
1883
|
+
"format": "uuid"
|
|
1884
|
+
}
|
|
1885
|
+
```
|
|
1886
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
|
1887
|
+
|
|
1888
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
|
1889
|
+
|
|
1890
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
|
1891
|
+
|
|
1857
1892
|
---
|
|
1858
1893
|
成功したときは[TransactionDetail](#transaction-detail)オブジェクトを返します
|
|
1859
1894
|
### Bill
|
|
@@ -1863,18 +1898,18 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
1863
1898
|
支払いQRコード一覧を表示します。
|
|
1864
1899
|
```ruby
|
|
1865
1900
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
1866
|
-
page:
|
|
1867
|
-
per_page:
|
|
1868
|
-
bill_id: "
|
|
1901
|
+
page: 1204, # ページ番号
|
|
1902
|
+
per_page: 4491, # 1ページの表示数
|
|
1903
|
+
bill_id: "QfVcwKEO", # 支払いQRコードのID
|
|
1869
1904
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1870
|
-
organization_code: "
|
|
1905
|
+
organization_code: "v", # 組織コード
|
|
1871
1906
|
description: "test bill", # 取引説明文
|
|
1872
|
-
created_from: "
|
|
1873
|
-
created_to: "
|
|
1907
|
+
created_from: "2022-11-12T00:44:34.000000+09:00", # 作成日時(起点)
|
|
1908
|
+
created_to: "2015-10-17T09:46:04.000000+09:00", # 作成日時(終点)
|
|
1874
1909
|
shop_name: "bill test shop1", # 店舗名
|
|
1875
1910
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
1876
|
-
lower_limit_amount:
|
|
1877
|
-
upper_limit_amount:
|
|
1911
|
+
lower_limit_amount: 6180, # 金額の範囲によるフィルタ(下限)
|
|
1912
|
+
upper_limit_amount: 7003, # 金額の範囲によるフィルタ(上限)
|
|
1878
1913
|
is_disabled: true # 支払いQRコードが無効化されているかどうか
|
|
1879
1914
|
))
|
|
1880
1915
|
```
|
|
@@ -2019,7 +2054,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
|
2019
2054
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
2020
2055
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
2021
2056
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
2022
|
-
amount:
|
|
2057
|
+
amount: 5903.0, # 支払い額
|
|
2023
2058
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
2024
2059
|
))
|
|
2025
2060
|
```
|
|
@@ -2043,7 +2078,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
|
2043
2078
|
```ruby
|
|
2044
2079
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
2045
2080
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
2046
|
-
amount:
|
|
2081
|
+
amount: 1197.0, # 支払い額
|
|
2047
2082
|
description: "test bill", # 説明文
|
|
2048
2083
|
is_disabled: true # 無効化されているかどうか
|
|
2049
2084
|
))
|
|
@@ -2108,9 +2143,9 @@ Cashtrayを作成します。
|
|
|
2108
2143
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
2109
2144
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2110
2145
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
2111
|
-
|
|
2146
|
+
1224.0, # amount: 金額
|
|
2112
2147
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
2113
|
-
expires_in:
|
|
2148
|
+
expires_in: 4068 # 失効時間(秒)
|
|
2114
2149
|
))
|
|
2115
2150
|
```
|
|
2116
2151
|
|
|
@@ -2191,6 +2226,8 @@ Cashtrayの現在の状態に加え、エンドユーザーのCashtray読み取
|
|
|
2191
2226
|
- チャージ時に、エンドユーザーのウォレット上限を超えて取引が完了できなかったときに返されます
|
|
2192
2227
|
- `account_transfer_limit_exceeded (422)`
|
|
2193
2228
|
- マネーに設定されている一度の取引金額の上限を超えたため、取引が完了できなかったときに返されます
|
|
2229
|
+
- `account_money_topup_transfer_limit_exceeded (422)`
|
|
2230
|
+
- マネーに設定されている一度のマネーチャージ金額の上限を超えたため、取引が完了できなかったときに返されます
|
|
2194
2231
|
- `account_not_found (422)`
|
|
2195
2232
|
- Cashtrayに設定されたマネーのウォレットをエンドユーザーが持っていなかったときに返されます
|
|
2196
2233
|
|
|
@@ -2271,9 +2308,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
|
2271
2308
|
```ruby
|
|
2272
2309
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
2273
2310
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
2274
|
-
amount:
|
|
2311
|
+
amount: 4570.0, # 金額
|
|
2275
2312
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
2276
|
-
expires_in:
|
|
2313
|
+
expires_in: 2858 # 失効時間(秒)
|
|
2277
2314
|
))
|
|
2278
2315
|
```
|
|
2279
2316
|
|
|
@@ -2355,7 +2392,7 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
|
2355
2392
|
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
2356
2393
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2357
2394
|
is_suspended: false, # ウォレットが凍結されているかどうか
|
|
2358
|
-
status: "
|
|
2395
|
+
status: "suspended", # ウォレット状態
|
|
2359
2396
|
can_transfer_topup: false # チャージ可能かどうか
|
|
2360
2397
|
))
|
|
2361
2398
|
```
|
|
@@ -2435,11 +2472,11 @@ response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
|
2435
2472
|
```ruby
|
|
2436
2473
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
2437
2474
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2438
|
-
page:
|
|
2439
|
-
per_page:
|
|
2440
|
-
expires_at_from: "
|
|
2441
|
-
expires_at_to: "
|
|
2442
|
-
direction: "
|
|
2475
|
+
page: 2449, # ページ番号
|
|
2476
|
+
per_page: 520, # 1ページ分の取引数
|
|
2477
|
+
expires_at_from: "2023-09-18T23:32:30.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
2478
|
+
expires_at_to: "2018-01-22T23:46:25.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
2479
|
+
direction: "desc" # 有効期限によるソート順序
|
|
2443
2480
|
))
|
|
2444
2481
|
```
|
|
2445
2482
|
|
|
@@ -2513,11 +2550,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
|
2513
2550
|
```ruby
|
|
2514
2551
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
2515
2552
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2516
|
-
page:
|
|
2517
|
-
per_page:
|
|
2518
|
-
expires_at_from: "
|
|
2519
|
-
expires_at_to: "
|
|
2520
|
-
direction: "
|
|
2553
|
+
page: 2562, # ページ番号
|
|
2554
|
+
per_page: 2350, # 1ページ分の取引数
|
|
2555
|
+
expires_at_from: "2022-11-07T23:53:28.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
2556
|
+
expires_at_to: "2024-03-02T12:53:21.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
2557
|
+
direction: "asc" # 有効期限によるソート順序
|
|
2521
2558
|
))
|
|
2522
2559
|
```
|
|
2523
2560
|
|
|
@@ -2591,9 +2628,9 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
2591
2628
|
```ruby
|
|
2592
2629
|
response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
2593
2630
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2594
|
-
status: "
|
|
2595
|
-
account_name: "
|
|
2596
|
-
external_id: "
|
|
2631
|
+
status: "suspended", # ウォレット状態
|
|
2632
|
+
account_name: "2ThdFR4ZGmC3lYSdkRdIHlBo7iMGslQeLzTg9FCP6boJkANEWZ0xko5rtXdkjCZ6KXkiMx1kHTVbpRx79qoFTViWGk7rsKgu2ihoMxDsfU3TC1A8fV5nkzyaMo6HNFjN16Mt1NNT0LSnWyLCIiaSmxOiabyCFBUZkKwMvzRhZdC9PIbxRIokrSMcAe6DLpfhwjho9qAj035em2B0e1zQxL4LWrEkUrKU", # アカウント名
|
|
2633
|
+
external_id: "ADYaUMS4V1", # 外部ID
|
|
2597
2634
|
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
|
2598
2635
|
))
|
|
2599
2636
|
```
|
|
@@ -2673,15 +2710,15 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
|
2673
2710
|
```ruby
|
|
2674
2711
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
2675
2712
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2676
|
-
page:
|
|
2677
|
-
per_page:
|
|
2678
|
-
created_at_from: "
|
|
2679
|
-
created_at_to: "
|
|
2713
|
+
page: 4060, # ページ番号
|
|
2714
|
+
per_page: 2564, # 1ページ分のウォレット数
|
|
2715
|
+
created_at_from: "2022-12-06T00:04:18.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
2716
|
+
created_at_to: "2018-02-12T04:05:18.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
2680
2717
|
is_suspended: true, # ウォレットが凍結状態かどうかでフィルターする
|
|
2681
|
-
status: "
|
|
2682
|
-
external_id: "
|
|
2683
|
-
tel: "
|
|
2684
|
-
email: "
|
|
2718
|
+
status: "active", # ウォレット状態
|
|
2719
|
+
external_id: "iuqOBINm4Q77ByqizVQoe2X9mQJiEELVlycfdA0sn1Jp9", # 外部ID
|
|
2720
|
+
tel: "09835724", # エンドユーザーの電話番号
|
|
2721
|
+
email: "Jofbfd8lI7@ca3o.com" # エンドユーザーのメールアドレス
|
|
2685
2722
|
))
|
|
2686
2723
|
```
|
|
2687
2724
|
|
|
@@ -2797,7 +2834,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
|
2797
2834
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2798
2835
|
user_name: "ポケペイ太郎", # ユーザー名
|
|
2799
2836
|
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
|
2800
|
-
external_id: "
|
|
2837
|
+
external_id: "QIsUl3rCM2ZMpE4WDo" # 外部ID
|
|
2801
2838
|
))
|
|
2802
2839
|
```
|
|
2803
2840
|
|
|
@@ -2851,11 +2888,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
|
|
|
2851
2888
|
```ruby
|
|
2852
2889
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
2853
2890
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2854
|
-
page:
|
|
2855
|
-
per_page:
|
|
2856
|
-
created_at_from: "
|
|
2857
|
-
created_at_to: "
|
|
2858
|
-
is_suspended:
|
|
2891
|
+
page: 6515, # ページ番号
|
|
2892
|
+
per_page: 2556, # 1ページ分のウォレット数
|
|
2893
|
+
created_at_from: "2024-03-23T00:01:00.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
2894
|
+
created_at_to: "2019-08-19T02:00:31.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
2895
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
|
2859
2896
|
))
|
|
2860
2897
|
```
|
|
2861
2898
|
|
|
@@ -2928,10 +2965,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
2928
2965
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2929
2966
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
2930
2967
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
2931
|
-
type: "
|
|
2932
|
-
is_modified:
|
|
2933
|
-
from: "
|
|
2934
|
-
to: "
|
|
2968
|
+
type: "cashback", # 取引種別
|
|
2969
|
+
is_modified: true, # キャンセル済みかどうか
|
|
2970
|
+
from: "2017-02-24T20:56:29.000000+09:00", # 開始日時
|
|
2971
|
+
to: "2020-11-21T02:48:12.000000+09:00", # 終了日時
|
|
2935
2972
|
page: 1, # ページ番号
|
|
2936
2973
|
per_page: 50 # 1ページ分の取引数
|
|
2937
2974
|
))
|
|
@@ -3067,11 +3104,12 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
3067
3104
|
organization_code: "pocketchange", # 組織コード
|
|
3068
3105
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
3069
3106
|
name: "oxスーパー三田店", # 店舗名
|
|
3070
|
-
postal_code: "
|
|
3107
|
+
postal_code: "0308543", # 店舗の郵便番号
|
|
3071
3108
|
address: "東京都港区芝...", # 店舗の住所
|
|
3072
|
-
tel: "
|
|
3073
|
-
email: "
|
|
3074
|
-
external_id: "
|
|
3109
|
+
tel: "02552956-860", # 店舗の電話番号
|
|
3110
|
+
email: "vobOclFXKf@vdQi.com", # 店舗のメールアドレス
|
|
3111
|
+
external_id: "3hjtD1VYnThEQOLtlkRPIAe", # 店舗の外部ID
|
|
3112
|
+
with_disabled: false, # 無効な店舗を含める
|
|
3075
3113
|
page: 1, # ページ番号
|
|
3076
3114
|
per_page: 50 # 1ページ分の取引数
|
|
3077
3115
|
))
|
|
@@ -3168,6 +3206,14 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
3168
3206
|
このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
|
|
3169
3207
|
|
|
3170
3208
|
|
|
3209
|
+
---
|
|
3210
|
+
`with_disabled`
|
|
3211
|
+
```json
|
|
3212
|
+
{ "type": "boolean" }
|
|
3213
|
+
```
|
|
3214
|
+
このパラメータを渡すと無効にされた店舗を含めて返されます。デフォルトでは無効にされた店舗は返されません。
|
|
3215
|
+
|
|
3216
|
+
|
|
3171
3217
|
---
|
|
3172
3218
|
`page`
|
|
3173
3219
|
```json
|
|
@@ -3196,11 +3242,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
3196
3242
|
```ruby
|
|
3197
3243
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
3198
3244
|
"oxスーパー三田店", # shop_name: 店舗名
|
|
3199
|
-
shop_postal_code: "
|
|
3245
|
+
shop_postal_code: "681-1231", # 店舗の郵便番号
|
|
3200
3246
|
shop_address: "東京都港区芝...", # 店舗の住所
|
|
3201
|
-
shop_tel: "
|
|
3202
|
-
shop_email: "
|
|
3203
|
-
shop_external_id: "
|
|
3247
|
+
shop_tel: "0973740877", # 店舗の電話番号
|
|
3248
|
+
shop_email: "zgZ3SAsjpA@uPQw.com", # 店舗のメールアドレス
|
|
3249
|
+
shop_external_id: "MExC1w6ifl9ZUstq", # 店舗の外部ID
|
|
3204
3250
|
organization_code: "ox-supermarket" # 組織コード
|
|
3205
3251
|
))
|
|
3206
3252
|
```
|
|
@@ -3210,13 +3256,13 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
|
3210
3256
|
```ruby
|
|
3211
3257
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
3212
3258
|
"oxスーパー三田店", # name: 店舗名
|
|
3213
|
-
postal_code: "
|
|
3259
|
+
postal_code: "7381888", # 店舗の郵便番号
|
|
3214
3260
|
address: "東京都港区芝...", # 店舗の住所
|
|
3215
|
-
tel: "
|
|
3216
|
-
email: "
|
|
3217
|
-
external_id: "
|
|
3261
|
+
tel: "040-70-5582", # 店舗の電話番号
|
|
3262
|
+
email: "si7WktomTS@Is3s.com", # 店舗のメールアドレス
|
|
3263
|
+
external_id: "ss0bSZ1", # 店舗の外部ID
|
|
3218
3264
|
organization_code: "ox-supermarket", # 組織コード
|
|
3219
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
3265
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
3220
3266
|
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
3221
3267
|
))
|
|
3222
3268
|
```
|
|
@@ -3288,13 +3334,14 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
|
3288
3334
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
3289
3335
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
3290
3336
|
name: "oxスーパー三田店", # 店舗名
|
|
3291
|
-
postal_code: "
|
|
3337
|
+
postal_code: "027-2404", # 店舗の郵便番号
|
|
3292
3338
|
address: "東京都港区芝...", # 店舗の住所
|
|
3293
|
-
tel: "
|
|
3294
|
-
email: "
|
|
3295
|
-
external_id: "
|
|
3296
|
-
private_money_ids: [
|
|
3297
|
-
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
3339
|
+
tel: "076478-442", # 店舗の電話番号
|
|
3340
|
+
email: "2et6R89vRe@hYIZ.com", # 店舗のメールアドレス
|
|
3341
|
+
external_id: "Mh6MfShA8D4Ev7O7TGT70LQ2epxhXvfJrqw", # 店舗の外部ID
|
|
3342
|
+
private_money_ids: [], # 店舗で有効にするマネーIDの配列
|
|
3343
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗でチャージ可能にするマネーIDの配列
|
|
3344
|
+
status: "active" # 店舗の状態
|
|
3298
3345
|
))
|
|
3299
3346
|
```
|
|
3300
3347
|
|
|
@@ -3386,6 +3433,16 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
|
3386
3433
|
このパラメータは発行体のみが指定でき、発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
|
|
3387
3434
|
省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
|
|
3388
3435
|
|
|
3436
|
+
---
|
|
3437
|
+
`status`
|
|
3438
|
+
```json
|
|
3439
|
+
{
|
|
3440
|
+
"type": "string",
|
|
3441
|
+
"enum": { "active": "disabled" }
|
|
3442
|
+
}
|
|
3443
|
+
```
|
|
3444
|
+
店舗の状態です。activeを指定すると有効となり、disabledを指定するとリスト表示から除外されます。
|
|
3445
|
+
|
|
3389
3446
|
---
|
|
3390
3447
|
成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
|
|
3391
3448
|
### Account
|
|
@@ -3395,8 +3452,8 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
|
3395
3452
|
```ruby
|
|
3396
3453
|
response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
3397
3454
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
|
3398
|
-
page:
|
|
3399
|
-
per_page:
|
|
3455
|
+
page: 9606, # ページ番号
|
|
3456
|
+
per_page: 3576 # 1ページ分の取引数
|
|
3400
3457
|
))
|
|
3401
3458
|
```
|
|
3402
3459
|
|
|
@@ -3441,8 +3498,8 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
|
3441
3498
|
response = $client.send(Pokepay::Request::CreateUserAccount.new(
|
|
3442
3499
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
|
3443
3500
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3444
|
-
name: "
|
|
3445
|
-
external_id: "
|
|
3501
|
+
name: "zvGv5tXB9341AdQSvr2jD2CPBEg6qDXhSH8hafJy0sDT", # ウォレット名
|
|
3502
|
+
external_id: "MPtA7T3E2nC8JZcqIcqZB2nkhw5Vunnh29qWQZz14xB891r", # 外部ID
|
|
3446
3503
|
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
|
3447
3504
|
))
|
|
3448
3505
|
```
|
|
@@ -3517,8 +3574,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
|
3517
3574
|
```ruby
|
|
3518
3575
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
3519
3576
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3520
|
-
from: "
|
|
3521
|
-
to: "
|
|
3577
|
+
from: "2017-06-06T02:42:58.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
3578
|
+
to: "2025-02-19T19:53:50.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
3522
3579
|
page: 1, # ページ番号
|
|
3523
3580
|
per_page: 50 # 1ページ分の取引数
|
|
3524
3581
|
))
|
|
@@ -3531,8 +3588,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
3531
3588
|
```ruby
|
|
3532
3589
|
response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
3533
3590
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3534
|
-
from: "
|
|
3535
|
-
to: "
|
|
3591
|
+
from: "2022-06-20T16:52:59.000000+09:00", # 開始日時
|
|
3592
|
+
to: "2022-07-13T23:00:57.000000+09:00" # 終了日時
|
|
3536
3593
|
))
|
|
3537
3594
|
```
|
|
3538
3595
|
成功したときは[PrivateMoneySummary](#private-money-summary)オブジェクトを返します
|
|
@@ -3542,10 +3599,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
|
3542
3599
|
CSVファイルから一括取引をします。
|
|
3543
3600
|
```ruby
|
|
3544
3601
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
3545
|
-
"
|
|
3546
|
-
"
|
|
3547
|
-
"
|
|
3548
|
-
description: "
|
|
3602
|
+
"eB61v", # name: 一括取引タスク名
|
|
3603
|
+
"OZ1u", # content: 取引する情報のCSV
|
|
3604
|
+
"NBAdr6lfzbfqKlnsG40wZo0RT90mTv9imeNi", # request_id: リクエストID
|
|
3605
|
+
description: "Y62Bc0n5yxxXvKDa0c2v5NvERR1ovUoSMxuwois", # 一括取引の説明
|
|
3549
3606
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # マネーID
|
|
3550
3607
|
))
|
|
3551
3608
|
```
|
|
@@ -3633,7 +3690,7 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
|
3633
3690
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
3634
3691
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
3635
3692
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3636
|
-
|
|
3693
|
+
3852, # amount: 取引額
|
|
3637
3694
|
description: "たい焼き(小倉)", # 取引説明文
|
|
3638
3695
|
metadata: "{\"key\":\"value\"}", # ポケペイ外部取引メタデータ
|
|
3639
3696
|
products: [{"jan_code":"abc",
|
|
@@ -3646,11 +3703,6 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
|
3646
3703
|
"unit_price":100,
|
|
3647
3704
|
"price": 100,
|
|
3648
3705
|
"is_discounted": false,
|
|
3649
|
-
"other":"{}"}, {"jan_code":"abc",
|
|
3650
|
-
"name":"name1",
|
|
3651
|
-
"unit_price":100,
|
|
3652
|
-
"price": 100,
|
|
3653
|
-
"is_discounted": false,
|
|
3654
3706
|
"other":"{}"}], # 商品情報データ
|
|
3655
3707
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
3656
3708
|
))
|
|
@@ -3782,18 +3834,18 @@ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
|
|
|
3782
3834
|
|
|
3783
3835
|
```ruby
|
|
3784
3836
|
response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3785
|
-
"
|
|
3837
|
+
"hKOtAoX7opuae7lO58Ae6hTnrFSjbB1hiRjTNSU46DKPvyktKcWCyKm4tG2FzeWXxPN6RiMVhZmmGj0TMjPFLM0DLdwVX1nfPZtzGunVJbtCnsdFVcjFxpkr7nBijaa4uqZKlbp", # name: キャンペーン名
|
|
3786
3838
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3787
|
-
"
|
|
3788
|
-
"
|
|
3789
|
-
|
|
3839
|
+
"2023-09-24T23:26:18.000000+09:00", # starts_at: キャンペーン開始日時
|
|
3840
|
+
"2016-02-09T03:13:42.000000+09:00", # ends_at: キャンペーン終了日時
|
|
3841
|
+
4660, # priority: キャンペーンの適用優先度
|
|
3790
3842
|
"external-transaction", # event: イベント種別
|
|
3791
3843
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント負担先店舗ID
|
|
3792
|
-
description: "
|
|
3793
|
-
status: "
|
|
3794
|
-
point_expires_at: "
|
|
3795
|
-
point_expires_in_days:
|
|
3796
|
-
is_exclusive:
|
|
3844
|
+
description: "mZQDB6u1kMJt8otXLMwi", # キャンペーンの説明文
|
|
3845
|
+
status: "disabled", # キャンペーン作成時の状態
|
|
3846
|
+
point_expires_at: "2019-02-11T15:46:26.000000+09:00", # ポイント有効期限(絶対日時指定)
|
|
3847
|
+
point_expires_in_days: 4640, # ポイント有効期限(相対日数指定)
|
|
3848
|
+
is_exclusive: false, # キャンペーンの重複設定
|
|
3797
3849
|
subject: "all", # ポイント付与の対象金額の種別
|
|
3798
3850
|
amount_based_point_rules: [{
|
|
3799
3851
|
"point_amount": 5,
|
|
@@ -3808,22 +3860,16 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
|
3808
3860
|
"is_multiply_by_count": true,
|
|
3809
3861
|
"required_count": 2
|
|
3810
3862
|
}], # 商品情報ベースのポイント付与ルール
|
|
3811
|
-
applicable_days_of_week: [
|
|
3863
|
+
applicable_days_of_week: [1], # キャンペーンを適用する曜日 (複数指定)
|
|
3812
3864
|
applicable_time_ranges: [{
|
|
3813
3865
|
"from": "12:00",
|
|
3814
3866
|
"to": "23:59"
|
|
3815
|
-
}, {
|
|
3816
|
-
"from": "12:00",
|
|
3817
|
-
"to": "23:59"
|
|
3818
|
-
}, {
|
|
3819
|
-
"from": "12:00",
|
|
3820
|
-
"to": "23:59"
|
|
3821
3867
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
|
3822
|
-
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3823
|
-
minimum_number_for_combination_purchase:
|
|
3824
|
-
exist_in_each_product_groups:
|
|
3825
|
-
max_point_amount:
|
|
3826
|
-
max_total_point_amount:
|
|
3868
|
+
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3869
|
+
minimum_number_for_combination_purchase: 5375, # 複数種類の商品を同時購入するときの商品種別数の下限
|
|
3870
|
+
exist_in_each_product_groups: true, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
|
3871
|
+
max_point_amount: 2714, # キャンペーンによって付与されるポイントの上限
|
|
3872
|
+
max_total_point_amount: 9297, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
|
3827
3873
|
dest_private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント付与先となるマネーID
|
|
3828
3874
|
applicable_account_metadata: {
|
|
3829
3875
|
"key": "sex",
|
|
@@ -4332,8 +4378,10 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
4332
4378
|
response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
4333
4379
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
4334
4380
|
is_ongoing: true, # 現在適用可能なキャンペーンかどうか
|
|
4381
|
+
available_from: "2021-03-31T02:38:44.000000+09:00", # 指定された日時以降に適用可能期間が含まれているか
|
|
4382
|
+
available_to: "2023-01-18T05:57:01.000000+09:00", # 指定された日時以前に適用可能期間が含まれているか
|
|
4335
4383
|
page: 1, # ページ番号
|
|
4336
|
-
per_page:
|
|
4384
|
+
per_page: 20 # 1ページ分の取得数
|
|
4337
4385
|
))
|
|
4338
4386
|
```
|
|
4339
4387
|
|
|
@@ -4358,6 +4406,28 @@ response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
|
4358
4406
|
真であれば適用可能なもののみを抽出し、偽であれば適用不可なもののみを抽出します。
|
|
4359
4407
|
デフォルトでは未指定(フィルターなし)です。
|
|
4360
4408
|
|
|
4409
|
+
---
|
|
4410
|
+
`available_from`
|
|
4411
|
+
```json
|
|
4412
|
+
{
|
|
4413
|
+
"type": "string",
|
|
4414
|
+
"format": "date-time"
|
|
4415
|
+
}
|
|
4416
|
+
```
|
|
4417
|
+
キャンペーン終了日時が指定された日時以降であるキャンペーンをフィルターするために使われます。
|
|
4418
|
+
デフォルトでは未指定(フィルターなし)です。
|
|
4419
|
+
|
|
4420
|
+
---
|
|
4421
|
+
`available_to`
|
|
4422
|
+
```json
|
|
4423
|
+
{
|
|
4424
|
+
"type": "string",
|
|
4425
|
+
"format": "date-time"
|
|
4426
|
+
}
|
|
4427
|
+
```
|
|
4428
|
+
キャンペーン開始日時が指定された日時以前であるキャンペーンをフィルターするために使われます。
|
|
4429
|
+
デフォルトでは未指定(フィルターなし)です。
|
|
4430
|
+
|
|
4361
4431
|
---
|
|
4362
4432
|
`page`
|
|
4363
4433
|
```json
|
|
@@ -4373,7 +4443,8 @@ response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
|
4373
4443
|
```json
|
|
4374
4444
|
{
|
|
4375
4445
|
"type": "integer",
|
|
4376
|
-
"minimum": 1
|
|
4446
|
+
"minimum": 1,
|
|
4447
|
+
"maximum": 50
|
|
4377
4448
|
}
|
|
4378
4449
|
```
|
|
4379
4450
|
1ページ分の取得数です。デフォルトでは 20 になっています。
|
|
@@ -4412,43 +4483,41 @@ response = $client.send(Pokepay::Request::GetCampaign.new(
|
|
|
4412
4483
|
```ruby
|
|
4413
4484
|
response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4414
4485
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # campaign_id: キャンペーンID
|
|
4415
|
-
name: "
|
|
4416
|
-
starts_at: "
|
|
4417
|
-
ends_at: "
|
|
4418
|
-
priority:
|
|
4419
|
-
event: "
|
|
4420
|
-
description: "
|
|
4486
|
+
name: "nkI2cpiZrwht02dhTsSxNXBuhLAxPxLgPF7PH9jsPo3qRbXC06hH5q5N6rSqlhclxbbI1pwNVNkX1wbtHq7h4XHkBbxR0RnLtirGJS2N5S6EEO5Bp0TaBrmndiCNxXXwjFaRAeTxfe0YQCHzm8OG8zcqkOxIGcWZjj", # キャンペーン名
|
|
4487
|
+
starts_at: "2024-09-30T20:45:09.000000+09:00", # キャンペーン開始日時
|
|
4488
|
+
ends_at: "2017-09-06T00:16:21.000000+09:00", # キャンペーン終了日時
|
|
4489
|
+
priority: 5093, # キャンペーンの適用優先度
|
|
4490
|
+
event: "external-transaction", # イベント種別
|
|
4491
|
+
description: "dDcpZu9iiEwcokneeQ36NR2IjhyB4vKQ7cGlo7SrCjimdlgwn9qvauQ2kDhj5HLJcSNTCm30yK3y8WItCe9VYgMydEalG76", # キャンペーンの説明文
|
|
4421
4492
|
status: "enabled", # キャンペーン作成時の状態
|
|
4422
|
-
point_expires_at: "
|
|
4423
|
-
point_expires_in_days:
|
|
4424
|
-
is_exclusive:
|
|
4425
|
-
subject: "
|
|
4493
|
+
point_expires_at: "2016-02-28T10:07:16.000000+09:00", # ポイント有効期限(絶対日時指定)
|
|
4494
|
+
point_expires_in_days: 2261, # ポイント有効期限(相対日数指定)
|
|
4495
|
+
is_exclusive: false, # キャンペーンの重複設定
|
|
4496
|
+
subject: "money", # ポイント付与の対象金額の種別
|
|
4426
4497
|
amount_based_point_rules: [{
|
|
4427
4498
|
"point_amount": 5,
|
|
4428
4499
|
"point_amount_unit": "percent",
|
|
4429
4500
|
"subject_more_than_or_equal": 1000,
|
|
4430
4501
|
"subject_less_than": 5000
|
|
4431
|
-
}
|
|
4432
|
-
product_based_point_rules: [{
|
|
4502
|
+
}, {
|
|
4433
4503
|
"point_amount": 5,
|
|
4434
4504
|
"point_amount_unit": "percent",
|
|
4435
|
-
"
|
|
4436
|
-
"
|
|
4437
|
-
"required_count": 2
|
|
4505
|
+
"subject_more_than_or_equal": 1000,
|
|
4506
|
+
"subject_less_than": 5000
|
|
4438
4507
|
}, {
|
|
4439
4508
|
"point_amount": 5,
|
|
4440
4509
|
"point_amount_unit": "percent",
|
|
4441
|
-
"
|
|
4442
|
-
"
|
|
4443
|
-
|
|
4444
|
-
|
|
4510
|
+
"subject_more_than_or_equal": 1000,
|
|
4511
|
+
"subject_less_than": 5000
|
|
4512
|
+
}], # 取引金額ベースのポイント付与ルール
|
|
4513
|
+
product_based_point_rules: [{
|
|
4445
4514
|
"point_amount": 5,
|
|
4446
4515
|
"point_amount_unit": "percent",
|
|
4447
4516
|
"product_code": "4912345678904",
|
|
4448
4517
|
"is_multiply_by_count": true,
|
|
4449
4518
|
"required_count": 2
|
|
4450
4519
|
}], # 商品情報ベースのポイント付与ルール
|
|
4451
|
-
applicable_days_of_week: [
|
|
4520
|
+
applicable_days_of_week: [3, 5, 1], # キャンペーンを適用する曜日 (複数指定)
|
|
4452
4521
|
applicable_time_ranges: [{
|
|
4453
4522
|
"from": "12:00",
|
|
4454
4523
|
"to": "23:59"
|
|
@@ -4459,11 +4528,11 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
|
4459
4528
|
"from": "12:00",
|
|
4460
4529
|
"to": "23:59"
|
|
4461
4530
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
|
4462
|
-
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
4463
|
-
minimum_number_for_combination_purchase:
|
|
4531
|
+
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
4532
|
+
minimum_number_for_combination_purchase: 3146, # 複数種類の商品を同時購入するときの商品種別数の下限
|
|
4464
4533
|
exist_in_each_product_groups: false, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
|
4465
|
-
max_point_amount:
|
|
4466
|
-
max_total_point_amount:
|
|
4534
|
+
max_point_amount: 261, # キャンペーンによって付与されるポイントの上限
|
|
4535
|
+
max_total_point_amount: 8788, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
|
4467
4536
|
applicable_account_metadata: {
|
|
4468
4537
|
"key": "sex",
|
|
4469
4538
|
"value": "male"
|
|
@@ -4692,7 +4761,7 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4692
4761
|
// 対象商品を2つ以上購入したら500ポイント付与(固定額付与)
|
|
4693
4762
|
{
|
|
4694
4763
|
"point_amount": 500,
|
|
4695
|
-
"point_amount_unit": absolute",
|
|
4764
|
+
"point_amount_unit": "absolute",
|
|
4696
4765
|
"product_code": "4912345678904",
|
|
4697
4766
|
"required_count": 2
|
|
4698
4767
|
},
|
|
@@ -4935,6 +5004,251 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
4935
5004
|
|
|
4936
5005
|
---
|
|
4937
5006
|
成功したときは[Campaign](#campaign)オブジェクトを返します
|
|
5007
|
+
### Webhook
|
|
5008
|
+
Webhookは特定のワーカータスクでの処理が完了した事を通知します。
|
|
5009
|
+
WebHookにはURLとタスク名、有効化されているかを設定することが出来ます。
|
|
5010
|
+
通知はタスク完了時、事前に設定したURLにPOSTリクエストを行います。
|
|
5011
|
+
|
|
5012
|
+
<a name="create-webhook"></a>
|
|
5013
|
+
#### webhookの作成
|
|
5014
|
+
ワーカータスクの処理が終了したことを通知するためのWebhookを登録します
|
|
5015
|
+
このAPIにより指定したタスクの終了時に、指定したURLにPOSTリクエストを送信します。
|
|
5016
|
+
このとき、リクエストボディは `{"task": <タスク名>}` という値になります。
|
|
5017
|
+
```ruby
|
|
5018
|
+
response = $client.send(Pokepay::Request::CreateWebhook.new(
|
|
5019
|
+
"process_user_stats_operation", # task: タスク名
|
|
5020
|
+
"gi" # url: URL
|
|
5021
|
+
))
|
|
5022
|
+
```
|
|
5023
|
+
|
|
5024
|
+
---
|
|
5025
|
+
`task`
|
|
5026
|
+
```json
|
|
5027
|
+
{
|
|
5028
|
+
"type": "string",
|
|
5029
|
+
"enum": { "bulk_shops": "process_user_stats_operation" }
|
|
5030
|
+
}
|
|
5031
|
+
```
|
|
5032
|
+
ワーカータスク名を指定します
|
|
5033
|
+
|
|
5034
|
+
---
|
|
5035
|
+
`url`
|
|
5036
|
+
```json
|
|
5037
|
+
{ "type": "string" }
|
|
5038
|
+
```
|
|
5039
|
+
通知先のURLを指定します
|
|
5040
|
+
|
|
5041
|
+
---
|
|
5042
|
+
成功したときは[OrganizationWorkerTaskWebhook](#organization-worker-task-webhook)オブジェクトを返します
|
|
5043
|
+
<a name="list-webhooks"></a>
|
|
5044
|
+
#### 作成したWebhookの一覧を返す
|
|
5045
|
+
```ruby
|
|
5046
|
+
response = $client.send(Pokepay::Request::ListWebhooks.new(
|
|
5047
|
+
page: 1, # ページ番号
|
|
5048
|
+
per_page: 50 # 1ページ分の取得数
|
|
5049
|
+
))
|
|
5050
|
+
```
|
|
5051
|
+
|
|
5052
|
+
---
|
|
5053
|
+
`page`
|
|
5054
|
+
```json
|
|
5055
|
+
{
|
|
5056
|
+
"type": "integer",
|
|
5057
|
+
"minimum": 1
|
|
5058
|
+
}
|
|
5059
|
+
```
|
|
5060
|
+
取得したいページ番号です。
|
|
5061
|
+
|
|
5062
|
+
---
|
|
5063
|
+
`per_page`
|
|
5064
|
+
```json
|
|
5065
|
+
{
|
|
5066
|
+
"type": "integer",
|
|
5067
|
+
"minimum": 1
|
|
5068
|
+
}
|
|
5069
|
+
```
|
|
5070
|
+
1ページ分の取得数です。デフォルトでは 50 になっています。
|
|
5071
|
+
|
|
5072
|
+
---
|
|
5073
|
+
成功したときは[PaginatedOrganizationWorkerTaskWebhook](#paginated-organization-worker-task-webhook)オブジェクトを返します
|
|
5074
|
+
<a name="update-webhook"></a>
|
|
5075
|
+
#### Webhookの更新
|
|
5076
|
+
指定したWebhookの内容を更新します
|
|
5077
|
+
```ruby
|
|
5078
|
+
response = $client.send(Pokepay::Request::UpdateWebhook.new(
|
|
5079
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # webhook_id: Webhook ID
|
|
5080
|
+
url: "jWRyxneekV", # URL
|
|
5081
|
+
is_active: true, # 有効/無効
|
|
5082
|
+
task: "bulk_shops" # タスク名
|
|
5083
|
+
))
|
|
5084
|
+
```
|
|
5085
|
+
|
|
5086
|
+
---
|
|
5087
|
+
`webhook_id`
|
|
5088
|
+
```json
|
|
5089
|
+
{
|
|
5090
|
+
"type": "string",
|
|
5091
|
+
"format": "uuid"
|
|
5092
|
+
}
|
|
5093
|
+
```
|
|
5094
|
+
更新するWebhookのIDです。
|
|
5095
|
+
|
|
5096
|
+
---
|
|
5097
|
+
`url`
|
|
5098
|
+
```json
|
|
5099
|
+
{ "type": "string" }
|
|
5100
|
+
```
|
|
5101
|
+
変更するURLを指定します
|
|
5102
|
+
|
|
5103
|
+
---
|
|
5104
|
+
`is_active`
|
|
5105
|
+
```json
|
|
5106
|
+
{ "type": "boolean" }
|
|
5107
|
+
```
|
|
5108
|
+
trueならWebhookによる通知が有効になり、falseなら無効になります
|
|
5109
|
+
|
|
5110
|
+
---
|
|
5111
|
+
`task`
|
|
5112
|
+
```json
|
|
5113
|
+
{
|
|
5114
|
+
"type": "string",
|
|
5115
|
+
"enum": { "bulk_shops": "process_user_stats_operation" }
|
|
5116
|
+
}
|
|
5117
|
+
```
|
|
5118
|
+
指定したタスクが終了したときにWebhookによる通知がされます
|
|
5119
|
+
|
|
5120
|
+
---
|
|
5121
|
+
成功したときは[OrganizationWorkerTaskWebhook](#organization-worker-task-webhook)オブジェクトを返します
|
|
5122
|
+
### Coupon
|
|
5123
|
+
<a name="list-coupons"></a>
|
|
5124
|
+
#### クーポン一覧の取得
|
|
5125
|
+
指定したマネーのクーポン一覧を取得します
|
|
5126
|
+
```ruby
|
|
5127
|
+
response = $client.send(Pokepay::Request::ListCoupons.new(
|
|
5128
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 対象クーポンのマネーID
|
|
5129
|
+
coupon_id: "cIDT0hnm8", # クーポンID
|
|
5130
|
+
coupon_name: "8evW68NKp", # クーポン名
|
|
5131
|
+
issued_shop_name: "dkq0PM", # 発行店舗名
|
|
5132
|
+
available_shop_name: "o6iR", # 利用可能店舗名
|
|
5133
|
+
available_from: "2022-04-09T19:30:01.000000+09:00", # 利用可能期間 (開始日時)
|
|
5134
|
+
available_to: "2024-04-07T13:25:13.000000+09:00", # 利用可能期間 (終了日時)
|
|
5135
|
+
page: 1, # ページ番号
|
|
5136
|
+
per_page: 50 # 1ページ分の取得数
|
|
5137
|
+
))
|
|
5138
|
+
```
|
|
5139
|
+
|
|
5140
|
+
---
|
|
5141
|
+
`private_money_id`
|
|
5142
|
+
```json
|
|
5143
|
+
{
|
|
5144
|
+
"type": "string",
|
|
5145
|
+
"format": "uuid"
|
|
5146
|
+
}
|
|
5147
|
+
```
|
|
5148
|
+
対象クーポンのマネーIDです(必須項目)。
|
|
5149
|
+
存在しないマネーIDを指定した場合はprivate_money_not_foundエラー(422)が返ります。
|
|
5150
|
+
|
|
5151
|
+
|
|
5152
|
+
---
|
|
5153
|
+
`coupon_id`
|
|
5154
|
+
```json
|
|
5155
|
+
{ "type": "string" }
|
|
5156
|
+
```
|
|
5157
|
+
指定されたクーポンIDで結果をフィルターします。
|
|
5158
|
+
部分一致(前方一致)します。
|
|
5159
|
+
|
|
5160
|
+
|
|
5161
|
+
---
|
|
5162
|
+
`coupon_name`
|
|
5163
|
+
```json
|
|
5164
|
+
{ "type": "string" }
|
|
5165
|
+
```
|
|
5166
|
+
指定されたクーポン名で結果をフィルターします。
|
|
5167
|
+
|
|
5168
|
+
|
|
5169
|
+
---
|
|
5170
|
+
`issued_shop_name`
|
|
5171
|
+
```json
|
|
5172
|
+
{ "type": "string" }
|
|
5173
|
+
```
|
|
5174
|
+
指定された発行店舗で結果をフィルターします。
|
|
5175
|
+
|
|
5176
|
+
|
|
5177
|
+
---
|
|
5178
|
+
`available_shop_name`
|
|
5179
|
+
```json
|
|
5180
|
+
{ "type": "string" }
|
|
5181
|
+
```
|
|
5182
|
+
指定された利用可能店舗で結果をフィルターします。
|
|
5183
|
+
|
|
5184
|
+
|
|
5185
|
+
---
|
|
5186
|
+
`available_from`
|
|
5187
|
+
```json
|
|
5188
|
+
{
|
|
5189
|
+
"type": "string",
|
|
5190
|
+
"format": "date-time"
|
|
5191
|
+
}
|
|
5192
|
+
```
|
|
5193
|
+
利用可能期間でフィルターします。フィルターの開始日時をISO8601形式で指定します。
|
|
5194
|
+
|
|
5195
|
+
|
|
5196
|
+
---
|
|
5197
|
+
`available_to`
|
|
5198
|
+
```json
|
|
5199
|
+
{
|
|
5200
|
+
"type": "string",
|
|
5201
|
+
"format": "date-time"
|
|
5202
|
+
}
|
|
5203
|
+
```
|
|
5204
|
+
利用可能期間でフィルターします。フィルターの終了日時をISO8601形式で指定します。
|
|
5205
|
+
|
|
5206
|
+
|
|
5207
|
+
---
|
|
5208
|
+
`page`
|
|
5209
|
+
```json
|
|
5210
|
+
{
|
|
5211
|
+
"type": "integer",
|
|
5212
|
+
"minimum": 1
|
|
5213
|
+
}
|
|
5214
|
+
```
|
|
5215
|
+
取得したいページ番号です。
|
|
5216
|
+
|
|
5217
|
+
---
|
|
5218
|
+
`per_page`
|
|
5219
|
+
```json
|
|
5220
|
+
{
|
|
5221
|
+
"type": "integer",
|
|
5222
|
+
"minimum": 1
|
|
5223
|
+
}
|
|
5224
|
+
```
|
|
5225
|
+
1ページ分の取得数です。デフォルトでは 50 になっています。
|
|
5226
|
+
|
|
5227
|
+
---
|
|
5228
|
+
成功したときは[PaginatedCoupons](#paginated-coupons)オブジェクトを返します
|
|
5229
|
+
<a name="get-coupon"></a>
|
|
5230
|
+
#### クーポンの取得
|
|
5231
|
+
指定したIDを持つクーポンを取得します
|
|
5232
|
+
```ruby
|
|
5233
|
+
response = $client.send(Pokepay::Request::GetCoupon.new(
|
|
5234
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # coupon_id: クーポンID
|
|
5235
|
+
))
|
|
5236
|
+
```
|
|
5237
|
+
|
|
5238
|
+
---
|
|
5239
|
+
`coupon-id`
|
|
5240
|
+
```json
|
|
5241
|
+
{
|
|
5242
|
+
"type": "string",
|
|
5243
|
+
"format": "uuid"
|
|
5244
|
+
}
|
|
5245
|
+
```
|
|
5246
|
+
取得するクーポンのIDです。
|
|
5247
|
+
UUIDv4フォーマットである必要があり、フォーマットが異なる場合は InvalidParametersエラー(400)が返ります。
|
|
5248
|
+
指定したIDのクーポンが存在しない場合はCouponNotFoundエラー(422)が返ります。
|
|
5249
|
+
|
|
5250
|
+
---
|
|
5251
|
+
成功したときは[CouponDetail](#coupon-detail)オブジェクトを返します
|
|
4938
5252
|
## Responses
|
|
4939
5253
|
|
|
4940
5254
|
|
|
@@ -5063,15 +5377,17 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5063
5377
|
<a name="transaction-detail"></a>
|
|
5064
5378
|
## TransactionDetail
|
|
5065
5379
|
* `id (string)`: 取引ID
|
|
5066
|
-
* `type (string)`: 取引種別
|
|
5380
|
+
* `type (string)`: 取引種別
|
|
5067
5381
|
* `is_modified (boolean)`: 返金された取引かどうか
|
|
5068
5382
|
* `sender (User)`: 送金者情報
|
|
5069
5383
|
* `sender_account (Account)`: 送金ウォレット情報
|
|
5070
5384
|
* `receiver (User)`: 受取者情報
|
|
5071
5385
|
* `receiver_account (Account)`: 受取ウォレット情報
|
|
5072
|
-
* `amount (double)`:
|
|
5073
|
-
* `money_amount (double)`:
|
|
5074
|
-
* `point_amount (double)`:
|
|
5386
|
+
* `amount (double)`: 取引総額 (マネー額 + ポイント額)
|
|
5387
|
+
* `money_amount (double)`: 取引マネー額
|
|
5388
|
+
* `point_amount (double)`: 取引ポイント額(キャンペーン付与ポイント合算)
|
|
5389
|
+
* `raw_point_amount (double)`: 取引ポイント額
|
|
5390
|
+
* `campaign_point_amount (double)`: キャンペーンによるポイント付与額
|
|
5075
5391
|
* `done_at (string)`: 取引日時
|
|
5076
5392
|
* `description (string)`: 取引説明文
|
|
5077
5393
|
* `transfers (array of Transfers)`:
|
|
@@ -5087,6 +5403,7 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5087
5403
|
* `id (string)`: 店舗ID
|
|
5088
5404
|
* `name (string)`: 店舗名
|
|
5089
5405
|
* `organization_code (string)`: 組織コード
|
|
5406
|
+
* `status (string)`: 店舗の状態
|
|
5090
5407
|
* `postal_code (string)`: 店舗の郵便番号
|
|
5091
5408
|
* `address (string)`: 店舗の住所
|
|
5092
5409
|
* `tel (string)`: 店舗の電話番号
|
|
@@ -5299,6 +5616,66 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5299
5616
|
|
|
5300
5617
|
`summaries`は [AccountTransferSummaryElement](#account-transfer-summary-element) オブジェクトの配列を返します。
|
|
5301
5618
|
|
|
5619
|
+
<a name="organization-worker-task-webhook"></a>
|
|
5620
|
+
## OrganizationWorkerTaskWebhook
|
|
5621
|
+
* `id (string)`:
|
|
5622
|
+
* `organization_code (string)`:
|
|
5623
|
+
* `task (string)`:
|
|
5624
|
+
* `url (string)`:
|
|
5625
|
+
* `content_type (string)`:
|
|
5626
|
+
* `is_active (boolean)`:
|
|
5627
|
+
|
|
5628
|
+
<a name="paginated-organization-worker-task-webhook"></a>
|
|
5629
|
+
## PaginatedOrganizationWorkerTaskWebhook
|
|
5630
|
+
* `rows (array of OrganizationWorkerTaskWebhooks)`:
|
|
5631
|
+
* `count (integer)`:
|
|
5632
|
+
* `pagination (Pagination)`:
|
|
5633
|
+
|
|
5634
|
+
`rows`は [OrganizationWorkerTaskWebhook](#organization-worker-task-webhook) オブジェクトの配列を返します。
|
|
5635
|
+
|
|
5636
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
5637
|
+
|
|
5638
|
+
<a name="coupon-detail"></a>
|
|
5639
|
+
## CouponDetail
|
|
5640
|
+
* `id (string)`: クーポンID
|
|
5641
|
+
* `name (string)`: クーポン名
|
|
5642
|
+
* `issued_shop (User)`: クーポン発行店舗
|
|
5643
|
+
* `description (string)`: クーポンの説明文
|
|
5644
|
+
* `discount_amount (integer)`: クーポンによる値引き額(絶対値指定)
|
|
5645
|
+
* `discount_percentage (double)`: クーポンによる値引き率
|
|
5646
|
+
* `discount_upper_limit (integer)`: クーポンによる値引き上限(値引き率が指定された場合の値引き上限額)
|
|
5647
|
+
* `starts_at (string)`: クーポンの利用可能期間(開始日時)
|
|
5648
|
+
* `ends_at (string)`: クーポンの利用可能期間(終了日時)
|
|
5649
|
+
* `display_starts_at (string)`: クーポンの掲載期間(開始日時)
|
|
5650
|
+
* `display_ends_at (string)`: クーポンの掲載期間(終了日時)
|
|
5651
|
+
* `usage_limit (integer)`: ユーザごとの利用可能回数(NULLの場合は無制限)
|
|
5652
|
+
* `min_amount (integer)`: クーポン適用可能な最小取引額
|
|
5653
|
+
* `is_shop_specified (boolean)`: 特定店舗限定のクーポンかどうか
|
|
5654
|
+
* `is_hidden (boolean)`: クーポン一覧に掲載されるかどうか
|
|
5655
|
+
* `is_public (boolean)`: アプリ配信なしで受け取れるかどうか
|
|
5656
|
+
* `code (string)`: クーポン受け取りコード
|
|
5657
|
+
* `is_disabled (boolean)`: 無効化フラグ
|
|
5658
|
+
* `token (string)`: クーポンを特定するためのトークン
|
|
5659
|
+
* `coupon_image (string)`: クーポン画像のURL
|
|
5660
|
+
* `available_shops (array of Users)`: 利用可能店舗リスト
|
|
5661
|
+
* `private_money (PrivateMoney)`: クーポンのマネー
|
|
5662
|
+
|
|
5663
|
+
`issued_shop`は [User](#user) オブジェクトを返します。
|
|
5664
|
+
|
|
5665
|
+
`available-shops`は [User](#user) オブジェクトの配列を返します。
|
|
5666
|
+
|
|
5667
|
+
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
5668
|
+
|
|
5669
|
+
<a name="paginated-coupons"></a>
|
|
5670
|
+
## PaginatedCoupons
|
|
5671
|
+
* `rows (array of Coupons)`:
|
|
5672
|
+
* `count (integer)`:
|
|
5673
|
+
* `pagination (Pagination)`:
|
|
5674
|
+
|
|
5675
|
+
`rows`は [Coupon](#coupon) オブジェクトの配列を返します。
|
|
5676
|
+
|
|
5677
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
5678
|
+
|
|
5302
5679
|
<a name="private-money"></a>
|
|
5303
5680
|
## PrivateMoney
|
|
5304
5681
|
* `id (string)`: マネーID
|
|
@@ -5310,9 +5687,10 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5310
5687
|
* `organization (Organization)`: マネーを発行した組織
|
|
5311
5688
|
* `max_balance (double)`: ウォレットの上限金額
|
|
5312
5689
|
* `transfer_limit (double)`: マネーの取引上限額
|
|
5690
|
+
* `money_topup_transfer_limit (double)`: マネーチャージ取引上限額
|
|
5313
5691
|
* `type (string)`: マネー種別 (自家型=own, 第三者型=third-party)
|
|
5314
5692
|
* `expiration_type (string)`: 有効期限種別 (チャージ日起算=static, 最終利用日起算=last-update, 最終チャージ日起算=last-topup-update)
|
|
5315
|
-
* `enable_topup_by_member (boolean)`:
|
|
5693
|
+
* `enable_topup_by_member (boolean)`: (deprecated)
|
|
5316
5694
|
* `display_money_and_point (string)`:
|
|
5317
5695
|
|
|
5318
5696
|
`organization`は [Organization](#organization) オブジェクトを返します。
|
|
@@ -5320,15 +5698,17 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5320
5698
|
<a name="transaction"></a>
|
|
5321
5699
|
## Transaction
|
|
5322
5700
|
* `id (string)`: 取引ID
|
|
5323
|
-
* `type (string)`: 取引種別
|
|
5701
|
+
* `type (string)`: 取引種別
|
|
5324
5702
|
* `is_modified (boolean)`: 返金された取引かどうか
|
|
5325
5703
|
* `sender (User)`: 送金者情報
|
|
5326
5704
|
* `sender_account (Account)`: 送金ウォレット情報
|
|
5327
5705
|
* `receiver (User)`: 受取者情報
|
|
5328
5706
|
* `receiver_account (Account)`: 受取ウォレット情報
|
|
5329
|
-
* `amount (double)`:
|
|
5330
|
-
* `money_amount (double)`:
|
|
5331
|
-
* `point_amount (double)`:
|
|
5707
|
+
* `amount (double)`: 取引総額 (マネー額 + ポイント額)
|
|
5708
|
+
* `money_amount (double)`: 取引マネー額
|
|
5709
|
+
* `point_amount (double)`: 取引ポイント額(キャンペーン付与ポイント合算)
|
|
5710
|
+
* `raw_point_amount (double)`: 取引ポイント額
|
|
5711
|
+
* `campaign_point_amount (double)`: キャンペーンによるポイント付与額
|
|
5332
5712
|
* `done_at (string)`: 取引日時
|
|
5333
5713
|
* `description (string)`: 取引説明文
|
|
5334
5714
|
|
|
@@ -5408,6 +5788,7 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5408
5788
|
* `id (string)`: 店舗ID
|
|
5409
5789
|
* `name (string)`: 店舗名
|
|
5410
5790
|
* `organization_code (string)`: 組織コード
|
|
5791
|
+
* `status (string)`: 店舗の状態
|
|
5411
5792
|
* `postal_code (string)`: 店舗の郵便番号
|
|
5412
5793
|
* `address (string)`: 店舗の住所
|
|
5413
5794
|
* `tel (string)`: 店舗の電話番号
|
|
@@ -5421,6 +5802,30 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
|
5421
5802
|
* `point_amount (double)`:
|
|
5422
5803
|
* `count (double)`:
|
|
5423
5804
|
|
|
5805
|
+
<a name="coupon"></a>
|
|
5806
|
+
## Coupon
|
|
5807
|
+
* `id (string)`: クーポンID
|
|
5808
|
+
* `name (string)`: クーポン名
|
|
5809
|
+
* `issued_shop (User)`: クーポン発行店舗
|
|
5810
|
+
* `description (string)`: クーポンの説明文
|
|
5811
|
+
* `discount_amount (integer)`: クーポンによる値引き額(絶対値指定)
|
|
5812
|
+
* `discount_percentage (double)`: クーポンによる値引き率
|
|
5813
|
+
* `discount_upper_limit (integer)`: クーポンによる値引き上限(値引き率が指定された場合の値引き上限額)
|
|
5814
|
+
* `starts_at (string)`: クーポンの利用可能期間(開始日時)
|
|
5815
|
+
* `ends_at (string)`: クーポンの利用可能期間(終了日時)
|
|
5816
|
+
* `display_starts_at (string)`: クーポンの掲載期間(開始日時)
|
|
5817
|
+
* `display_ends_at (string)`: クーポンの掲載期間(終了日時)
|
|
5818
|
+
* `usage_limit (integer)`: ユーザごとの利用可能回数(NULLの場合は無制限)
|
|
5819
|
+
* `min_amount (integer)`: クーポン適用可能な最小取引額
|
|
5820
|
+
* `is_shop_specified (boolean)`: 特定店舗限定のクーポンかどうか
|
|
5821
|
+
* `is_hidden (boolean)`: クーポン一覧に掲載されるかどうか
|
|
5822
|
+
* `is_public (boolean)`: アプリ配信なしで受け取れるかどうか
|
|
5823
|
+
* `code (string)`: クーポン受け取りコード
|
|
5824
|
+
* `is_disabled (boolean)`: 無効化フラグ
|
|
5825
|
+
* `token (string)`: クーポンを特定するためのトークン
|
|
5826
|
+
|
|
5827
|
+
`issued_shop`は [User](#user) オブジェクトを返します。
|
|
5828
|
+
|
|
5424
5829
|
<a name="organization"></a>
|
|
5425
5830
|
## Organization
|
|
5426
5831
|
* `code (string)`: 組織コード
|