pokepay_partner_ruby_sdk 0.3.0 → 0.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/index.md +184 -170
- data/lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb +5 -5
- data/lib/pokepay_partner_ruby_sdk/request/list_bulk_transaction_jobs.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +1 -1
- data/partner.yaml +22 -2
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f26e03a901d1f2b27ba9d9bd69ce04d70a8337634e5c371077786453d42b3508
|
4
|
+
data.tar.gz: d8e3b97be078f1f6f4b920d39cc5002916ca4f936a9deefc7404464acf9dbc23
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5612fa4d08ba9dbab0209818aa5d7fb460dde8a869db517dd45a1fa498165c8c992c53efad891fdfa6dd772008eb52ac86c15d324b05d5686d1f70937d2b6cb1
|
7
|
+
data.tar.gz: eff09ed02ff6de6bccc4bae8ff45dbf164fcc9f1a11217ef5a78c27d63aef485b32584d1ec1ffd242410be39d55d93df8cc6ca317af5b414c1d7e8f46ed232e8
|
data/Gemfile.lock
CHANGED
data/docs/index.md
CHANGED
@@ -214,7 +214,7 @@ response.body
|
|
214
214
|
CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
|
215
215
|
```ruby
|
216
216
|
response = $client.send(Pokepay::Request::GetCpmToken.new(
|
217
|
-
"
|
217
|
+
"uEOVKpPzDCyUBg3VaVg5lQ" # cpm_token: CPMトークン
|
218
218
|
))
|
219
219
|
```
|
220
220
|
|
@@ -236,18 +236,18 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
|
|
236
236
|
取引一覧を返します。
|
237
237
|
```ruby
|
238
238
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
239
|
-
from: "
|
240
|
-
to: "2017-
|
239
|
+
from: "2020-09-03T10:24:34.000000+09:00", # 開始日時
|
240
|
+
to: "2017-08-26T09:53:13.000000+09:00", # 終了日時
|
241
241
|
page: 1, # ページ番号
|
242
242
|
per_page: 50, # 1ページ分の取引数
|
243
243
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
244
244
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
245
245
|
customer_name: "太郎", # エンドユーザー名
|
246
246
|
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
247
|
-
transaction_id: "
|
247
|
+
transaction_id: "irhr", # 取引ID
|
248
248
|
organization_code: "pocketchange", # 組織コード
|
249
249
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
250
|
-
is_modified:
|
250
|
+
is_modified: true, # キャンセルフラグ
|
251
251
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
252
252
|
description: "店頭QRコードによる支払い" # 取引説明文
|
253
253
|
))
|
@@ -448,10 +448,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
448
448
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
449
449
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
450
450
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
451
|
-
money_amount:
|
452
|
-
point_amount:
|
453
|
-
point_expires_at: "
|
454
|
-
description: "
|
451
|
+
money_amount: 4512,
|
452
|
+
point_amount: 8509,
|
453
|
+
point_expires_at: "2018-10-18T14:03:35.000000+09:00", # ポイント有効期限
|
454
|
+
description: "bFTGr24vRn0V1KmKqNhpuD1AS4IxvpFPGaTF6gXtd3nJyyNe74Q2bvFtDokudzPS7PJ09whlF6CVlMKFHkTHEGRWUBVUZa1rmAxzFUF6ihvlI4uoOEnKraNjpsN9SjDxtxrgs7e0dkiAAa8jwX6FLCB1XlvzBazSCE1hEG2EkkP2VIPy7HW7Ee7skB9BB1YNClE"
|
455
455
|
))
|
456
456
|
```
|
457
457
|
|
@@ -480,11 +480,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
480
480
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
481
481
|
customer_name: "太郎", # エンドユーザー名
|
482
482
|
description: "店頭QRコードによる支払い", # 取引説明文
|
483
|
-
transaction_id: "
|
483
|
+
transaction_id: "n", # 取引ID
|
484
484
|
is_modified: false, # キャンセルフラグ
|
485
485
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
486
|
-
from: "
|
487
|
-
to: "
|
486
|
+
from: "2017-08-18T12:45:05.000000+09:00", # 開始日時
|
487
|
+
to: "2025-01-16T16:54:19.000000+09:00", # 終了日時
|
488
488
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransactionのID
|
489
489
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransactionのID
|
490
490
|
per_page: 50 # 1ページ分の取引数
|
@@ -713,9 +713,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
713
713
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
714
714
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
715
715
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
716
|
-
money_amount:
|
717
|
-
point_amount:
|
718
|
-
point_expires_at: "
|
716
|
+
money_amount: 6192, # マネー額
|
717
|
+
point_amount: 5644, # ポイント額
|
718
|
+
point_expires_at: "2024-01-05T01:07:10.000000+09:00", # ポイント有効期限
|
719
719
|
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
720
720
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
721
721
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
@@ -857,7 +857,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
857
857
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
858
858
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
859
859
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
860
|
-
|
860
|
+
8459, # amount: 支払い額
|
861
861
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
862
862
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
863
863
|
products: [{"jan_code":"abc",
|
@@ -865,6 +865,16 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
865
865
|
"unit_price":100,
|
866
866
|
"price": 100,
|
867
867
|
"is_discounted": false,
|
868
|
+
"other":"{}"}, {"jan_code":"abc",
|
869
|
+
"name":"name1",
|
870
|
+
"unit_price":100,
|
871
|
+
"price": 100,
|
872
|
+
"is_discounted": false,
|
873
|
+
"other":"{}"}, {"jan_code":"abc",
|
874
|
+
"name":"name1",
|
875
|
+
"unit_price":100,
|
876
|
+
"price": 100,
|
877
|
+
"is_discounted": false,
|
868
878
|
"other":"{}"}], # 商品情報データ
|
869
879
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
870
880
|
))
|
@@ -983,9 +993,9 @@ CPMトークンに設定されたスコープの取引を作ることができ
|
|
983
993
|
|
984
994
|
```ruby
|
985
995
|
response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
986
|
-
"
|
996
|
+
"spNWH9u8x4Yq2mxjIub5W9", # cpm_token: CPMトークン
|
987
997
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
988
|
-
|
998
|
+
6756.0, # amount: 取引金額
|
989
999
|
description: "たい焼き(小倉)", # 取引説明文
|
990
1000
|
metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
|
991
1001
|
products: [{"jan_code":"abc",
|
@@ -1105,7 +1115,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
1105
1115
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
1106
1116
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
1107
1117
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1108
|
-
|
1118
|
+
3508.0, # amount: 送金額
|
1109
1119
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
1110
1120
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
1111
1121
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
@@ -1207,8 +1217,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
1207
1217
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1208
1218
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1209
1219
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1210
|
-
|
1211
|
-
description: "
|
1220
|
+
4583.0,
|
1221
|
+
description: "79SnOHSfjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpX",
|
1212
1222
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
1213
1223
|
))
|
1214
1224
|
```
|
@@ -1265,7 +1275,7 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
1265
1275
|
response = $client.send(Pokepay::Request::RefundTransaction.new(
|
1266
1276
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
|
1267
1277
|
description: "返品対応のため", # 取引履歴に表示する返金事由
|
1268
|
-
returning_point_expires_at: "
|
1278
|
+
returning_point_expires_at: "2021-06-29T03:01:24.000000+09:00" # 返却ポイントの有効期限
|
1269
1279
|
))
|
1270
1280
|
```
|
1271
1281
|
|
@@ -1324,8 +1334,8 @@ CSVの作成は非同期で行われるため完了まで少しの間待つ必
|
|
1324
1334
|
また、指定期間より前の決済を時間をおいてキャンセルした場合などには payment_money_amount, payment_point_amount, payment_transaction_count が負の値になることもあることに留意してください。
|
1325
1335
|
```ruby
|
1326
1336
|
response = $client.send(Pokepay::Request::RequestUserStats.new(
|
1327
|
-
"2019-
|
1328
|
-
"
|
1337
|
+
"2019-07-26T21:37:35.000000+09:00", # from: 集計期間の開始時刻
|
1338
|
+
"2025-02-11T02:09:15.000000+09:00" # to: 集計期間の終了時刻
|
1329
1339
|
))
|
1330
1340
|
```
|
1331
1341
|
|
@@ -1360,8 +1370,8 @@ response = $client.send(Pokepay::Request::RequestUserStats.new(
|
|
1360
1370
|
```ruby
|
1361
1371
|
response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
1362
1372
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
1363
|
-
from: "
|
1364
|
-
to: "
|
1373
|
+
from: "2020-02-19T23:43:27.000000+09:00", # 集計期間の開始時刻
|
1374
|
+
to: "2016-06-13T17:11:34.000000+09:00", # 集計期間の終了時刻
|
1365
1375
|
transfer_types: ["topup", "payment"] # 取引明細種別 (複数指定可)
|
1366
1376
|
))
|
1367
1377
|
```
|
@@ -1430,19 +1440,19 @@ response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
|
1430
1440
|
####
|
1431
1441
|
```ruby
|
1432
1442
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
1433
|
-
from: "
|
1434
|
-
to: "
|
1435
|
-
page:
|
1436
|
-
per_page:
|
1443
|
+
from: "2018-10-07T20:22:59.000000+09:00",
|
1444
|
+
to: "2016-09-27T06:40:27.000000+09:00",
|
1445
|
+
page: 2674,
|
1446
|
+
per_page: 5578,
|
1437
1447
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1438
|
-
shop_name: "
|
1448
|
+
shop_name: "MOcjyqB",
|
1439
1449
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1440
|
-
customer_name: "
|
1450
|
+
customer_name: "KlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kY",
|
1441
1451
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1442
1452
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1443
|
-
is_modified:
|
1444
|
-
transaction_types: ["
|
1445
|
-
transfer_types: ["
|
1453
|
+
is_modified: true,
|
1454
|
+
transaction_types: ["payment", "exchange", "topup", "cashback", "expire", "transfer"],
|
1455
|
+
transfer_types: ["exchange", "coupon", "campaign", "payment", "topup", "transfer", "cashback", "expire"], # 取引明細の種類でフィルターします。
|
1446
1456
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
1447
1457
|
))
|
1448
1458
|
```
|
@@ -1507,20 +1517,20 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
1507
1517
|
```ruby
|
1508
1518
|
response = $client.send(Pokepay::Request::ListTransfersV2.new(
|
1509
1519
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
1510
|
-
shop_name: "
|
1520
|
+
shop_name: "nZBUv4F8J7UzyDYEv7bctcmIqdmvTV8RBzp0gixsKZWoUeORL98QDv9TW3tonru5DxxR1kiR4daTST401zYU9O5bmxo5R8HDeIrg38UDixRQOsOxJyiut30oRsSLi4FAWjvNFlMGhO7Mj", # 店舗名
|
1511
1521
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
1512
|
-
customer_name: "
|
1522
|
+
customer_name: "oFiHLtN9Yqy", # エンドユーザー名
|
1513
1523
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
|
1514
1524
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1515
1525
|
is_modified: false, # キャンセルフラグ
|
1516
|
-
transaction_types: ["
|
1526
|
+
transaction_types: ["topup", "exchange", "cashback", "transfer", "expire", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
1517
1527
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransferのID
|
1518
1528
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransferのID
|
1519
1529
|
per_page: 50, # 1ページ分の取引数
|
1520
|
-
transfer_types: ["
|
1530
|
+
transfer_types: ["campaign", "payment", "topup"], # 取引明細種別 (複数指定可)
|
1521
1531
|
description: "店頭QRコードによる支払い", # 取引詳細説明文
|
1522
|
-
from: "
|
1523
|
-
to: "
|
1532
|
+
from: "2024-01-14T18:07:53.000000+09:00", # 開始日時
|
1533
|
+
to: "2020-10-01T04:15:53.000000+09:00" # 終了日時
|
1524
1534
|
))
|
1525
1535
|
```
|
1526
1536
|
|
@@ -1782,13 +1792,13 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
|
|
1782
1792
|
```ruby
|
1783
1793
|
response = $client.send(Pokepay::Request::CreateCheck.new(
|
1784
1794
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
|
1785
|
-
money_amount:
|
1786
|
-
point_amount:
|
1795
|
+
money_amount: 3053.0, # 付与マネー額
|
1796
|
+
point_amount: 6429.0, # 付与ポイント額
|
1787
1797
|
description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
|
1788
1798
|
is_onetime: true, # ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
|
1789
|
-
usage_limit:
|
1790
|
-
expires_at: "
|
1791
|
-
point_expires_at: "
|
1799
|
+
usage_limit: 2663, # ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
|
1800
|
+
expires_at: "2018-06-03T00:56:42.000000+09:00", # チャージQR自体の失効日時
|
1801
|
+
point_expires_at: "2024-01-10T07:28:49.000000+09:00", # チャージQRによって付与されるポイントの失効日時
|
1792
1802
|
point_expires_in_days: 60, # チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
|
1793
1803
|
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗アカウントのID
|
1794
1804
|
))
|
@@ -1863,19 +1873,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
1863
1873
|
支払いQRコード一覧を表示します。
|
1864
1874
|
```ruby
|
1865
1875
|
response = $client.send(Pokepay::Request::ListBills.new(
|
1866
|
-
page:
|
1867
|
-
per_page:
|
1868
|
-
bill_id: "
|
1876
|
+
page: 3244, # ページ番号
|
1877
|
+
per_page: 4145, # 1ページの表示数
|
1878
|
+
bill_id: "IdNSbIr", # 支払いQRコードのID
|
1869
1879
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1870
|
-
organization_code: "
|
1880
|
+
organization_code: "-MIe--67l72U--B--Tx-0--L", # 組織コード
|
1871
1881
|
description: "test bill", # 取引説明文
|
1872
|
-
created_from: "
|
1873
|
-
created_to: "
|
1882
|
+
created_from: "2017-03-06T05:22:10.000000+09:00", # 作成日時(起点)
|
1883
|
+
created_to: "2020-09-11T05:26:23.000000+09:00", # 作成日時(終点)
|
1874
1884
|
shop_name: "bill test shop1", # 店舗名
|
1875
1885
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
1876
|
-
lower_limit_amount:
|
1877
|
-
upper_limit_amount:
|
1878
|
-
is_disabled:
|
1886
|
+
lower_limit_amount: 4641, # 金額の範囲によるフィルタ(下限)
|
1887
|
+
upper_limit_amount: 6221, # 金額の範囲によるフィルタ(上限)
|
1888
|
+
is_disabled: false # 支払いQRコードが無効化されているかどうか
|
1879
1889
|
))
|
1880
1890
|
```
|
1881
1891
|
|
@@ -2019,7 +2029,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
2019
2029
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
2020
2030
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
2021
2031
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
2022
|
-
amount:
|
2032
|
+
amount: 1634.0, # 支払い額
|
2023
2033
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
2024
2034
|
))
|
2025
2035
|
```
|
@@ -2043,7 +2053,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
2043
2053
|
```ruby
|
2044
2054
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
2045
2055
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
2046
|
-
amount:
|
2056
|
+
amount: 1886.0, # 支払い額
|
2047
2057
|
description: "test bill", # 説明文
|
2048
2058
|
is_disabled: true # 無効化されているかどうか
|
2049
2059
|
))
|
@@ -2108,9 +2118,9 @@ Cashtrayを作成します。
|
|
2108
2118
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
2109
2119
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2110
2120
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
2111
|
-
|
2121
|
+
2307.0, # amount: 金額
|
2112
2122
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
2113
|
-
expires_in:
|
2123
|
+
expires_in: 8664 # 失効時間(秒)
|
2114
2124
|
))
|
2115
2125
|
```
|
2116
2126
|
|
@@ -2271,9 +2281,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
2271
2281
|
```ruby
|
2272
2282
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
2273
2283
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
2274
|
-
amount:
|
2284
|
+
amount: 2956.0, # 金額
|
2275
2285
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
2276
|
-
expires_in:
|
2286
|
+
expires_in: 5971 # 失効時間(秒)
|
2277
2287
|
))
|
2278
2288
|
```
|
2279
2289
|
|
@@ -2354,8 +2364,8 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
2354
2364
|
```ruby
|
2355
2365
|
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
2356
2366
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2357
|
-
is_suspended:
|
2358
|
-
status: "
|
2367
|
+
is_suspended: true, # ウォレットが凍結されているかどうか
|
2368
|
+
status: "suspended", # ウォレット状態
|
2359
2369
|
can_transfer_topup: false # チャージ可能かどうか
|
2360
2370
|
))
|
2361
2371
|
```
|
@@ -2404,7 +2414,7 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
2404
2414
|
```ruby
|
2405
2415
|
response = $client.send(Pokepay::Request::DeleteAccount.new(
|
2406
2416
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2407
|
-
cashback:
|
2417
|
+
cashback: true # 返金有無
|
2408
2418
|
))
|
2409
2419
|
```
|
2410
2420
|
|
@@ -2435,10 +2445,10 @@ response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
2435
2445
|
```ruby
|
2436
2446
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
2437
2447
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2438
|
-
page:
|
2439
|
-
per_page:
|
2440
|
-
expires_at_from: "
|
2441
|
-
expires_at_to: "
|
2448
|
+
page: 3815, # ページ番号
|
2449
|
+
per_page: 4657, # 1ページ分の取引数
|
2450
|
+
expires_at_from: "2022-08-09T03:31:40.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
2451
|
+
expires_at_to: "2016-12-21T20:17:39.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
2442
2452
|
direction: "asc" # 有効期限によるソート順序
|
2443
2453
|
))
|
2444
2454
|
```
|
@@ -2513,11 +2523,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
2513
2523
|
```ruby
|
2514
2524
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
2515
2525
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2516
|
-
page:
|
2517
|
-
per_page:
|
2518
|
-
expires_at_from: "2018-
|
2519
|
-
expires_at_to: "
|
2520
|
-
direction: "
|
2526
|
+
page: 6026, # ページ番号
|
2527
|
+
per_page: 497, # 1ページ分の取引数
|
2528
|
+
expires_at_from: "2018-05-14T10:59:48.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
2529
|
+
expires_at_to: "2018-05-29T03:13:18.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
2530
|
+
direction: "asc" # 有効期限によるソート順序
|
2521
2531
|
))
|
2522
2532
|
```
|
2523
2533
|
|
@@ -2592,8 +2602,8 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
2592
2602
|
response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
2593
2603
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2594
2604
|
status: "active", # ウォレット状態
|
2595
|
-
account_name: "
|
2596
|
-
external_id: "
|
2605
|
+
account_name: "g7fbzWuGj28bjzoMkUfQZyG6ql9kvIc3ugQfVcwKEOAlMUYblAnOJUw5uYgLUj2LWIHcZ5Kh7Upt9fM2ThdFR4ZGmC3lYSdkRdIHlBo7iMGslQeLzTg9FCP6boJkANEWZ0xko5rtXdkjCZ6KXkiMx1kHTV", # アカウント名
|
2606
|
+
external_id: "bpRx79q", # 外部ID
|
2597
2607
|
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
2598
2608
|
))
|
2599
2609
|
```
|
@@ -2673,15 +2683,15 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
2673
2683
|
```ruby
|
2674
2684
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
2675
2685
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2676
|
-
page:
|
2677
|
-
per_page:
|
2678
|
-
created_at_from: "
|
2679
|
-
created_at_to: "
|
2686
|
+
page: 6128, # ページ番号
|
2687
|
+
per_page: 8066, # 1ページ分のウォレット数
|
2688
|
+
created_at_from: "2023-01-19T13:14:54.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
2689
|
+
created_at_to: "2023-05-11T02:19:35.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
2680
2690
|
is_suspended: true, # ウォレットが凍結状態かどうかでフィルターする
|
2681
|
-
status: "
|
2682
|
-
external_id: "
|
2683
|
-
tel: "
|
2684
|
-
email: "
|
2691
|
+
status: "pre-closed", # ウォレット状態
|
2692
|
+
external_id: "WGk7rsKgu2ihoMxDsfU3TC1A8fV5nkzyaMo6HNFjN1", # 外部ID
|
2693
|
+
tel: "0417-8464796", # エンドユーザーの電話番号
|
2694
|
+
email: "SnWyLCIiaS@mxOi.com" # エンドユーザーのメールアドレス
|
2685
2695
|
))
|
2686
2696
|
```
|
2687
2697
|
|
@@ -2797,7 +2807,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
2797
2807
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2798
2808
|
user_name: "ポケペイ太郎", # ユーザー名
|
2799
2809
|
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
2800
|
-
external_id: "
|
2810
|
+
external_id: "byCFBUZkKwMvzRhZdC9PIbxRIokrSMcAe6" # 外部ID
|
2801
2811
|
))
|
2802
2812
|
```
|
2803
2813
|
|
@@ -2851,11 +2861,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
|
|
2851
2861
|
```ruby
|
2852
2862
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
2853
2863
|
"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:
|
2864
|
+
page: 8389, # ページ番号
|
2865
|
+
per_page: 7136, # 1ページ分のウォレット数
|
2866
|
+
created_at_from: "2020-05-15T00:42:37.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
2867
|
+
created_at_to: "2022-01-29T11:47:00.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
2868
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
2859
2869
|
))
|
2860
2870
|
```
|
2861
2871
|
|
@@ -2928,10 +2938,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
2928
2938
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2929
2939
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
2930
2940
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
2931
|
-
type: "
|
2941
|
+
type: "topup", # 取引種別
|
2932
2942
|
is_modified: false, # キャンセル済みかどうか
|
2933
|
-
from: "
|
2934
|
-
to: "
|
2943
|
+
from: "2017-09-16T11:42:09.000000+09:00", # 開始日時
|
2944
|
+
to: "2024-11-26T13:09:59.000000+09:00", # 終了日時
|
2935
2945
|
page: 1, # ページ番号
|
2936
2946
|
per_page: 50 # 1ページ分の取引数
|
2937
2947
|
))
|
@@ -3067,11 +3077,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
3067
3077
|
organization_code: "pocketchange", # 組織コード
|
3068
3078
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
3069
3079
|
name: "oxスーパー三田店", # 店舗名
|
3070
|
-
postal_code: "
|
3080
|
+
postal_code: "668-9111", # 店舗の郵便番号
|
3071
3081
|
address: "東京都港区芝...", # 店舗の住所
|
3072
|
-
tel: "
|
3073
|
-
email: "
|
3074
|
-
external_id: "
|
3082
|
+
tel: "033-1276205", # 店舗の電話番号
|
3083
|
+
email: "1zQxL4LWrE@kUrK.com", # 店舗のメールアドレス
|
3084
|
+
external_id: "UADYaUMS4V1xY0z6q9RliuqOBINm4Q", # 店舗の外部ID
|
3075
3085
|
page: 1, # ページ番号
|
3076
3086
|
per_page: 50 # 1ページ分の取引数
|
3077
3087
|
))
|
@@ -3196,11 +3206,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
3196
3206
|
```ruby
|
3197
3207
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
3198
3208
|
"oxスーパー三田店", # shop_name: 店舗名
|
3199
|
-
shop_postal_code: "
|
3209
|
+
shop_postal_code: "277-2891", # 店舗の郵便番号
|
3200
3210
|
shop_address: "東京都港区芝...", # 店舗の住所
|
3201
|
-
shop_tel: "
|
3202
|
-
shop_email: "
|
3203
|
-
shop_external_id: "
|
3211
|
+
shop_tel: "066-675620", # 店舗の電話番号
|
3212
|
+
shop_email: "X9mQJiEELV@lycf.com", # 店舗のメールアドレス
|
3213
|
+
shop_external_id: "dA0sn1Jp9ctBvXrxjspmUg2Jofbf", # 店舗の外部ID
|
3204
3214
|
organization_code: "ox-supermarket" # 組織コード
|
3205
3215
|
))
|
3206
3216
|
```
|
@@ -3210,14 +3220,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
3210
3220
|
```ruby
|
3211
3221
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
3212
3222
|
"oxスーパー三田店", # name: 店舗名
|
3213
|
-
postal_code: "
|
3223
|
+
postal_code: "4589973", # 店舗の郵便番号
|
3214
3224
|
address: "東京都港区芝...", # 店舗の住所
|
3215
|
-
tel: "
|
3216
|
-
email: "
|
3217
|
-
external_id: "
|
3225
|
+
tel: "091-3023234", # 店舗の電話番号
|
3226
|
+
email: "2ZMpE4WDor@4IAD.com", # 店舗のメールアドレス
|
3227
|
+
external_id: "HdTPsjhUsWbuhnbIUFlfv", # 店舗の外部ID
|
3218
3228
|
organization_code: "ox-supermarket", # 組織コード
|
3219
3229
|
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
3220
|
-
can_topup_private_money_ids: [
|
3230
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
3221
3231
|
))
|
3222
3232
|
```
|
3223
3233
|
|
@@ -3288,12 +3298,12 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
3288
3298
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
3289
3299
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
3290
3300
|
name: "oxスーパー三田店", # 店舗名
|
3291
|
-
postal_code: "
|
3301
|
+
postal_code: "0436866", # 店舗の郵便番号
|
3292
3302
|
address: "東京都港区芝...", # 店舗の住所
|
3293
|
-
tel: "
|
3294
|
-
email: "
|
3295
|
-
external_id: "
|
3296
|
-
private_money_ids: [
|
3303
|
+
tel: "041-363-142", # 店舗の電話番号
|
3304
|
+
email: "D1VYnThEQO@Ltlk.com", # 店舗のメールアドレス
|
3305
|
+
external_id: "RPIAeI3C1kLwoSJ0t0xwzgZ3SAsjpAu", # 店舗の外部ID
|
3306
|
+
private_money_ids: [], # 店舗で有効にするマネーIDの配列
|
3297
3307
|
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
3298
3308
|
))
|
3299
3309
|
```
|
@@ -3395,8 +3405,8 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
3395
3405
|
```ruby
|
3396
3406
|
response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
3397
3407
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
3398
|
-
page:
|
3399
|
-
per_page:
|
3408
|
+
page: 7634, # ページ番号
|
3409
|
+
per_page: 5240 # 1ページ分の取引数
|
3400
3410
|
))
|
3401
3411
|
```
|
3402
3412
|
|
@@ -3441,8 +3451,8 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
3441
3451
|
response = $client.send(Pokepay::Request::CreateUserAccount.new(
|
3442
3452
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
3443
3453
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3444
|
-
name: "
|
3445
|
-
external_id: "
|
3454
|
+
name: "MExC1w6ifl9ZUstqj7jJ1Xazd0M0QE8si7WktomTSIs3sss0bSZ1cR5rMDg0iBD2et6R89vRehYIZbMh6MfShA8D4Ev7O7TGT70LQ2epxhXvfJrqwCwzvGv5tXB9341AdQSvr2jD2CPBEg6qDXhSH8hafJy0sDTnMPtA7T3E2nC8JZcqIcqZB2nkhw5Vunnh29qWQZz14xB891rP", # ウォレット名
|
3455
|
+
external_id: "V7FcdDeB61vcOZ1uNBAdr6lfzbfqKlnsG", # 外部ID
|
3446
3456
|
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
3447
3457
|
))
|
3448
3458
|
```
|
@@ -3517,8 +3527,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
3517
3527
|
```ruby
|
3518
3528
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
3519
3529
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3520
|
-
from: "
|
3521
|
-
to: "
|
3530
|
+
from: "2018-10-18T14:12:36.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
3531
|
+
to: "2024-08-31T11:34:14.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
3522
3532
|
page: 1, # ページ番号
|
3523
3533
|
per_page: 50 # 1ページ分の取引数
|
3524
3534
|
))
|
@@ -3531,8 +3541,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
3531
3541
|
```ruby
|
3532
3542
|
response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
3533
3543
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3534
|
-
from: "
|
3535
|
-
to: "
|
3544
|
+
from: "2024-07-16T14:28:27.000000+09:00", # 開始日時
|
3545
|
+
to: "2020-09-28T12:35:03.000000+09:00" # 終了日時
|
3536
3546
|
))
|
3537
3547
|
```
|
3538
3548
|
成功したときは[PrivateMoneySummary](#private-money-summary)オブジェクトを返します
|
@@ -3542,10 +3552,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
3542
3552
|
CSVファイルから一括取引をします。
|
3543
3553
|
```ruby
|
3544
3554
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
3545
|
-
"
|
3546
|
-
"
|
3547
|
-
"
|
3548
|
-
description: "
|
3555
|
+
"RT90mTv9imeNiY62B", # name: 一括取引タスク名
|
3556
|
+
"0n5y", # content: 取引する情報のCSV
|
3557
|
+
"xxXvKDa0c2v5NvERR1ovUoSMxuwois43hKOt", # request_id: リクエストID
|
3558
|
+
description: "AoX7opuae", # 一括取引の説明
|
3549
3559
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # マネーID
|
3550
3560
|
))
|
3551
3561
|
```
|
@@ -3633,7 +3643,7 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
3633
3643
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
3634
3644
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
3635
3645
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3636
|
-
|
3646
|
+
10000, # amount: 取引額
|
3637
3647
|
description: "たい焼き(小倉)", # 取引説明文
|
3638
3648
|
metadata: "{\"key\":\"value\"}", # ポケペイ外部取引メタデータ
|
3639
3649
|
products: [{"jan_code":"abc",
|
@@ -3782,24 +3792,29 @@ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
|
|
3782
3792
|
|
3783
3793
|
```ruby
|
3784
3794
|
response = $client.send(Pokepay::Request::CreateCampaign.new(
|
3785
|
-
"
|
3795
|
+
"8Ae6hTnrFSjbB1hiRjTNSU46DKPvyktKcWCyKm4tG2FzeWXxPN6RiMVhZmmGj0TMjPFLM0DLdwVX1nfPZtzGunVJbtCnsdFVcjFxpkr7nBijaa4uqZKlbpHQT4mZQDB6u1kMJt8otXLMwiqJK6MisPTXvJ9APWVf0nkI2cpiZrwht02dhTsSxN", # name: キャンペーン名
|
3786
3796
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3787
|
-
"
|
3788
|
-
"
|
3789
|
-
|
3797
|
+
"2025-08-02T21:20:39.000000+09:00", # starts_at: キャンペーン開始日時
|
3798
|
+
"2022-06-12T21:12:38.000000+09:00", # ends_at: キャンペーン終了日時
|
3799
|
+
1924, # priority: キャンペーンの適用優先度
|
3790
3800
|
"external-transaction", # event: イベント種別
|
3791
3801
|
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:
|
3802
|
+
description: "hLAxPxLgPF7PH9jsPo3qRbXC06hH5q5N6rSqlhclxbbI1pwNVNkX1wbtHq7h4XHkBbxR0RnLtirGJS2N5S6EEO5Bp0TaBrmndiCNxXXwjFaRAeTxfe0YQCHzm8OG8zcqkOxIGcWZjjM6j3edDcpZu9iiEwcokneeQ36NR2IjhyB4vKQ7cGlo7SrCjimdlgwn9", # キャンペーンの説明文
|
3803
|
+
status: "disabled", # キャンペーン作成時の状態
|
3804
|
+
point_expires_at: "2018-05-06T19:57:31.000000+09:00", # ポイント有効期限(絶対日時指定)
|
3805
|
+
point_expires_in_days: 2550, # ポイント有効期限(相対日数指定)
|
3806
|
+
is_exclusive: false, # キャンペーンの重複設定
|
3797
3807
|
subject: "all", # ポイント付与の対象金額の種別
|
3798
3808
|
amount_based_point_rules: [{
|
3799
3809
|
"point_amount": 5,
|
3800
3810
|
"point_amount_unit": "percent",
|
3801
3811
|
"subject_more_than_or_equal": 1000,
|
3802
3812
|
"subject_less_than": 5000
|
3813
|
+
}, {
|
3814
|
+
"point_amount": 5,
|
3815
|
+
"point_amount_unit": "percent",
|
3816
|
+
"subject_more_than_or_equal": 1000,
|
3817
|
+
"subject_less_than": 5000
|
3803
3818
|
}], # 取引金額ベースのポイント付与ルール
|
3804
3819
|
product_based_point_rules: [{
|
3805
3820
|
"point_amount": 5,
|
@@ -3807,23 +3822,29 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3807
3822
|
"product_code": "4912345678904",
|
3808
3823
|
"is_multiply_by_count": true,
|
3809
3824
|
"required_count": 2
|
3810
|
-
}], # 商品情報ベースのポイント付与ルール
|
3811
|
-
applicable_days_of_week: [5, 6], # キャンペーンを適用する曜日 (複数指定)
|
3812
|
-
applicable_time_ranges: [{
|
3813
|
-
"from": "12:00",
|
3814
|
-
"to": "23:59"
|
3815
3825
|
}, {
|
3816
|
-
"
|
3817
|
-
"
|
3826
|
+
"point_amount": 5,
|
3827
|
+
"point_amount_unit": "percent",
|
3828
|
+
"product_code": "4912345678904",
|
3829
|
+
"is_multiply_by_count": true,
|
3830
|
+
"required_count": 2
|
3818
3831
|
}, {
|
3832
|
+
"point_amount": 5,
|
3833
|
+
"point_amount_unit": "percent",
|
3834
|
+
"product_code": "4912345678904",
|
3835
|
+
"is_multiply_by_count": true,
|
3836
|
+
"required_count": 2
|
3837
|
+
}], # 商品情報ベースのポイント付与ルール
|
3838
|
+
applicable_days_of_week: [3, 0, 6], # キャンペーンを適用する曜日 (複数指定)
|
3839
|
+
applicable_time_ranges: [{
|
3819
3840
|
"from": "12:00",
|
3820
3841
|
"to": "23:59"
|
3821
3842
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
3822
3843
|
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:
|
3844
|
+
minimum_number_for_combination_purchase: 4750, # 複数種類の商品を同時購入するときの商品種別数の下限
|
3845
|
+
exist_in_each_product_groups: true, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
3846
|
+
max_point_amount: 713, # キャンペーンによって付与されるポイントの上限
|
3847
|
+
max_total_point_amount: 7524, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
3827
3848
|
dest_private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント付与先となるマネーID
|
3828
3849
|
applicable_account_metadata: {
|
3829
3850
|
"key": "sex",
|
@@ -4331,7 +4352,7 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
4331
4352
|
```ruby
|
4332
4353
|
response = $client.send(Pokepay::Request::ListCampaigns.new(
|
4333
4354
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
4334
|
-
is_ongoing:
|
4355
|
+
is_ongoing: false, # 現在適用可能なキャンペーンかどうか
|
4335
4356
|
page: 1, # ページ番号
|
4336
4357
|
per_page: 50 # 1ページ分の取得数
|
4337
4358
|
))
|
@@ -4412,30 +4433,29 @@ response = $client.send(Pokepay::Request::GetCampaign.new(
|
|
4412
4433
|
```ruby
|
4413
4434
|
response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
4414
4435
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # campaign_id: キャンペーンID
|
4415
|
-
name: "
|
4416
|
-
starts_at: "
|
4417
|
-
ends_at: "
|
4418
|
-
priority:
|
4419
|
-
event: "
|
4420
|
-
description: "
|
4436
|
+
name: "SNTCm30yK3y8WItCe9VYgMydEalG76qE4T1vOrKA4IwgS5AgijWRyxneekV8cIDT0hnm8h8evW68NKpdkq0PMSo6iR11TAHpgNTXOxFwqhkpZVaDhpFPp5bfKVt9DPYJAVzV6", # キャンペーン名
|
4437
|
+
starts_at: "2016-12-14T08:46:35.000000+09:00", # キャンペーン開始日時
|
4438
|
+
ends_at: "2024-01-23T12:45:50.000000+09:00", # キャンペーン終了日時
|
4439
|
+
priority: 6473, # キャンペーンの適用優先度
|
4440
|
+
event: "external-transaction", # イベント種別
|
4441
|
+
description: "6ywfpyKilj5zg8pn57kF0DYbPLXjuwrpeD0A9I", # キャンペーンの説明文
|
4421
4442
|
status: "enabled", # キャンペーン作成時の状態
|
4422
|
-
point_expires_at: "
|
4423
|
-
point_expires_in_days:
|
4424
|
-
is_exclusive:
|
4425
|
-
subject: "
|
4443
|
+
point_expires_at: "2022-09-02T08:10:56.000000+09:00", # ポイント有効期限(絶対日時指定)
|
4444
|
+
point_expires_in_days: 8245, # ポイント有効期限(相対日数指定)
|
4445
|
+
is_exclusive: false, # キャンペーンの重複設定
|
4446
|
+
subject: "money", # ポイント付与の対象金額の種別
|
4426
4447
|
amount_based_point_rules: [{
|
4427
4448
|
"point_amount": 5,
|
4428
4449
|
"point_amount_unit": "percent",
|
4429
4450
|
"subject_more_than_or_equal": 1000,
|
4430
4451
|
"subject_less_than": 5000
|
4431
|
-
}
|
4432
|
-
product_based_point_rules: [{
|
4452
|
+
}, {
|
4433
4453
|
"point_amount": 5,
|
4434
4454
|
"point_amount_unit": "percent",
|
4435
|
-
"
|
4436
|
-
"
|
4437
|
-
|
4438
|
-
|
4455
|
+
"subject_more_than_or_equal": 1000,
|
4456
|
+
"subject_less_than": 5000
|
4457
|
+
}], # 取引金額ベースのポイント付与ルール
|
4458
|
+
product_based_point_rules: [{
|
4439
4459
|
"point_amount": 5,
|
4440
4460
|
"point_amount_unit": "percent",
|
4441
4461
|
"product_code": "4912345678904",
|
@@ -4448,22 +4468,16 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4448
4468
|
"is_multiply_by_count": true,
|
4449
4469
|
"required_count": 2
|
4450
4470
|
}], # 商品情報ベースのポイント付与ルール
|
4451
|
-
applicable_days_of_week: [6],
|
4471
|
+
applicable_days_of_week: [6, 6], # キャンペーンを適用する曜日 (複数指定)
|
4452
4472
|
applicable_time_ranges: [{
|
4453
4473
|
"from": "12:00",
|
4454
4474
|
"to": "23:59"
|
4455
|
-
}, {
|
4456
|
-
"from": "12:00",
|
4457
|
-
"to": "23:59"
|
4458
|
-
}, {
|
4459
|
-
"from": "12:00",
|
4460
|
-
"to": "23:59"
|
4461
4475
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
4462
4476
|
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
4463
|
-
minimum_number_for_combination_purchase:
|
4477
|
+
minimum_number_for_combination_purchase: 3098, # 複数種類の商品を同時購入するときの商品種別数の下限
|
4464
4478
|
exist_in_each_product_groups: false, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
4465
|
-
max_point_amount:
|
4466
|
-
max_total_point_amount:
|
4479
|
+
max_point_amount: 3684, # キャンペーンによって付与されるポイントの上限
|
4480
|
+
max_total_point_amount: 1594, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
4467
4481
|
applicable_account_metadata: {
|
4468
4482
|
"key": "sex",
|
4469
4483
|
"value": "male"
|
@@ -1,14 +1,14 @@
|
|
1
1
|
# DO NOT EDIT: File is generated by code generator.
|
2
2
|
|
3
|
-
require "pokepay_partner_ruby_sdk/response/
|
3
|
+
require "pokepay_partner_ruby_sdk/response/bulk_transaction"
|
4
4
|
|
5
5
|
module Pokepay::Request
|
6
6
|
class GetBulkTransaction < Request
|
7
|
-
def initialize(bulk_transaction_id
|
8
|
-
@path = "/bulk-transactions" + "/" + bulk_transaction_id
|
7
|
+
def initialize(bulk_transaction_id)
|
8
|
+
@path = "/bulk-transactions" + "/" + bulk_transaction_id
|
9
9
|
@method = "GET"
|
10
|
-
@body_params = { }
|
11
|
-
@response_class = Pokepay::Response::
|
10
|
+
@body_params = { }
|
11
|
+
@response_class = Pokepay::Response::BulkTransaction
|
12
12
|
end
|
13
13
|
attr_reader :response_class
|
14
14
|
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
2
|
+
|
3
|
+
require "pokepay_partner_ruby_sdk/response/paginated_bulk_transaction_job"
|
4
|
+
|
5
|
+
module Pokepay::Request
|
6
|
+
class ListBulkTransactionJobs < Request
|
7
|
+
def initialize(bulk_transaction_id, rest_args = {})
|
8
|
+
@path = "/bulk-transactions" + "/" + bulk_transaction_id + "/jobs"
|
9
|
+
@method = "GET"
|
10
|
+
@body_params = { }.merge(rest_args)
|
11
|
+
@response_class = Pokepay::Response::PaginatedBulkTransactionJob
|
12
|
+
end
|
13
|
+
attr_reader :response_class
|
14
|
+
end
|
15
|
+
end
|
@@ -53,7 +53,7 @@ require "pokepay_partner_ruby_sdk/request/get_private_money_organization_summari
|
|
53
53
|
require "pokepay_partner_ruby_sdk/request/get_private_money_summary"
|
54
54
|
require "pokepay_partner_ruby_sdk/request/list_customer_transactions"
|
55
55
|
require "pokepay_partner_ruby_sdk/request/get_bulk_transaction"
|
56
|
-
require "pokepay_partner_ruby_sdk/request/
|
56
|
+
require "pokepay_partner_ruby_sdk/request/list_bulk_transaction_jobs"
|
57
57
|
require "pokepay_partner_ruby_sdk/request/create_cashtray"
|
58
58
|
require "pokepay_partner_ruby_sdk/request/get_cashtray"
|
59
59
|
require "pokepay_partner_ruby_sdk/request/cancel_cashtray"
|
data/partner.yaml
CHANGED
@@ -5041,7 +5041,7 @@ paths:
|
|
5041
5041
|
/bulk-transactions/{bulk_transaction_id}/jobs:
|
5042
5042
|
get:
|
5043
5043
|
summary: バルク取引ジョブの詳細情報一覧を取得する
|
5044
|
-
x-pokepay-operator-name: "
|
5044
|
+
x-pokepay-operator-name: "ListBulkTransactionJobs"
|
5045
5045
|
x-pokepay-allow-server-side: true
|
5046
5046
|
requestBody:
|
5047
5047
|
required: true
|
@@ -5597,7 +5597,17 @@ paths:
|
|
5597
5597
|
description: |-
|
5598
5598
|
対象の製品コード (JANコードやISBNコードなど) を指定します。(必須項目)
|
5599
5599
|
|
5600
|
-
SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (例: 978-% でISBNコード)
|
5600
|
+
SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
|
5601
|
+
items:
|
5602
|
+
type: string
|
5603
|
+
classification_code:
|
5604
|
+
type: string
|
5605
|
+
maxLength: 64
|
5606
|
+
title: '対象の商品分類コード'
|
5607
|
+
description: |-
|
5608
|
+
対象の商品分類コード (書籍のCコードなど) を指定します。(任意項目)
|
5609
|
+
|
5610
|
+
SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
|
5601
5611
|
items:
|
5602
5612
|
type: string
|
5603
5613
|
required_count:
|
@@ -6345,6 +6355,16 @@ paths:
|
|
6345
6355
|
SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (例: 978-% でISBNコード)
|
6346
6356
|
items:
|
6347
6357
|
type: string
|
6358
|
+
classification_code:
|
6359
|
+
type: string
|
6360
|
+
maxLength: 64
|
6361
|
+
title: '対象の商品分類コード'
|
6362
|
+
description: |-
|
6363
|
+
対象の商品分類コード (書籍のCコードなど) を指定します。(任意項目)
|
6364
|
+
|
6365
|
+
SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (_ で任意の1文字にマッチし、 % で任意文字列にマッチします。 例: 978-% でISBNコード)
|
6366
|
+
items:
|
6367
|
+
type: string
|
6348
6368
|
required_count:
|
6349
6369
|
type: integer
|
6350
6370
|
minimum: 1
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: pokepay_partner_ruby_sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Pocket Change, Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-02
|
11
|
+
date: 2023-03-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -155,6 +155,7 @@ files:
|
|
155
155
|
- lib/pokepay_partner_ruby_sdk/request/list_account_balances.rb
|
156
156
|
- lib/pokepay_partner_ruby_sdk/request/list_account_expired_balances.rb
|
157
157
|
- lib/pokepay_partner_ruby_sdk/request/list_bills.rb
|
158
|
+
- lib/pokepay_partner_ruby_sdk/request/list_bulk_transaction_jobs.rb
|
158
159
|
- lib/pokepay_partner_ruby_sdk/request/list_campaigns.rb
|
159
160
|
- lib/pokepay_partner_ruby_sdk/request/list_customer_transactions.rb
|
160
161
|
- lib/pokepay_partner_ruby_sdk/request/list_shops.rb
|