pokepay_partner_ruby_sdk 0.3.2 → 0.3.6
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/.github/workflows/release-pr.yml +18 -0
- data/Gemfile.lock +1 -1
- data/docs/README.md +269 -0
- data/docs/account.md +159 -0
- data/docs/bank_pay.md +235 -0
- data/docs/bill.md +365 -0
- data/docs/bulk.md +121 -0
- data/docs/campaign.md +1749 -0
- data/docs/cashtray.md +318 -0
- data/docs/check.md +883 -0
- data/docs/coupon.md +724 -0
- data/docs/customer.md +1042 -0
- data/docs/error-response.csv +839 -0
- data/docs/event.md +308 -0
- data/docs/index.md +1279 -305
- data/docs/organization.md +292 -0
- data/docs/private_money.md +213 -0
- data/docs/responses.md +711 -0
- data/docs/shop.md +678 -0
- data/docs/transaction.md +2021 -0
- data/docs/transfer.md +686 -0
- data/docs/user.md +3 -0
- data/docs/user_device.md +134 -0
- data/docs/webhook.md +231 -0
- data/lib/pokepay_partner_ruby_sdk/request/activate_user_device.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_bank.rb +17 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_bank_topup_transaction.rb +18 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_coupon.rb +19 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_external_transaction.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/request/create_transaction_with_cashtray.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_user_device.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/delete_webhook.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_check.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_coupon.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/request/get_external_transaction_by_request_id.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_user_device.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_banks.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_checks.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_organizations.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/refund_external_transaction.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/request/update_check.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/update_coupon.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/response/bank.rb +28 -0
- data/lib/pokepay_partner_ruby_sdk/response/bank_registering_info.rb +13 -0
- data/lib/pokepay_partner_ruby_sdk/response/banks.rb +13 -0
- data/lib/pokepay_partner_ruby_sdk/response/campaign.rb +6 -0
- data/lib/pokepay_partner_ruby_sdk/response/check.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/external_transaction_detail.rb +34 -0
- data/lib/pokepay_partner_ruby_sdk/response/organization_summary.rb +4 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_checks.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_organizations.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/private_money_summary.rb +4 -0
- data/lib/pokepay_partner_ruby_sdk/response/product.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/user_device.rb +18 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +26 -4
- data/partner.yaml +1578 -216
- metadata +46 -2
data/docs/index.md
CHANGED
@@ -173,6 +173,9 @@ response.body
|
|
173
173
|
- [ListTransfers](#list-transfers):
|
174
174
|
- [ListTransfersV2](#list-transfers-v2):
|
175
175
|
- [CreateCheck](#create-check): チャージQRコードの発行
|
176
|
+
- [ListChecks](#list-checks): チャージQRコード一覧の取得
|
177
|
+
- [GetCheck](#get-check): チャージQRコードの表示
|
178
|
+
- [UpdateCheck](#update-check): チャージQRコードの更新
|
176
179
|
- [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
|
177
180
|
- [ListBills](#list-bills): 支払いQRコード一覧を表示する
|
178
181
|
- [CreateBill](#create-bill): 支払いQRコードの発行
|
@@ -191,6 +194,8 @@ response.body
|
|
191
194
|
- [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーをウォレットと共に追加する
|
192
195
|
- [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
|
193
196
|
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
197
|
+
- [ListOrganizations](#list-organizations): 加盟店組織の一覧を取得する
|
198
|
+
- [CreateOrganization](#create-organization): 新規加盟店組織を追加する
|
194
199
|
- [ListShops](#list-shops): 店舗一覧を取得する
|
195
200
|
- [CreateShop](#create-shop): 【廃止】新規店舗を追加する
|
196
201
|
- [CreateShopV2](#create-shop-v2): 新規店舗を追加する
|
@@ -211,15 +216,24 @@ response.body
|
|
211
216
|
- [CreateWebhook](#create-webhook): webhookの作成
|
212
217
|
- [ListWebhooks](#list-webhooks): 作成したWebhookの一覧を返す
|
213
218
|
- [UpdateWebhook](#update-webhook): Webhookの更新
|
219
|
+
- [DeleteWebhook](#delete-webhook): Webhookの削除
|
214
220
|
- [ListCoupons](#list-coupons): クーポン一覧の取得
|
221
|
+
- [CreateCoupon](#create-coupon): クーポンの登録
|
215
222
|
- [GetCoupon](#get-coupon): クーポンの取得
|
223
|
+
- [UpdateCoupon](#update-coupon): クーポンの更新
|
224
|
+
- [CreateUserDevice](#create-user-device): ユーザーのデバイス登録
|
225
|
+
- [GetUserDevice](#get-user-device): ユーザーのデバイスを取得
|
226
|
+
- [ActivateUserDevice](#activate-user-device): デバイスの有効化
|
227
|
+
- [CreateBank](#create-bank): 銀行口座の登録
|
228
|
+
- [ListBanks](#list-banks): 登録した銀行の一覧
|
229
|
+
- [CreateBankTopupTransaction](#create-bank-topup-transaction): 銀行からのチャージ
|
216
230
|
### Transaction
|
217
231
|
<a name="get-cpm-token"></a>
|
218
232
|
#### CPMトークンの状態取得
|
219
233
|
CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
|
220
234
|
```ruby
|
221
235
|
response = $client.send(Pokepay::Request::GetCpmToken.new(
|
222
|
-
"
|
236
|
+
"uGDOLqsy43AtWyT6hyzJkP" # cpm_token: CPMトークン
|
223
237
|
))
|
224
238
|
```
|
225
239
|
|
@@ -241,18 +255,18 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
|
|
241
255
|
取引一覧を返します。
|
242
256
|
```ruby
|
243
257
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
244
|
-
from: "
|
245
|
-
to: "
|
258
|
+
from: "2021-10-29T04:05:32.000000Z", # 開始日時
|
259
|
+
to: "2021-09-14T01:13:45.000000Z", # 終了日時
|
246
260
|
page: 1, # ページ番号
|
247
261
|
per_page: 50, # 1ページ分の取引数
|
248
262
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
249
263
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
250
264
|
customer_name: "太郎", # エンドユーザー名
|
251
265
|
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
252
|
-
transaction_id: "
|
266
|
+
transaction_id: "dv4Vr2ADh", # 取引ID
|
253
267
|
organization_code: "pocketchange", # 組織コード
|
254
268
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
255
|
-
is_modified:
|
269
|
+
is_modified: true, # キャンセルフラグ
|
256
270
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
257
271
|
description: "店頭QRコードによる支払い" # 取引説明文
|
258
272
|
))
|
@@ -353,7 +367,9 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
353
367
|
---
|
354
368
|
`transaction_id`
|
355
369
|
```json
|
356
|
-
{
|
370
|
+
{
|
371
|
+
"type": "string"
|
372
|
+
}
|
357
373
|
```
|
358
374
|
取引IDです。
|
359
375
|
|
@@ -387,7 +403,9 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
387
403
|
---
|
388
404
|
`is_modified`
|
389
405
|
```json
|
390
|
-
{
|
406
|
+
{
|
407
|
+
"type": "boolean"
|
408
|
+
}
|
391
409
|
```
|
392
410
|
キャンセルフラグです。
|
393
411
|
|
@@ -401,11 +419,14 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
401
419
|
"type": "array",
|
402
420
|
"items": {
|
403
421
|
"type": "string",
|
404
|
-
"enum":
|
405
|
-
"topup"
|
406
|
-
"
|
407
|
-
"
|
408
|
-
|
422
|
+
"enum": [
|
423
|
+
"topup",
|
424
|
+
"payment",
|
425
|
+
"exchange_outflow",
|
426
|
+
"exchange_inflow",
|
427
|
+
"cashback",
|
428
|
+
"expire"
|
429
|
+
]
|
409
430
|
}
|
410
431
|
}
|
411
432
|
```
|
@@ -453,10 +474,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
453
474
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
454
475
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
455
476
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
456
|
-
money_amount:
|
457
|
-
point_amount:
|
458
|
-
point_expires_at: "
|
459
|
-
description: "
|
477
|
+
money_amount: 5908,
|
478
|
+
point_amount: 238,
|
479
|
+
point_expires_at: "2021-04-14T12:51:14.000000Z", # ポイント有効期限
|
480
|
+
description: "2AhJrtrRhEmEhncAz9T8Jn6tKv842hmKtJWGe0W2JoBVxOBG6QSEaMM6DcJjfAtdrmKAg3KBKDu0vlbYdV"
|
460
481
|
))
|
461
482
|
```
|
462
483
|
|
@@ -485,11 +506,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
485
506
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
486
507
|
customer_name: "太郎", # エンドユーザー名
|
487
508
|
description: "店頭QRコードによる支払い", # 取引説明文
|
488
|
-
transaction_id: "
|
509
|
+
transaction_id: "6n9n", # 取引ID
|
489
510
|
is_modified: true, # キャンセルフラグ
|
490
511
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
491
|
-
from: "
|
492
|
-
to: "2020-
|
512
|
+
from: "2023-11-21T23:39:56.000000Z", # 開始日時
|
513
|
+
to: "2020-11-05T05:28:40.000000Z", # 終了日時
|
493
514
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransactionのID
|
494
515
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransactionのID
|
495
516
|
per_page: 50 # 1ページ分の取引数
|
@@ -584,7 +605,9 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
584
605
|
---
|
585
606
|
`transaction_id`
|
586
607
|
```json
|
587
|
-
{
|
608
|
+
{
|
609
|
+
"type": "string"
|
610
|
+
}
|
588
611
|
```
|
589
612
|
取引IDです。
|
590
613
|
|
@@ -593,7 +616,9 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
593
616
|
---
|
594
617
|
`is_modified`
|
595
618
|
```json
|
596
|
-
{
|
619
|
+
{
|
620
|
+
"type": "boolean"
|
621
|
+
}
|
597
622
|
```
|
598
623
|
キャンセルフラグです。
|
599
624
|
|
@@ -607,11 +632,14 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
607
632
|
"type": "array",
|
608
633
|
"items": {
|
609
634
|
"type": "string",
|
610
|
-
"enum":
|
611
|
-
"topup"
|
612
|
-
"
|
613
|
-
"
|
614
|
-
|
635
|
+
"enum": [
|
636
|
+
"topup",
|
637
|
+
"payment",
|
638
|
+
"exchange_outflow",
|
639
|
+
"exchange_inflow",
|
640
|
+
"cashback",
|
641
|
+
"expire"
|
642
|
+
]
|
615
643
|
}
|
616
644
|
}
|
617
645
|
```
|
@@ -718,9 +746,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
718
746
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
719
747
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
720
748
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
721
|
-
money_amount:
|
722
|
-
point_amount:
|
723
|
-
point_expires_at: "
|
749
|
+
money_amount: 9868, # マネー額
|
750
|
+
point_amount: 2287, # ポイント額
|
751
|
+
point_expires_at: "2020-08-17T18:52:59.000000Z", # ポイント有効期限
|
724
752
|
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
725
753
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
726
754
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
@@ -862,7 +890,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
862
890
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
863
891
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
864
892
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
865
|
-
|
893
|
+
7611, # amount: 支払い額
|
866
894
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
867
895
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
868
896
|
products: [{"jan_code":"abc",
|
@@ -875,11 +903,6 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
875
903
|
"unit_price":100,
|
876
904
|
"price": 100,
|
877
905
|
"is_discounted": false,
|
878
|
-
"other":"{}"}, {"jan_code":"abc",
|
879
|
-
"name":"name1",
|
880
|
-
"unit_price":100,
|
881
|
-
"price": 100,
|
882
|
-
"is_discounted": false,
|
883
906
|
"other":"{}"}], # 商品情報データ
|
884
907
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
885
908
|
))
|
@@ -962,7 +985,9 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
962
985
|
```json
|
963
986
|
{
|
964
987
|
"type": "array",
|
965
|
-
"items": {
|
988
|
+
"items": {
|
989
|
+
"type": "object"
|
990
|
+
}
|
966
991
|
}
|
967
992
|
```
|
968
993
|
一つの取引に含まれる商品情報データです。
|
@@ -998,9 +1023,9 @@ CPMトークンに設定されたスコープの取引を作ることができ
|
|
998
1023
|
|
999
1024
|
```ruby
|
1000
1025
|
response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
1001
|
-
"
|
1026
|
+
"3cE33CQPF6kxIlI0uguDnz", # cpm_token: CPMトークン
|
1002
1027
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
1003
|
-
|
1028
|
+
7017.0, # amount: 取引金額
|
1004
1029
|
description: "たい焼き(小倉)", # 取引説明文
|
1005
1030
|
metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
|
1006
1031
|
products: [{"jan_code":"abc",
|
@@ -1051,7 +1076,9 @@ response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
|
1051
1076
|
---
|
1052
1077
|
`amount`
|
1053
1078
|
```json
|
1054
|
-
{
|
1079
|
+
{
|
1080
|
+
"type": "number"
|
1081
|
+
}
|
1055
1082
|
```
|
1056
1083
|
取引金額を指定します。
|
1057
1084
|
|
@@ -1086,7 +1113,9 @@ response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
|
1086
1113
|
```json
|
1087
1114
|
{
|
1088
1115
|
"type": "array",
|
1089
|
-
"items": {
|
1116
|
+
"items": {
|
1117
|
+
"type": "object"
|
1118
|
+
}
|
1090
1119
|
}
|
1091
1120
|
```
|
1092
1121
|
一つの取引に含まれる商品情報データです。
|
@@ -1125,7 +1154,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
1125
1154
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
1126
1155
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
1127
1156
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1128
|
-
|
1157
|
+
4244.0, # amount: 送金額
|
1129
1158
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
1130
1159
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
1131
1160
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
@@ -1227,8 +1256,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
1227
1256
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1228
1257
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1229
1258
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1230
|
-
|
1231
|
-
description: "
|
1259
|
+
4322,
|
1260
|
+
description: "NYM7VX5YLnlD8HOOCDlP4GZ7jbmXMO5zVMwfk3fyCehTHNb57OPgysrQCIrNbKg5EGtS1CRG8HTOfVnvp3qGXZFBsOSpPHbliv7UIdhUMzObVJcG5btiH5rur7GsubMGTjIcOXKD9o8Kba3",
|
1232
1261
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
1233
1262
|
))
|
1234
1263
|
```
|
@@ -1285,7 +1314,7 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
1285
1314
|
response = $client.send(Pokepay::Request::RefundTransaction.new(
|
1286
1315
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
|
1287
1316
|
description: "返品対応のため", # 取引履歴に表示する返金事由
|
1288
|
-
returning_point_expires_at: "2021-
|
1317
|
+
returning_point_expires_at: "2021-07-25T19:14:10.000000Z" # 返却ポイントの有効期限
|
1289
1318
|
))
|
1290
1319
|
```
|
1291
1320
|
|
@@ -1344,8 +1373,8 @@ CSVの作成は非同期で行われるため完了まで少しの間待つ必
|
|
1344
1373
|
また、指定期間より前の決済を時間をおいてキャンセルした場合などには payment_money_amount, payment_point_amount, payment_transaction_count が負の値になることもあることに留意してください。
|
1345
1374
|
```ruby
|
1346
1375
|
response = $client.send(Pokepay::Request::RequestUserStats.new(
|
1347
|
-
"
|
1348
|
-
"
|
1376
|
+
"2022-05-20T17:56:49.000000+09:00", # from: 集計期間の開始時刻
|
1377
|
+
"2023-12-10T01:16:11.000000+09:00" # to: 集計期間の終了時刻
|
1349
1378
|
))
|
1350
1379
|
```
|
1351
1380
|
|
@@ -1380,8 +1409,8 @@ response = $client.send(Pokepay::Request::RequestUserStats.new(
|
|
1380
1409
|
```ruby
|
1381
1410
|
response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
1382
1411
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
1383
|
-
from: "
|
1384
|
-
to: "
|
1412
|
+
from: "2023-10-08T11:07:38.000000Z", # 集計期間の開始時刻
|
1413
|
+
to: "2022-03-06T17:42:32.000000Z", # 集計期間の終了時刻
|
1385
1414
|
transfer_types: ["topup", "payment"] # 取引明細種別 (複数指定可)
|
1386
1415
|
))
|
1387
1416
|
```
|
@@ -1405,14 +1434,20 @@ response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
|
1405
1434
|
"type": "array",
|
1406
1435
|
"items": {
|
1407
1436
|
"type": "string",
|
1408
|
-
"enum":
|
1409
|
-
"payment"
|
1410
|
-
"
|
1411
|
-
"
|
1412
|
-
"
|
1413
|
-
"
|
1414
|
-
"refund-
|
1415
|
-
|
1437
|
+
"enum": [
|
1438
|
+
"payment",
|
1439
|
+
"topup",
|
1440
|
+
"campaign-topup",
|
1441
|
+
"use-coupon",
|
1442
|
+
"refund-payment",
|
1443
|
+
"refund-topup",
|
1444
|
+
"refund-campaign",
|
1445
|
+
"refund-coupon",
|
1446
|
+
"exchange-inflow",
|
1447
|
+
"exchange-outflow",
|
1448
|
+
"refund-exchange-inflow",
|
1449
|
+
"refund-exchange-outflow"
|
1450
|
+
]
|
1416
1451
|
}
|
1417
1452
|
}
|
1418
1453
|
```
|
@@ -1450,19 +1485,19 @@ response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
|
1450
1485
|
####
|
1451
1486
|
```ruby
|
1452
1487
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
1453
|
-
from: "
|
1454
|
-
to: "
|
1455
|
-
page:
|
1456
|
-
per_page:
|
1488
|
+
from: "2020-11-23T13:17:35.000000Z",
|
1489
|
+
to: "2022-06-30T21:15:53.000000Z",
|
1490
|
+
page: 6600,
|
1491
|
+
per_page: 7718,
|
1457
1492
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1458
|
-
shop_name: "
|
1493
|
+
shop_name: "BURahT5P9DvE8UV0j2YqC15yVJZpc8KVpH",
|
1459
1494
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1460
|
-
customer_name: "
|
1495
|
+
customer_name: "ARBDgg1",
|
1461
1496
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1462
1497
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
1463
|
-
is_modified:
|
1464
|
-
transaction_types: ["
|
1465
|
-
transfer_types: ["campaign"],
|
1498
|
+
is_modified: true,
|
1499
|
+
transaction_types: ["expire"],
|
1500
|
+
transfer_types: ["cashback", "coupon", "topup", "transfer", "exchange", "campaign", "payment", "expire"], # 取引明細の種類でフィルターします。
|
1466
1501
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
1467
1502
|
))
|
1468
1503
|
```
|
@@ -1474,12 +1509,16 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
1474
1509
|
"type": "array",
|
1475
1510
|
"items": {
|
1476
1511
|
"type": "string",
|
1477
|
-
"enum":
|
1478
|
-
"topup"
|
1479
|
-
"
|
1480
|
-
"
|
1481
|
-
"
|
1482
|
-
|
1512
|
+
"enum": [
|
1513
|
+
"topup",
|
1514
|
+
"payment",
|
1515
|
+
"exchange",
|
1516
|
+
"transfer",
|
1517
|
+
"coupon",
|
1518
|
+
"campaign",
|
1519
|
+
"cashback",
|
1520
|
+
"expire"
|
1521
|
+
]
|
1483
1522
|
}
|
1484
1523
|
}
|
1485
1524
|
```
|
@@ -1527,20 +1566,20 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
1527
1566
|
```ruby
|
1528
1567
|
response = $client.send(Pokepay::Request::ListTransfersV2.new(
|
1529
1568
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
1530
|
-
shop_name: "
|
1569
|
+
shop_name: "cmC1vS6JUWIFuWHifSCeHqDX4OovF1kPsfFAfUD6hedBMnO5c5siBhPS0PdEUgltcrxJuLRpPyEyLzg5USUF0acnAYj9bCB7rUqwv3jfmweeo8gmjkrVbM4yoFbYRleOf9KOkq0RFzjJHwRArvOU8komJ1Atk5R", # 店舗名
|
1531
1570
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
1532
|
-
customer_name: "
|
1571
|
+
customer_name: "lui7mGRMrDuzhgMwi2QEwxvEfxvbfoaYN92mmS964bSnGq9n7PpIOomMWW66P3IlH0kXmsTMdugDsmRtGnF7L4k", # エンドユーザー名
|
1533
1572
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
|
1534
1573
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1535
1574
|
is_modified: false, # キャンセルフラグ
|
1536
|
-
transaction_types: ["
|
1575
|
+
transaction_types: ["cashback", "topup"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
1537
1576
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransferのID
|
1538
1577
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransferのID
|
1539
1578
|
per_page: 50, # 1ページ分の取引数
|
1540
|
-
transfer_types: ["
|
1579
|
+
transfer_types: ["expire", "transfer"], # 取引明細種別 (複数指定可)
|
1541
1580
|
description: "店頭QRコードによる支払い", # 取引詳細説明文
|
1542
|
-
from: "
|
1543
|
-
to: "
|
1581
|
+
from: "2023-02-15T14:34:28.000000Z", # 開始日時
|
1582
|
+
to: "2023-04-18T00:39:59.000000Z" # 終了日時
|
1544
1583
|
))
|
1545
1584
|
```
|
1546
1585
|
|
@@ -1619,7 +1658,9 @@ response = $client.send(Pokepay::Request::ListTransfersV2.new(
|
|
1619
1658
|
---
|
1620
1659
|
`is_modified`
|
1621
1660
|
```json
|
1622
|
-
{
|
1661
|
+
{
|
1662
|
+
"type": "boolean"
|
1663
|
+
}
|
1623
1664
|
```
|
1624
1665
|
キャンセルフラグです。
|
1625
1666
|
|
@@ -1633,11 +1674,14 @@ response = $client.send(Pokepay::Request::ListTransfersV2.new(
|
|
1633
1674
|
"type": "array",
|
1634
1675
|
"items": {
|
1635
1676
|
"type": "string",
|
1636
|
-
"enum":
|
1637
|
-
"topup"
|
1638
|
-
"
|
1639
|
-
"
|
1640
|
-
|
1677
|
+
"enum": [
|
1678
|
+
"topup",
|
1679
|
+
"payment",
|
1680
|
+
"transfer",
|
1681
|
+
"exchange",
|
1682
|
+
"cashback",
|
1683
|
+
"expire"
|
1684
|
+
]
|
1641
1685
|
}
|
1642
1686
|
}
|
1643
1687
|
```
|
@@ -1716,12 +1760,16 @@ prev_page_cursor_idのtransfer自体は前のページには含まれません
|
|
1716
1760
|
"type": "array",
|
1717
1761
|
"items": {
|
1718
1762
|
"type": "string",
|
1719
|
-
"enum":
|
1720
|
-
"topup"
|
1721
|
-
"
|
1722
|
-
"
|
1723
|
-
"
|
1724
|
-
|
1763
|
+
"enum": [
|
1764
|
+
"topup",
|
1765
|
+
"payment",
|
1766
|
+
"exchange",
|
1767
|
+
"transfer",
|
1768
|
+
"coupon",
|
1769
|
+
"campaign",
|
1770
|
+
"cashback",
|
1771
|
+
"expire"
|
1772
|
+
]
|
1725
1773
|
}
|
1726
1774
|
}
|
1727
1775
|
```
|
@@ -1802,37 +1850,445 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
|
|
1802
1850
|
```ruby
|
1803
1851
|
response = $client.send(Pokepay::Request::CreateCheck.new(
|
1804
1852
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
|
1805
|
-
money_amount:
|
1806
|
-
point_amount:
|
1853
|
+
money_amount: 935.0, # 付与マネー額
|
1854
|
+
point_amount: 2607.0, # 付与ポイント額
|
1807
1855
|
description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
|
1808
|
-
is_onetime: false, #
|
1809
|
-
usage_limit:
|
1810
|
-
expires_at: "
|
1811
|
-
point_expires_at: "
|
1812
|
-
point_expires_in_days: 60, # チャージQR
|
1813
|
-
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" #
|
1856
|
+
is_onetime: false, # ワンタイムかどうかのフラグ
|
1857
|
+
usage_limit: 4146, # ワンタイムでない場合の最大読み取り回数
|
1858
|
+
expires_at: "2021-08-06T05:57:27.000000Z", # チャージQRコード自体の失効日時
|
1859
|
+
point_expires_at: "2023-09-18T07:29:12.000000Z", # チャージQRコードによって付与されるポイント残高の有効期限
|
1860
|
+
point_expires_in_days: 60, # チャージQRコードによって付与されるポイント残高の有効期限(相対日数指定)
|
1861
|
+
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗のウォレットID
|
1814
1862
|
))
|
1815
1863
|
```
|
1816
1864
|
`money_amount`と`point_amount`の少なくとも一方は指定する必要があります。
|
1817
1865
|
|
1818
1866
|
|
1867
|
+
---
|
1868
|
+
`money_amount`
|
1869
|
+
```json
|
1870
|
+
{
|
1871
|
+
"type": "number",
|
1872
|
+
"format": "decimal",
|
1873
|
+
"minimum": 0
|
1874
|
+
}
|
1875
|
+
```
|
1876
|
+
チャージQRコードによって付与されるマネー額です。
|
1877
|
+
`money_amount`と`point_amount`の少なくともどちらかは指定する必要があります。
|
1878
|
+
|
1879
|
+
|
1880
|
+
---
|
1881
|
+
`point_amount`
|
1882
|
+
```json
|
1883
|
+
{
|
1884
|
+
"type": "number",
|
1885
|
+
"format": "decimal",
|
1886
|
+
"minimum": 0
|
1887
|
+
}
|
1888
|
+
```
|
1889
|
+
チャージQRコードによって付与されるポイント額です。
|
1890
|
+
`money_amount`と`point_amount`の少なくともどちらかは指定する必要があります。
|
1891
|
+
|
1892
|
+
|
1819
1893
|
---
|
1820
1894
|
`is_onetime`
|
1821
1895
|
```json
|
1822
|
-
{
|
1896
|
+
{
|
1897
|
+
"type": "boolean"
|
1898
|
+
}
|
1823
1899
|
```
|
1824
1900
|
チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
|
1825
|
-
`false
|
1901
|
+
`false`の場合、複数ユーザによって読み取り可能なQRコードになります。
|
1902
|
+
ただし、その場合も1ユーザにつき1回のみしか読み取れません。
|
1903
|
+
|
1904
|
+
|
1905
|
+
---
|
1906
|
+
`usage_limit`
|
1907
|
+
```json
|
1908
|
+
{
|
1909
|
+
"type": "integer"
|
1910
|
+
}
|
1911
|
+
```
|
1912
|
+
複数ユーザによって読み取り可能なチャージQRコードの最大読み取り回数を指定します。
|
1913
|
+
NULLに設定すると無制限に読み取り可能なチャージQRコードになります。
|
1914
|
+
デフォルト値はNULLです。
|
1915
|
+
ワンタイム指定(`is_onetime`)がされているときは、本パラメータはNULLである必要があります。
|
1916
|
+
|
1917
|
+
|
1918
|
+
---
|
1919
|
+
`expires_at`
|
1920
|
+
```json
|
1921
|
+
{
|
1922
|
+
"type": "string",
|
1923
|
+
"format": "date-time"
|
1924
|
+
}
|
1925
|
+
```
|
1926
|
+
チャージQRコード自体の失効日時を指定します。この日時以降はチャージQRコードを読み取れなくなります。デフォルトでは作成日時から3ヶ月後になります。
|
1927
|
+
|
1928
|
+
チャージQRコード自体の失効日時であって、チャージQRコードによって付与されるマネー残高の有効期限とは異なることに注意してください。マネー残高の有効期限はマネー設定で指定されているものになります。
|
1929
|
+
|
1930
|
+
|
1931
|
+
---
|
1932
|
+
`point_expires_at`
|
1933
|
+
```json
|
1934
|
+
{
|
1935
|
+
"type": "string",
|
1936
|
+
"format": "date-time"
|
1937
|
+
}
|
1938
|
+
```
|
1939
|
+
チャージQRコードによって付与されるポイント残高の有効起源を指定します。デフォルトではマネー残高の有効期限と同じものが指定されます。
|
1940
|
+
|
1941
|
+
チャージQRコードにより付与されるマネー残高の有効期限はQRコード毎には指定できませんが、ポイント残高の有効期限は本パラメータにより、QRコード毎に個別に指定することができます。
|
1942
|
+
|
1943
|
+
|
1944
|
+
---
|
1945
|
+
`point_expires_in_days`
|
1946
|
+
```json
|
1947
|
+
{
|
1948
|
+
"type": "integer",
|
1949
|
+
"minimum": 1
|
1950
|
+
}
|
1951
|
+
```
|
1952
|
+
チャージQRコードによって付与されるポイント残高の有効期限を相対日数で指定します。
|
1953
|
+
1を指定すると、チャージQRコード作成日の当日中に失効します(翌日0時に失効)。
|
1954
|
+
`point_expires_at`と`point_expires_in_days`が両方指定されている場合は、チャージQRコードによるチャージ取引ができた時点からより近い方が採用されます。
|
1955
|
+
|
1956
|
+
|
1957
|
+
---
|
1958
|
+
`bear_point_account`
|
1959
|
+
```json
|
1960
|
+
{
|
1961
|
+
"type": "string",
|
1962
|
+
"format": "uuid"
|
1963
|
+
}
|
1964
|
+
```
|
1965
|
+
ポイントチャージをする場合、ポイント額を負担する店舗のウォレットIDを指定することができます。
|
1966
|
+
デフォルトではマネー発行体のデフォルト店舗(本店)がポイント負担先となります。
|
1967
|
+
|
1968
|
+
|
1969
|
+
---
|
1970
|
+
成功したときは[Check](#check)オブジェクトを返します
|
1971
|
+
<a name="list-checks"></a>
|
1972
|
+
#### チャージQRコード一覧の取得
|
1973
|
+
```ruby
|
1974
|
+
response = $client.send(Pokepay::Request::ListChecks.new(
|
1975
|
+
page: 7969, # ページ番号
|
1976
|
+
per_page: 50, # 1ページの表示数
|
1977
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1978
|
+
organization_code: "cI", # 組織コード
|
1979
|
+
expires_from: "2021-06-12T19:58:59.000000Z", # 有効期限の期間によるフィルター(開始時点)
|
1980
|
+
expires_to: "2022-12-03T23:21:29.000000Z", # 有効期限の期間によるフィルター(終了時点)
|
1981
|
+
created_from: "2020-06-25T13:13:54.000000Z", # 作成日時の期間によるフィルター(開始時点)
|
1982
|
+
created_to: "2022-07-01T05:15:53.000000Z", # 作成日時の期間によるフィルター(終了時点)
|
1983
|
+
issuer_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 発行店舗ID
|
1984
|
+
description: "ayD2", # チャージQRコードの説明文
|
1985
|
+
is_onetime: false, # ワンタイムのチャージQRコードかどうか
|
1986
|
+
is_disabled: false # 無効化されたチャージQRコードかどうか
|
1987
|
+
))
|
1988
|
+
```
|
1989
|
+
|
1990
|
+
---
|
1991
|
+
`per_page`
|
1992
|
+
```json
|
1993
|
+
{
|
1994
|
+
"type": "integer",
|
1995
|
+
"minimum": 1
|
1996
|
+
}
|
1997
|
+
```
|
1998
|
+
1ページ当たり表示数です。デフォルト値は50です。
|
1999
|
+
|
2000
|
+
---
|
2001
|
+
`private_money_id`
|
2002
|
+
```json
|
2003
|
+
{
|
2004
|
+
"type": "string",
|
2005
|
+
"format": "uuid"
|
2006
|
+
}
|
2007
|
+
```
|
2008
|
+
チャージQRコードのチャージ対象のマネーIDで結果をフィルターします。
|
2009
|
+
|
2010
|
+
|
2011
|
+
---
|
2012
|
+
`organization_code`
|
2013
|
+
```json
|
2014
|
+
{
|
2015
|
+
"type": "string",
|
2016
|
+
"maxLength": 32
|
2017
|
+
}
|
2018
|
+
```
|
2019
|
+
チャージQRコードの発行店舗の所属組織の組織コードで結果をフィルターします。
|
2020
|
+
デフォルトでは未指定です。
|
2021
|
+
|
2022
|
+
---
|
2023
|
+
`expires_from`
|
2024
|
+
```json
|
2025
|
+
{
|
2026
|
+
"type": "string",
|
2027
|
+
"format": "date-time"
|
2028
|
+
}
|
2029
|
+
```
|
2030
|
+
有効期限の期間によるフィルターの開始時点のタイムスタンプです。
|
2031
|
+
デフォルトでは未指定です。
|
2032
|
+
|
2033
|
+
|
2034
|
+
---
|
2035
|
+
`expires_to`
|
2036
|
+
```json
|
2037
|
+
{
|
2038
|
+
"type": "string",
|
2039
|
+
"format": "date-time"
|
2040
|
+
}
|
2041
|
+
```
|
2042
|
+
有効期限の期間によるフィルターの終了時点のタイムスタンプです。
|
2043
|
+
デフォルトでは未指定です。
|
2044
|
+
|
2045
|
+
|
2046
|
+
---
|
2047
|
+
`created_from`
|
2048
|
+
```json
|
2049
|
+
{
|
2050
|
+
"type": "string",
|
2051
|
+
"format": "date-time"
|
2052
|
+
}
|
2053
|
+
```
|
2054
|
+
作成日時の期間によるフィルターの開始時点のタイムスタンプです。
|
2055
|
+
デフォルトでは未指定です。
|
2056
|
+
|
2057
|
+
|
2058
|
+
---
|
2059
|
+
`created_to`
|
2060
|
+
```json
|
2061
|
+
{
|
2062
|
+
"type": "string",
|
2063
|
+
"format": "date-time"
|
2064
|
+
}
|
2065
|
+
```
|
2066
|
+
作成日時の期間によるフィルターの終了時点のタイムスタンプです。
|
2067
|
+
デフォルトでは未指定です。
|
2068
|
+
|
2069
|
+
|
2070
|
+
---
|
2071
|
+
`issuer_shop_id`
|
2072
|
+
```json
|
2073
|
+
{
|
2074
|
+
"type": "string",
|
2075
|
+
"format": "uuid"
|
2076
|
+
}
|
2077
|
+
```
|
2078
|
+
チャージQRコードを発行した店舗IDによってフィルターします。
|
2079
|
+
デフォルトでは未指定です。
|
2080
|
+
|
2081
|
+
|
2082
|
+
---
|
2083
|
+
`description`
|
2084
|
+
```json
|
2085
|
+
{
|
2086
|
+
"type": "string"
|
2087
|
+
}
|
2088
|
+
```
|
2089
|
+
チャージQRコードの説明文(description)によってフィルターします。
|
2090
|
+
部分一致(前方一致)したものを表示します。
|
2091
|
+
デフォルトでは未指定です。
|
2092
|
+
|
2093
|
+
|
2094
|
+
---
|
2095
|
+
`is_onetime`
|
2096
|
+
```json
|
2097
|
+
{
|
2098
|
+
"type": "boolean"
|
2099
|
+
}
|
2100
|
+
```
|
2101
|
+
チャージQRコードがワンタイムに設定されているかどうかでフィルターします。
|
2102
|
+
`true` の場合はワンタイムかどうかでフィルターし、`false`の場合はワンタイムでないものをフィルターします。
|
2103
|
+
未指定の場合はフィルターしません。
|
2104
|
+
デフォルトでは未指定です。
|
2105
|
+
|
2106
|
+
|
2107
|
+
---
|
2108
|
+
`is_disabled`
|
2109
|
+
```json
|
2110
|
+
{
|
2111
|
+
"type": "boolean"
|
2112
|
+
}
|
2113
|
+
```
|
2114
|
+
チャージQRコードが無効化されているかどうかでフィルターします。
|
2115
|
+
`true` の場合は無効なものをフィルターし、`false`の場合は有効なものをフィルターします。
|
2116
|
+
未指定の場合はフィルターしません。
|
2117
|
+
デフォルトでは未指定です。
|
2118
|
+
|
2119
|
+
|
2120
|
+
---
|
2121
|
+
成功したときは[PaginatedChecks](#paginated-checks)オブジェクトを返します
|
2122
|
+
<a name="get-check"></a>
|
2123
|
+
#### チャージQRコードの表示
|
2124
|
+
```ruby
|
2125
|
+
response = $client.send(Pokepay::Request::GetCheck.new(
|
2126
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # check_id: チャージQRコードのID
|
2127
|
+
))
|
2128
|
+
```
|
2129
|
+
|
2130
|
+
---
|
2131
|
+
`check_id`
|
2132
|
+
```json
|
2133
|
+
{
|
2134
|
+
"type": "string",
|
2135
|
+
"format": "uuid"
|
2136
|
+
}
|
2137
|
+
```
|
2138
|
+
表示対象のチャージQRコードのIDです。
|
2139
|
+
|
2140
|
+
---
|
2141
|
+
成功したときは[Check](#check)オブジェクトを返します
|
2142
|
+
<a name="update-check"></a>
|
2143
|
+
#### チャージQRコードの更新
|
2144
|
+
```ruby
|
2145
|
+
response = $client.send(Pokepay::Request::UpdateCheck.new(
|
2146
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # check_id: チャージQRコードのID
|
2147
|
+
money_amount: 9706.0, # 付与マネー額
|
2148
|
+
point_amount: 2136.0, # 付与ポイント額
|
2149
|
+
description: "test check", # チャージQRコードの説明文
|
2150
|
+
is_onetime: true, # ワンタイムかどうかのフラグ
|
2151
|
+
usage_limit: 7430, # ワンタイムでない場合の最大読み取り回数
|
2152
|
+
expires_at: "2020-12-10T21:14:54.000000Z", # チャージQRコード自体の失効日時
|
2153
|
+
point_expires_at: "2020-04-25T01:02:58.000000Z", # チャージQRコードによって付与されるポイント残高の有効期限
|
2154
|
+
point_expires_in_days: 60, # チャージQRコードによって付与されるポイント残高の有効期限(相対日数指定)
|
2155
|
+
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント額を負担する店舗のウォレットID
|
2156
|
+
is_disabled: false # 無効化されているかどうかのフラグ
|
2157
|
+
))
|
2158
|
+
```
|
2159
|
+
|
2160
|
+
---
|
2161
|
+
`check_id`
|
2162
|
+
```json
|
2163
|
+
{
|
2164
|
+
"type": "string",
|
2165
|
+
"format": "uuid"
|
2166
|
+
}
|
2167
|
+
```
|
2168
|
+
更新対象のチャージQRコードのIDです。
|
2169
|
+
|
2170
|
+
---
|
2171
|
+
`money_amount`
|
2172
|
+
```json
|
2173
|
+
{
|
2174
|
+
"type": "number",
|
2175
|
+
"format": "decimal",
|
2176
|
+
"minimum": 0
|
2177
|
+
}
|
2178
|
+
```
|
2179
|
+
チャージQRコードによって付与されるマネー額です。
|
2180
|
+
`money_amount`と`point_amount`が両方0になるような更新リクエストはエラーになります。
|
2181
|
+
|
2182
|
+
|
2183
|
+
---
|
2184
|
+
`point_amount`
|
2185
|
+
```json
|
2186
|
+
{
|
2187
|
+
"type": "number",
|
2188
|
+
"format": "decimal",
|
2189
|
+
"minimum": 0
|
2190
|
+
}
|
2191
|
+
```
|
2192
|
+
チャージQRコードによって付与されるポイント額です。
|
2193
|
+
`money_amount`と`point_amount`が両方0になるような更新リクエストはエラーになります。
|
2194
|
+
|
2195
|
+
|
2196
|
+
---
|
2197
|
+
`description`
|
2198
|
+
```json
|
2199
|
+
{
|
2200
|
+
"type": "string",
|
2201
|
+
"maxLength": 200
|
2202
|
+
}
|
2203
|
+
```
|
2204
|
+
チャージQRコードの説明文です。
|
2205
|
+
チャージ取引後は、取引の説明文に転記され、取引履歴などに表示されます。
|
2206
|
+
|
2207
|
+
|
2208
|
+
---
|
2209
|
+
`is_onetime`
|
2210
|
+
```json
|
2211
|
+
{
|
2212
|
+
"type": "boolean"
|
2213
|
+
}
|
2214
|
+
```
|
2215
|
+
チャージQRコードが一度の読み取りで失効するときに`true`にします。
|
2216
|
+
`false`の場合、複数ユーザによって読み取り可能なQRコードになります。
|
2217
|
+
ただし、その場合も1ユーザにつき1回のみしか読み取れません。
|
1826
2218
|
|
1827
2219
|
|
1828
2220
|
---
|
1829
2221
|
`usage_limit`
|
1830
2222
|
```json
|
1831
|
-
{
|
2223
|
+
{
|
2224
|
+
"type": "integer"
|
2225
|
+
}
|
2226
|
+
```
|
2227
|
+
複数ユーザによって読み取り可能なチャージQRコードの最大読み取り回数を指定します。
|
2228
|
+
NULLに設定すると無制限に読み取り可能なチャージQRコードになります。
|
2229
|
+
ワンタイム指定(`is_onetime`)がされているときは、本パラメータはNULLである必要があります。
|
2230
|
+
|
2231
|
+
|
2232
|
+
---
|
2233
|
+
`expires_at`
|
2234
|
+
```json
|
2235
|
+
{
|
2236
|
+
"type": "string",
|
2237
|
+
"format": "date-time"
|
2238
|
+
}
|
2239
|
+
```
|
2240
|
+
チャージQRコード自体の失効日時を指定します。この日時以降はチャージQRコードを読み取れなくなります。
|
2241
|
+
|
2242
|
+
チャージQRコード自体の失効日時であって、チャージQRコードによって付与されるマネー残高の有効期限とは異なることに注意してください。マネー残高の有効期限はマネー設定で指定されているものになります。
|
2243
|
+
|
2244
|
+
|
2245
|
+
---
|
2246
|
+
`point_expires_at`
|
2247
|
+
```json
|
2248
|
+
{
|
2249
|
+
"type": "string",
|
2250
|
+
"format": "date-time"
|
2251
|
+
}
|
2252
|
+
```
|
2253
|
+
チャージQRコードによって付与されるポイント残高の有効起源を指定します。
|
2254
|
+
|
2255
|
+
チャージQRコードにより付与されるマネー残高の有効期限はQRコード毎には指定できませんが、ポイント残高の有効期限は本パラメータにより、QRコード毎に個別に指定することができます。
|
2256
|
+
|
2257
|
+
|
2258
|
+
---
|
2259
|
+
`point_expires_in_days`
|
2260
|
+
```json
|
2261
|
+
{
|
2262
|
+
"type": "integer",
|
2263
|
+
"minimum": 1
|
2264
|
+
}
|
1832
2265
|
```
|
1833
|
-
|
1834
|
-
|
1835
|
-
|
2266
|
+
チャージQRコードによって付与されるポイント残高の有効期限を相対日数で指定します。
|
2267
|
+
1を指定すると、チャージQRコード作成日の当日中に失効します(翌日0時に失効)。
|
2268
|
+
`point_expires_at`と`point_expires_in_days`が両方指定されている場合は、チャージQRコードによるチャージ取引ができた時点からより近い方が採用されます。
|
2269
|
+
`point_expires_at`と`point_expires_in_days`が両方NULLに設定されている場合は、マネーに設定されている残高の有効期限と同じになります。
|
2270
|
+
|
2271
|
+
|
2272
|
+
---
|
2273
|
+
`bear_point_account`
|
2274
|
+
```json
|
2275
|
+
{
|
2276
|
+
"type": "string",
|
2277
|
+
"format": "uuid"
|
2278
|
+
}
|
2279
|
+
```
|
2280
|
+
ポイントチャージをする場合、ポイント額を負担する店舗のウォレットIDを指定することができます。
|
2281
|
+
|
2282
|
+
|
2283
|
+
---
|
2284
|
+
`is_disabled`
|
2285
|
+
```json
|
2286
|
+
{
|
2287
|
+
"type": "boolean"
|
2288
|
+
}
|
2289
|
+
```
|
2290
|
+
チャージQRコードを無効化するときに`true`にします。
|
2291
|
+
`false`の場合は無効化されているチャージQRコードを再有効化します。
|
1836
2292
|
|
1837
2293
|
|
1838
2294
|
---
|
@@ -1898,18 +2354,18 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
1898
2354
|
支払いQRコード一覧を表示します。
|
1899
2355
|
```ruby
|
1900
2356
|
response = $client.send(Pokepay::Request::ListBills.new(
|
1901
|
-
page:
|
1902
|
-
per_page:
|
1903
|
-
bill_id: "
|
2357
|
+
page: 6138, # ページ番号
|
2358
|
+
per_page: 8927, # 1ページの表示数
|
2359
|
+
bill_id: "T", # 支払いQRコードのID
|
1904
2360
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1905
|
-
organization_code: "
|
2361
|
+
organization_code: "xs6VNjs2Mf2--N-VxoE9n6N1iQ3v", # 組織コード
|
1906
2362
|
description: "test bill", # 取引説明文
|
1907
|
-
created_from: "
|
1908
|
-
created_to: "
|
2363
|
+
created_from: "2023-03-22T05:00:31.000000Z", # 作成日時(起点)
|
2364
|
+
created_to: "2024-02-06T00:24:19.000000Z", # 作成日時(終点)
|
1909
2365
|
shop_name: "bill test shop1", # 店舗名
|
1910
2366
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
1911
|
-
lower_limit_amount:
|
1912
|
-
upper_limit_amount:
|
2367
|
+
lower_limit_amount: 3980, # 金額の範囲によるフィルタ(下限)
|
2368
|
+
upper_limit_amount: 6980, # 金額の範囲によるフィルタ(上限)
|
1913
2369
|
is_disabled: true # 支払いQRコードが無効化されているかどうか
|
1914
2370
|
))
|
1915
2371
|
```
|
@@ -1937,7 +2393,9 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
1937
2393
|
---
|
1938
2394
|
`bill_id`
|
1939
2395
|
```json
|
1940
|
-
{
|
2396
|
+
{
|
2397
|
+
"type": "string"
|
2398
|
+
}
|
1941
2399
|
```
|
1942
2400
|
支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
|
1943
2401
|
|
@@ -2041,7 +2499,9 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
2041
2499
|
---
|
2042
2500
|
`is_disabled`
|
2043
2501
|
```json
|
2044
|
-
{
|
2502
|
+
{
|
2503
|
+
"type": "boolean"
|
2504
|
+
}
|
2045
2505
|
```
|
2046
2506
|
支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
|
2047
2507
|
|
@@ -2054,7 +2514,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
2054
2514
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
2055
2515
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
2056
2516
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
2057
|
-
amount:
|
2517
|
+
amount: 1684.0, # 支払い額
|
2058
2518
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
2059
2519
|
))
|
2060
2520
|
```
|
@@ -2078,7 +2538,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
2078
2538
|
```ruby
|
2079
2539
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
2080
2540
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
2081
|
-
amount:
|
2541
|
+
amount: 9656.0, # 支払い額
|
2082
2542
|
description: "test bill", # 説明文
|
2083
2543
|
is_disabled: true # 無効化されているかどうか
|
2084
2544
|
))
|
@@ -2118,7 +2578,9 @@ response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
2118
2578
|
---
|
2119
2579
|
`is_disabled`
|
2120
2580
|
```json
|
2121
|
-
{
|
2581
|
+
{
|
2582
|
+
"type": "boolean"
|
2583
|
+
}
|
2122
2584
|
```
|
2123
2585
|
支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
|
2124
2586
|
|
@@ -2143,9 +2605,9 @@ Cashtrayを作成します。
|
|
2143
2605
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
2144
2606
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2145
2607
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
2146
|
-
|
2608
|
+
6869.0, # amount: 金額
|
2147
2609
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
2148
|
-
expires_in:
|
2610
|
+
expires_in: 3655 # 失効時間(秒)
|
2149
2611
|
))
|
2150
2612
|
```
|
2151
2613
|
|
@@ -2172,7 +2634,9 @@ response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
2172
2634
|
---
|
2173
2635
|
`amount`
|
2174
2636
|
```json
|
2175
|
-
{
|
2637
|
+
{
|
2638
|
+
"type": "number"
|
2639
|
+
}
|
2176
2640
|
```
|
2177
2641
|
マネー額です(必須項目)。
|
2178
2642
|
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
@@ -2308,9 +2772,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
2308
2772
|
```ruby
|
2309
2773
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
2310
2774
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
2311
|
-
amount:
|
2775
|
+
amount: 5236.0, # 金額
|
2312
2776
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
2313
|
-
expires_in:
|
2777
|
+
expires_in: 6303 # 失効時間(秒)
|
2314
2778
|
))
|
2315
2779
|
```
|
2316
2780
|
|
@@ -2327,7 +2791,9 @@ response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
2327
2791
|
---
|
2328
2792
|
`amount`
|
2329
2793
|
```json
|
2330
|
-
{
|
2794
|
+
{
|
2795
|
+
"type": "number"
|
2796
|
+
}
|
2331
2797
|
```
|
2332
2798
|
マネー額です(任意項目)。
|
2333
2799
|
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
@@ -2392,7 +2858,7 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
2392
2858
|
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
2393
2859
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2394
2860
|
is_suspended: false, # ウォレットが凍結されているかどうか
|
2395
|
-
status: "
|
2861
|
+
status: "pre-closed", # ウォレット状態
|
2396
2862
|
can_transfer_topup: false # チャージ可能かどうか
|
2397
2863
|
))
|
2398
2864
|
```
|
@@ -2412,7 +2878,9 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
2412
2878
|
---
|
2413
2879
|
`is_suspended`
|
2414
2880
|
```json
|
2415
|
-
{
|
2881
|
+
{
|
2882
|
+
"type": "boolean"
|
2883
|
+
}
|
2416
2884
|
```
|
2417
2885
|
ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
|
2418
2886
|
|
@@ -2421,7 +2889,11 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
2421
2889
|
```json
|
2422
2890
|
{
|
2423
2891
|
"type": "string",
|
2424
|
-
"enum": [
|
2892
|
+
"enum": [
|
2893
|
+
"active",
|
2894
|
+
"suspended",
|
2895
|
+
"pre-closed"
|
2896
|
+
]
|
2425
2897
|
}
|
2426
2898
|
```
|
2427
2899
|
ウォレットの状態です。
|
@@ -2429,7 +2901,9 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
2429
2901
|
---
|
2430
2902
|
`can_transfer_topup`
|
2431
2903
|
```json
|
2432
|
-
{
|
2904
|
+
{
|
2905
|
+
"type": "boolean"
|
2906
|
+
}
|
2433
2907
|
```
|
2434
2908
|
店舗ユーザーがエンドユーザーにチャージ可能かどうかです。真にするとチャージ可能となり、偽にするとチャージ不可能となります。
|
2435
2909
|
|
@@ -2460,7 +2934,9 @@ response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
2460
2934
|
---
|
2461
2935
|
`cashback`
|
2462
2936
|
```json
|
2463
|
-
{
|
2937
|
+
{
|
2938
|
+
"type": "boolean"
|
2939
|
+
}
|
2464
2940
|
```
|
2465
2941
|
退会時の返金有無です。エンドユーザに返金を行う場合、真を指定して下さい。現在のマネー残高を全て現金で返金したものとして記録されます。
|
2466
2942
|
|
@@ -2472,10 +2948,10 @@ response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
2472
2948
|
```ruby
|
2473
2949
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
2474
2950
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2475
|
-
page:
|
2476
|
-
per_page:
|
2477
|
-
expires_at_from: "2023-
|
2478
|
-
expires_at_to: "
|
2951
|
+
page: 6497, # ページ番号
|
2952
|
+
per_page: 6466, # 1ページ分の取引数
|
2953
|
+
expires_at_from: "2023-06-19T15:21:50.000000Z", # 有効期限の期間によるフィルター(開始時点)
|
2954
|
+
expires_at_to: "2021-03-29T13:19:12.000000Z", # 有効期限の期間によるフィルター(終了時点)
|
2479
2955
|
direction: "desc" # 有効期限によるソート順序
|
2480
2956
|
))
|
2481
2957
|
```
|
@@ -2537,7 +3013,10 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
2537
3013
|
```json
|
2538
3014
|
{
|
2539
3015
|
"type": "string",
|
2540
|
-
"enum":
|
3016
|
+
"enum": [
|
3017
|
+
"asc",
|
3018
|
+
"desc"
|
3019
|
+
]
|
2541
3020
|
}
|
2542
3021
|
```
|
2543
3022
|
有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
|
@@ -2550,11 +3029,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
2550
3029
|
```ruby
|
2551
3030
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
2552
3031
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2553
|
-
page:
|
2554
|
-
per_page:
|
2555
|
-
expires_at_from: "
|
2556
|
-
expires_at_to: "
|
2557
|
-
direction: "
|
3032
|
+
page: 4131, # ページ番号
|
3033
|
+
per_page: 2277, # 1ページ分の取引数
|
3034
|
+
expires_at_from: "2023-03-19T23:33:09.000000Z", # 有効期限の期間によるフィルター(開始時点)
|
3035
|
+
expires_at_to: "2020-07-18T12:17:45.000000Z", # 有効期限の期間によるフィルター(終了時点)
|
3036
|
+
direction: "desc" # 有効期限によるソート順序
|
2558
3037
|
))
|
2559
3038
|
```
|
2560
3039
|
|
@@ -2615,7 +3094,10 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
2615
3094
|
```json
|
2616
3095
|
{
|
2617
3096
|
"type": "string",
|
2618
|
-
"enum":
|
3097
|
+
"enum": [
|
3098
|
+
"asc",
|
3099
|
+
"desc"
|
3100
|
+
]
|
2619
3101
|
}
|
2620
3102
|
```
|
2621
3103
|
有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
|
@@ -2628,9 +3110,9 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
2628
3110
|
```ruby
|
2629
3111
|
response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
2630
3112
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
2631
|
-
status: "
|
2632
|
-
account_name: "
|
2633
|
-
external_id: "
|
3113
|
+
status: "pre-closed", # ウォレット状態
|
3114
|
+
account_name: "rdqAuTxyB0A3WX2EcUb892jz3Nv10xFyFeM64iLpLDhctAZixWvzCjvZGuuLmpXAGJua2paAAkUgzb5zEsMYGbxzOIV2r2JtDEGxgzX90xQ1qEwnOjzBjMdE2ZgqC6g1ENWOPFMuygZod8nuff2bwE3RDjoGhPLmonziI8gPB410GLPQCeC7jS6W3DftZcdyglmNXEppEtAwequ", # アカウント名
|
3115
|
+
external_id: "JiYpSm0jLeVc0IIOP", # 外部ID
|
2634
3116
|
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
2635
3117
|
))
|
2636
3118
|
```
|
@@ -2652,7 +3134,11 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
2652
3134
|
```json
|
2653
3135
|
{
|
2654
3136
|
"type": "string",
|
2655
|
-
"enum": [
|
3137
|
+
"enum": [
|
3138
|
+
"active",
|
3139
|
+
"suspended",
|
3140
|
+
"pre-closed"
|
3141
|
+
]
|
2656
3142
|
}
|
2657
3143
|
```
|
2658
3144
|
ウォレットの状態です。
|
@@ -2710,15 +3196,15 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
2710
3196
|
```ruby
|
2711
3197
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
2712
3198
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2713
|
-
page:
|
2714
|
-
per_page:
|
2715
|
-
created_at_from: "
|
2716
|
-
created_at_to: "
|
2717
|
-
is_suspended:
|
2718
|
-
status: "
|
2719
|
-
external_id: "
|
2720
|
-
tel: "
|
2721
|
-
email: "
|
3199
|
+
page: 7999, # ページ番号
|
3200
|
+
per_page: 5598, # 1ページ分のウォレット数
|
3201
|
+
created_at_from: "2020-02-01T20:26:30.000000Z", # ウォレット作成日によるフィルター(開始時点)
|
3202
|
+
created_at_to: "2020-11-04T16:08:32.000000Z", # ウォレット作成日によるフィルター(終了時点)
|
3203
|
+
is_suspended: false, # ウォレットが凍結状態かどうかでフィルターする
|
3204
|
+
status: "suspended", # ウォレット状態
|
3205
|
+
external_id: "CcBMs9oEUXdmuJ5CsXeAgeVmz0XdBqvz2LZq", # 外部ID
|
3206
|
+
tel: "04-97-168", # エンドユーザーの電話番号
|
3207
|
+
email: "Jk1u6JVnb0@4lQy.com" # エンドユーザーのメールアドレス
|
2722
3208
|
))
|
2723
3209
|
```
|
2724
3210
|
|
@@ -2777,7 +3263,9 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
2777
3263
|
---
|
2778
3264
|
`is_suspended`
|
2779
3265
|
```json
|
2780
|
-
{
|
3266
|
+
{
|
3267
|
+
"type": "boolean"
|
3268
|
+
}
|
2781
3269
|
```
|
2782
3270
|
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
2783
3271
|
|
@@ -2786,7 +3274,11 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
2786
3274
|
```json
|
2787
3275
|
{
|
2788
3276
|
"type": "string",
|
2789
|
-
"enum": [
|
3277
|
+
"enum": [
|
3278
|
+
"active",
|
3279
|
+
"suspended",
|
3280
|
+
"pre-closed"
|
3281
|
+
]
|
2790
3282
|
}
|
2791
3283
|
```
|
2792
3284
|
このパラメータが指定されている場合、ウォレットの状態で結果がフィルターされます。デフォルトでは未指定です。
|
@@ -2834,7 +3326,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
2834
3326
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2835
3327
|
user_name: "ポケペイ太郎", # ユーザー名
|
2836
3328
|
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
2837
|
-
external_id: "
|
3329
|
+
external_id: "4ktenk93ttYPJhOiPCYh" # 外部ID
|
2838
3330
|
))
|
2839
3331
|
```
|
2840
3332
|
|
@@ -2888,11 +3380,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
|
|
2888
3380
|
```ruby
|
2889
3381
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
2890
3382
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2891
|
-
page:
|
2892
|
-
per_page:
|
2893
|
-
created_at_from: "
|
2894
|
-
created_at_to: "
|
2895
|
-
is_suspended:
|
3383
|
+
page: 3879, # ページ番号
|
3384
|
+
per_page: 362, # 1ページ分のウォレット数
|
3385
|
+
created_at_from: "2022-12-20T22:26:04.000000Z", # ウォレット作成日によるフィルター(開始時点)
|
3386
|
+
created_at_to: "2024-02-05T20:41:24.000000Z", # ウォレット作成日によるフィルター(終了時点)
|
3387
|
+
is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
|
2896
3388
|
))
|
2897
3389
|
```
|
2898
3390
|
|
@@ -2951,7 +3443,9 @@ response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
2951
3443
|
---
|
2952
3444
|
`is_suspended`
|
2953
3445
|
```json
|
2954
|
-
{
|
3446
|
+
{
|
3447
|
+
"type": "boolean"
|
3448
|
+
}
|
2955
3449
|
```
|
2956
3450
|
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
2957
3451
|
|
@@ -2965,10 +3459,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
2965
3459
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2966
3460
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
2967
3461
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
2968
|
-
type: "
|
2969
|
-
is_modified:
|
2970
|
-
from: "
|
2971
|
-
to: "
|
3462
|
+
type: "expire", # 取引種別
|
3463
|
+
is_modified: false, # キャンセル済みかどうか
|
3464
|
+
from: "2023-10-17T16:01:34.000000Z", # 開始日時
|
3465
|
+
to: "2022-11-24T21:29:52.000000Z", # 終了日時
|
2972
3466
|
page: 1, # ページ番号
|
2973
3467
|
per_page: 50 # 1ページ分の取引数
|
2974
3468
|
))
|
@@ -3014,11 +3508,14 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
3014
3508
|
```json
|
3015
3509
|
{
|
3016
3510
|
"type": "string",
|
3017
|
-
"enum":
|
3018
|
-
"topup"
|
3019
|
-
"
|
3020
|
-
"
|
3021
|
-
|
3511
|
+
"enum": [
|
3512
|
+
"topup",
|
3513
|
+
"payment",
|
3514
|
+
"exchange",
|
3515
|
+
"transfer",
|
3516
|
+
"cashback",
|
3517
|
+
"expire"
|
3518
|
+
]
|
3022
3519
|
}
|
3023
3520
|
```
|
3024
3521
|
取引の種類でフィルターします。
|
@@ -3041,7 +3538,9 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
3041
3538
|
---
|
3042
3539
|
`is_modified`
|
3043
3540
|
```json
|
3044
|
-
{
|
3541
|
+
{
|
3542
|
+
"type": "boolean"
|
3543
|
+
}
|
3045
3544
|
```
|
3046
3545
|
キャンセル済みかどうかを判定するフラグです。
|
3047
3546
|
|
@@ -3096,6 +3595,71 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
|
|
3096
3595
|
---
|
3097
3596
|
成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
|
3098
3597
|
### Organization
|
3598
|
+
<a name="list-organizations"></a>
|
3599
|
+
#### 加盟店組織の一覧を取得する
|
3600
|
+
```ruby
|
3601
|
+
response = $client.send(Pokepay::Request::ListOrganizations.new(
|
3602
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3603
|
+
page: 1, # ページ番号
|
3604
|
+
per_page: 50, # 1ページ分の取引数
|
3605
|
+
name: "teZ9v4lYI", # 組織名
|
3606
|
+
code: "rYpnV35" # 組織コード
|
3607
|
+
))
|
3608
|
+
```
|
3609
|
+
|
3610
|
+
---
|
3611
|
+
`private_money_id`
|
3612
|
+
```json
|
3613
|
+
{
|
3614
|
+
"type": "string",
|
3615
|
+
"format": "uuid"
|
3616
|
+
}
|
3617
|
+
```
|
3618
|
+
マネーIDです。
|
3619
|
+
このマネーに加盟している加盟組織がフィルターされます。
|
3620
|
+
|
3621
|
+
---
|
3622
|
+
`page`
|
3623
|
+
```json
|
3624
|
+
{
|
3625
|
+
"type": "integer",
|
3626
|
+
"minimum": 1
|
3627
|
+
}
|
3628
|
+
```
|
3629
|
+
取得したいページ番号です。
|
3630
|
+
|
3631
|
+
---
|
3632
|
+
`per_page`
|
3633
|
+
```json
|
3634
|
+
{
|
3635
|
+
"type": "integer",
|
3636
|
+
"minimum": 1
|
3637
|
+
}
|
3638
|
+
```
|
3639
|
+
1ページ分の取引数です。
|
3640
|
+
|
3641
|
+
---
|
3642
|
+
成功したときは[PaginatedOrganizations](#paginated-organizations)オブジェクトを返します
|
3643
|
+
<a name="create-organization"></a>
|
3644
|
+
#### 新規加盟店組織を追加する
|
3645
|
+
```ruby
|
3646
|
+
response = $client.send(Pokepay::Request::CreateOrganization.new(
|
3647
|
+
"ox-supermarket", # code: 新規組織コード
|
3648
|
+
"oxスーパー", # name: 新規組織名
|
3649
|
+
["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # private_money_ids: 加盟店組織で有効にするマネーIDの配列
|
3650
|
+
"pBMGKJEJkp@n6Ml.com", # issuer_admin_user_email: 発行体担当者メールアドレス
|
3651
|
+
"r99tmpLoTF@QeHI.com", # member_admin_user_email: 新規組織担当者メールアドレス
|
3652
|
+
bank_name: "XYZ銀行", # 銀行名
|
3653
|
+
bank_code: "1234", # 銀行金融機関コード
|
3654
|
+
bank_branch_name: "ABC支店", # 銀行支店名
|
3655
|
+
bank_branch_code: "123", # 銀行支店コード
|
3656
|
+
bank_account_type: "saving", # 銀行口座種別 (普通=saving, 当座=current, その他=other)
|
3657
|
+
bank_account: "1234567", # 銀行口座番号
|
3658
|
+
bank_account_holder_name: "フクザワユキチ", # 口座名義人名
|
3659
|
+
contact_name: "佐藤清" # 担当者名
|
3660
|
+
))
|
3661
|
+
```
|
3662
|
+
成功したときは[Organization](#organization)オブジェクトを返します
|
3099
3663
|
### Shop
|
3100
3664
|
<a name="list-shops"></a>
|
3101
3665
|
#### 店舗一覧を取得する
|
@@ -3104,12 +3668,12 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
3104
3668
|
organization_code: "pocketchange", # 組織コード
|
3105
3669
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
3106
3670
|
name: "oxスーパー三田店", # 店舗名
|
3107
|
-
postal_code: "
|
3671
|
+
postal_code: "3992548", # 店舗の郵便番号
|
3108
3672
|
address: "東京都港区芝...", # 店舗の住所
|
3109
|
-
tel: "
|
3110
|
-
email: "
|
3111
|
-
external_id: "
|
3112
|
-
with_disabled:
|
3673
|
+
tel: "04-018-143", # 店舗の電話番号
|
3674
|
+
email: "3zE32Vk24C@een1.com", # 店舗のメールアドレス
|
3675
|
+
external_id: "SjytDUp3byZcFEP", # 店舗の外部ID
|
3676
|
+
with_disabled: true, # 無効な店舗を含める
|
3113
3677
|
page: 1, # ページ番号
|
3114
3678
|
per_page: 50 # 1ページ分の取引数
|
3115
3679
|
))
|
@@ -3209,7 +3773,9 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
3209
3773
|
---
|
3210
3774
|
`with_disabled`
|
3211
3775
|
```json
|
3212
|
-
{
|
3776
|
+
{
|
3777
|
+
"type": "boolean"
|
3778
|
+
}
|
3213
3779
|
```
|
3214
3780
|
このパラメータを渡すと無効にされた店舗を含めて返されます。デフォルトでは無効にされた店舗は返されません。
|
3215
3781
|
|
@@ -3242,11 +3808,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
3242
3808
|
```ruby
|
3243
3809
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
3244
3810
|
"oxスーパー三田店", # shop_name: 店舗名
|
3245
|
-
shop_postal_code: "
|
3811
|
+
shop_postal_code: "946-7553", # 店舗の郵便番号
|
3246
3812
|
shop_address: "東京都港区芝...", # 店舗の住所
|
3247
|
-
shop_tel: "
|
3248
|
-
shop_email: "
|
3249
|
-
shop_external_id: "
|
3813
|
+
shop_tel: "01918-7038", # 店舗の電話番号
|
3814
|
+
shop_email: "JaXsPvnXy7@JLPW.com", # 店舗のメールアドレス
|
3815
|
+
shop_external_id: "4POJKIKUBKfvAdAdVhR8q", # 店舗の外部ID
|
3250
3816
|
organization_code: "ox-supermarket" # 組織コード
|
3251
3817
|
))
|
3252
3818
|
```
|
@@ -3256,14 +3822,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
3256
3822
|
```ruby
|
3257
3823
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
3258
3824
|
"oxスーパー三田店", # name: 店舗名
|
3259
|
-
postal_code: "
|
3825
|
+
postal_code: "670-5440", # 店舗の郵便番号
|
3260
3826
|
address: "東京都港区芝...", # 店舗の住所
|
3261
|
-
tel: "
|
3262
|
-
email: "
|
3263
|
-
external_id: "
|
3827
|
+
tel: "0831214078", # 店舗の電話番号
|
3828
|
+
email: "zOOhzPjoLU@npes.com", # 店舗のメールアドレス
|
3829
|
+
external_id: "4zWmpVcy9ixDX4fCfbAE0A", # 店舗の外部ID
|
3264
3830
|
organization_code: "ox-supermarket", # 組織コード
|
3265
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
3266
|
-
can_topup_private_money_ids: [
|
3831
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
3832
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
3267
3833
|
))
|
3268
3834
|
```
|
3269
3835
|
|
@@ -3334,14 +3900,14 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
3334
3900
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
3335
3901
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
3336
3902
|
name: "oxスーパー三田店", # 店舗名
|
3337
|
-
postal_code: "
|
3903
|
+
postal_code: "804-8661", # 店舗の郵便番号
|
3338
3904
|
address: "東京都港区芝...", # 店舗の住所
|
3339
|
-
tel: "
|
3340
|
-
email: "
|
3341
|
-
external_id: "
|
3342
|
-
private_money_ids: [],
|
3343
|
-
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
3344
|
-
status: "
|
3905
|
+
tel: "01-35872", # 店舗の電話番号
|
3906
|
+
email: "DuJC7DFGXW@J1Ds.com", # 店舗のメールアドレス
|
3907
|
+
external_id: "LyOnXTqwNlXWPSNst44xBM1tMMoOy", # 店舗の外部ID
|
3908
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
3909
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗でチャージ可能にするマネーIDの配列
|
3910
|
+
status: "disabled" # 店舗の状態
|
3345
3911
|
))
|
3346
3912
|
```
|
3347
3913
|
|
@@ -3438,7 +4004,10 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
3438
4004
|
```json
|
3439
4005
|
{
|
3440
4006
|
"type": "string",
|
3441
|
-
"enum":
|
4007
|
+
"enum": [
|
4008
|
+
"active",
|
4009
|
+
"disabled"
|
4010
|
+
]
|
3442
4011
|
}
|
3443
4012
|
```
|
3444
4013
|
店舗の状態です。activeを指定すると有効となり、disabledを指定するとリスト表示から除外されます。
|
@@ -3452,8 +4021,8 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
3452
4021
|
```ruby
|
3453
4022
|
response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
3454
4023
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
3455
|
-
page:
|
3456
|
-
per_page:
|
4024
|
+
page: 4395, # ページ番号
|
4025
|
+
per_page: 5442 # 1ページ分の取引数
|
3457
4026
|
))
|
3458
4027
|
```
|
3459
4028
|
|
@@ -3498,8 +4067,8 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
3498
4067
|
response = $client.send(Pokepay::Request::CreateUserAccount.new(
|
3499
4068
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
3500
4069
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3501
|
-
name: "
|
3502
|
-
external_id: "
|
4070
|
+
name: "qWcD5ADFBSPh7o2MC5sMNAQhF0HCoj9Dj4ZpJqp2buSHK5WKI86hTWo47qb9nSKNBR3LjzCdQo4GwTY7y2Am8ZcyGh3BczuQ1HmAT4U7cCHORIBupKF2LGLWlWRqEU1R3HVfumJrkxA1RBhkJnrKn6T4", # ウォレット名
|
4071
|
+
external_id: "UBYf7XzEp3cMOeoQItbJApNFN", # 外部ID
|
3503
4072
|
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
3504
4073
|
))
|
3505
4074
|
```
|
@@ -3574,8 +4143,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
3574
4143
|
```ruby
|
3575
4144
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
3576
4145
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3577
|
-
from: "
|
3578
|
-
to: "
|
4146
|
+
from: "2020-09-18T02:56:34.000000Z", # 開始日時(toと同時に指定する必要有)
|
4147
|
+
to: "2021-10-07T06:02:17.000000Z", # 終了日時(fromと同時に指定する必要有)
|
3579
4148
|
page: 1, # ページ番号
|
3580
4149
|
per_page: 50 # 1ページ分の取引数
|
3581
4150
|
))
|
@@ -3588,8 +4157,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
3588
4157
|
```ruby
|
3589
4158
|
response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
3590
4159
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3591
|
-
from: "
|
3592
|
-
to: "
|
4160
|
+
from: "2020-01-01T00:02:02.000000Z", # 開始日時
|
4161
|
+
to: "2020-06-08T05:00:33.000000Z" # 終了日時
|
3593
4162
|
))
|
3594
4163
|
```
|
3595
4164
|
成功したときは[PrivateMoneySummary](#private-money-summary)オブジェクトを返します
|
@@ -3599,10 +4168,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
3599
4168
|
CSVファイルから一括取引をします。
|
3600
4169
|
```ruby
|
3601
4170
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
3602
|
-
"
|
3603
|
-
"
|
3604
|
-
"
|
3605
|
-
description: "
|
4171
|
+
"SEKvNBsiLTmRsG1pcvzP", # name: 一括取引タスク名
|
4172
|
+
"SNlMjgy", # content: 取引する情報のCSV
|
4173
|
+
"Cm3l36NNuyyweAXXanZiLS6lbj9JXoVWEOjN", # request_id: リクエストID
|
4174
|
+
description: "WcJ8Pqob8ZB", # 一括取引の説明
|
3606
4175
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # マネーID
|
3607
4176
|
))
|
3608
4177
|
```
|
@@ -3630,7 +4199,9 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
3630
4199
|
---
|
3631
4200
|
`content`
|
3632
4201
|
```json
|
3633
|
-
{
|
4202
|
+
{
|
4203
|
+
"type": "string"
|
4204
|
+
}
|
3634
4205
|
```
|
3635
4206
|
一括取引する情報を書いたCSVの文字列です。
|
3636
4207
|
1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
|
@@ -3690,7 +4261,7 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
3690
4261
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
3691
4262
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
3692
4263
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3693
|
-
|
4264
|
+
129, # amount: 取引額
|
3694
4265
|
description: "たい焼き(小倉)", # 取引説明文
|
3695
4266
|
metadata: "{\"key\":\"value\"}", # ポケペイ外部取引メタデータ
|
3696
4267
|
products: [{"jan_code":"abc",
|
@@ -3698,11 +4269,6 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
3698
4269
|
"unit_price":100,
|
3699
4270
|
"price": 100,
|
3700
4271
|
"is_discounted": false,
|
3701
|
-
"other":"{}"}, {"jan_code":"abc",
|
3702
|
-
"name":"name1",
|
3703
|
-
"unit_price":100,
|
3704
|
-
"price": 100,
|
3705
|
-
"is_discounted": false,
|
3706
4272
|
"other":"{}"}], # 商品情報データ
|
3707
4273
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
3708
4274
|
))
|
@@ -3783,7 +4349,9 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
3783
4349
|
```json
|
3784
4350
|
{
|
3785
4351
|
"type": "array",
|
3786
|
-
"items": {
|
4352
|
+
"items": {
|
4353
|
+
"type": "object"
|
4354
|
+
}
|
3787
4355
|
}
|
3788
4356
|
```
|
3789
4357
|
一つの取引に含まれる商品情報データです。
|
@@ -3811,7 +4379,7 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
3811
4379
|
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
3812
4380
|
|
3813
4381
|
---
|
3814
|
-
成功したときは[
|
4382
|
+
成功したときは[ExternalTransactionDetail](#external-transaction-detail)オブジェクトを返します
|
3815
4383
|
<a name="refund-external-transaction"></a>
|
3816
4384
|
#### ポケペイ外部取引をキャンセルする
|
3817
4385
|
取引IDを指定して取引をキャンセルします。
|
@@ -3826,7 +4394,7 @@ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
|
|
3826
4394
|
description: "返品対応のため" # 取引履歴に表示する返金事由
|
3827
4395
|
))
|
3828
4396
|
```
|
3829
|
-
成功したときは[
|
4397
|
+
成功したときは[ExternalTransactionDetail](#external-transaction-detail)オブジェクトを返します
|
3830
4398
|
### Campaign
|
3831
4399
|
<a name="create-campaign"></a>
|
3832
4400
|
#### ポイント付与キャンペーンを作る
|
@@ -3834,18 +4402,18 @@ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
|
|
3834
4402
|
|
3835
4403
|
```ruby
|
3836
4404
|
response = $client.send(Pokepay::Request::CreateCampaign.new(
|
3837
|
-
"
|
4405
|
+
"c2LIkAJFpX3tMiPvkskrBs7cZNQht6pUXt6QkeG9pRp1c5EcN6nLJcb0NEcuMnzKSDbJD", # name: キャンペーン名
|
3838
4406
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
3839
|
-
"
|
3840
|
-
"
|
3841
|
-
|
4407
|
+
"2020-05-30T05:04:19.000000Z", # starts_at: キャンペーン開始日時
|
4408
|
+
"2022-08-14T15:51:01.000000Z", # ends_at: キャンペーン終了日時
|
4409
|
+
843, # priority: キャンペーンの適用優先度
|
3842
4410
|
"external-transaction", # event: イベント種別
|
3843
4411
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント負担先店舗ID
|
3844
|
-
description: "
|
3845
|
-
status: "
|
3846
|
-
point_expires_at: "
|
3847
|
-
point_expires_in_days:
|
3848
|
-
is_exclusive:
|
4412
|
+
description: "yRniwPaN0afN8mRVY0r2kLaYAQQnNWq5gJk8ucSDE2uEYUD0C3IXLL4lH8T3KxBkSfET7NeTYdPy8UjYc9OlslQQZIq7zSOEeSzczj6ObIBdQwmJP2q6udBME6WRlyybO27figMsVR", # キャンペーンの説明文
|
4413
|
+
status: "enabled", # キャンペーン作成時の状態
|
4414
|
+
point_expires_at: "2022-11-20T05:16:21.000000Z", # ポイント有効期限(絶対日時指定)
|
4415
|
+
point_expires_in_days: 4544, # ポイント有効期限(相対日数指定)
|
4416
|
+
is_exclusive: true, # キャンペーンの重複設定
|
3849
4417
|
subject: "all", # ポイント付与の対象金額の種別
|
3850
4418
|
amount_based_point_rules: [{
|
3851
4419
|
"point_amount": 5,
|
@@ -3860,21 +4428,25 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3860
4428
|
"is_multiply_by_count": true,
|
3861
4429
|
"required_count": 2
|
3862
4430
|
}], # 商品情報ベースのポイント付与ルール
|
3863
|
-
applicable_days_of_week: [
|
4431
|
+
applicable_days_of_week: [5, 6, 4], # キャンペーンを適用する曜日 (複数指定)
|
3864
4432
|
applicable_time_ranges: [{
|
3865
4433
|
"from": "12:00",
|
3866
4434
|
"to": "23:59"
|
4435
|
+
}, {
|
4436
|
+
"from": "12:00",
|
4437
|
+
"to": "23:59"
|
3867
4438
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
3868
4439
|
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:
|
4440
|
+
minimum_number_for_combination_purchase: 6166, # 複数種類の商品を同時購入するときの商品種別数の下限
|
3870
4441
|
exist_in_each_product_groups: true, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
3871
|
-
max_point_amount:
|
3872
|
-
max_total_point_amount:
|
4442
|
+
max_point_amount: 134, # キャンペーンによって付与されるポイントの上限
|
4443
|
+
max_total_point_amount: 9447, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
3873
4444
|
dest_private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント付与先となるマネーID
|
3874
4445
|
applicable_account_metadata: {
|
3875
4446
|
"key": "sex",
|
3876
4447
|
"value": "male"
|
3877
|
-
}
|
4448
|
+
}, # ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
4449
|
+
budget_caps_amount: 422935798 # キャンペーン予算上限
|
3878
4450
|
))
|
3879
4451
|
```
|
3880
4452
|
|
@@ -3927,7 +4499,9 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3927
4499
|
---
|
3928
4500
|
`priority`
|
3929
4501
|
```json
|
3930
|
-
{
|
4502
|
+
{
|
4503
|
+
"type": "integer"
|
4504
|
+
}
|
3931
4505
|
```
|
3932
4506
|
キャンペーンの適用優先度です。
|
3933
4507
|
|
@@ -3939,7 +4513,11 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3939
4513
|
```json
|
3940
4514
|
{
|
3941
4515
|
"type": "string",
|
3942
|
-
"enum": [
|
4516
|
+
"enum": [
|
4517
|
+
"topup",
|
4518
|
+
"payment",
|
4519
|
+
"external-transaction"
|
4520
|
+
]
|
3943
4521
|
}
|
3944
4522
|
```
|
3945
4523
|
キャンペーンのトリガーとなるイベントの種類を指定します(必須項目)。
|
@@ -3979,7 +4557,10 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3979
4557
|
```json
|
3980
4558
|
{
|
3981
4559
|
"type": "string",
|
3982
|
-
"enum":
|
4560
|
+
"enum": [
|
4561
|
+
"enabled",
|
4562
|
+
"disabled"
|
4563
|
+
]
|
3983
4564
|
}
|
3984
4565
|
```
|
3985
4566
|
キャンペーン作成時の状態を指定します。デフォルトではenabledです。
|
@@ -4016,7 +4597,9 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
4016
4597
|
---
|
4017
4598
|
`is_exclusive`
|
4018
4599
|
```json
|
4019
|
-
{
|
4600
|
+
{
|
4601
|
+
"type": "boolean"
|
4602
|
+
}
|
4020
4603
|
```
|
4021
4604
|
キャンペーンの重ね掛けを行うかどうかのフラグです。
|
4022
4605
|
|
@@ -4028,7 +4611,10 @@ falseを指定すると次の優先度の重ね掛け可能なキャンペーン
|
|
4028
4611
|
```json
|
4029
4612
|
{
|
4030
4613
|
"type": "string",
|
4031
|
-
"enum":
|
4614
|
+
"enum": [
|
4615
|
+
"money",
|
4616
|
+
"all"
|
4617
|
+
]
|
4032
4618
|
}
|
4033
4619
|
```
|
4034
4620
|
ポイント付与額を計算する対象となる金額の種類を指定します。デフォルト値はallです。
|
@@ -4048,7 +4634,9 @@ all を指定すると決済額全体を対象にします (「ポイント」
|
|
4048
4634
|
```json
|
4049
4635
|
{
|
4050
4636
|
"type": "array",
|
4051
|
-
"items": {
|
4637
|
+
"items": {
|
4638
|
+
"type": "object"
|
4639
|
+
}
|
4052
4640
|
}
|
4053
4641
|
```
|
4054
4642
|
金額をベースとしてポイント付与を行うルールを指定します。
|
@@ -4079,7 +4667,9 @@ amount_based_point_rules と product_based_point_rules はどちらか一方し
|
|
4079
4667
|
```json
|
4080
4668
|
{
|
4081
4669
|
"type": "array",
|
4082
|
-
"items": {
|
4670
|
+
"items": {
|
4671
|
+
"type": "object"
|
4672
|
+
}
|
4083
4673
|
}
|
4084
4674
|
```
|
4085
4675
|
商品情報をベースとしてポイント付与を行うルールを指定します。
|
@@ -4211,7 +4801,9 @@ event が payment か external-transaction の時のみ有効です。
|
|
4211
4801
|
---
|
4212
4802
|
`exist_in_each_product_groups`
|
4213
4803
|
```json
|
4214
|
-
{
|
4804
|
+
{
|
4805
|
+
"type": "boolean"
|
4806
|
+
}
|
4215
4807
|
```
|
4216
4808
|
複数の商品グループの各グループにつき1種類以上の商品が購入されることによって発火するキャンペーンであるときに真を指定します。デフォルトは偽です。
|
4217
4809
|
|
@@ -4339,7 +4931,9 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
4339
4931
|
---
|
4340
4932
|
`applicable_account_metadata`
|
4341
4933
|
```json
|
4342
|
-
{
|
4934
|
+
{
|
4935
|
+
"type": "object"
|
4936
|
+
}
|
4343
4937
|
```
|
4344
4938
|
ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
4345
4939
|
メタデータの属性名 key とメタデータの値 value の組をオブジェクトとして指定します。
|
@@ -4367,6 +4961,20 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
4367
4961
|
}
|
4368
4962
|
```
|
4369
4963
|
|
4964
|
+
---
|
4965
|
+
`budget_caps_amount`
|
4966
|
+
```json
|
4967
|
+
{
|
4968
|
+
"type": "integer",
|
4969
|
+
"minimum": 1,
|
4970
|
+
"maximum": 10000000000
|
4971
|
+
}
|
4972
|
+
```
|
4973
|
+
キャンペーンの予算上限を指定します。デフォルトは未指定です。
|
4974
|
+
|
4975
|
+
このパラメータが指定されている場合、このキャンペーンの適用により付与されたポイント全体を定期的に集計し、その合計が上限を越えていた場合にはキャンペーンを無効にします。
|
4976
|
+
一度この値を越えて無効となったキャンペーンを再度有効にすることは出来ません。
|
4977
|
+
|
4370
4978
|
---
|
4371
4979
|
成功したときは[Campaign](#campaign)オブジェクトを返します
|
4372
4980
|
<a name="list-campaigns"></a>
|
@@ -4377,9 +4985,9 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
4377
4985
|
```ruby
|
4378
4986
|
response = $client.send(Pokepay::Request::ListCampaigns.new(
|
4379
4987
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
4380
|
-
is_ongoing:
|
4381
|
-
available_from: "
|
4382
|
-
available_to: "
|
4988
|
+
is_ongoing: false, # 現在適用可能なキャンペーンかどうか
|
4989
|
+
available_from: "2022-01-01T10:00:15.000000Z", # 指定された日時以降に適用可能期間が含まれているか
|
4990
|
+
available_to: "2020-05-31T11:36:43.000000Z", # 指定された日時以前に適用可能期間が含まれているか
|
4383
4991
|
page: 1, # ページ番号
|
4384
4992
|
per_page: 20 # 1ページ分の取得数
|
4385
4993
|
))
|
@@ -4400,7 +5008,9 @@ response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
4400
5008
|
---
|
4401
5009
|
`is_ongoing`
|
4402
5010
|
```json
|
4403
|
-
{
|
5011
|
+
{
|
5012
|
+
"type": "boolean"
|
5013
|
+
}
|
4404
5014
|
```
|
4405
5015
|
有効化されており、現在キャンペーン期間内にあるキャンペーンをフィルターするために使われます。
|
4406
5016
|
真であれば適用可能なもののみを抽出し、偽であれば適用不可なもののみを抽出します。
|
@@ -4483,15 +5093,15 @@ response = $client.send(Pokepay::Request::GetCampaign.new(
|
|
4483
5093
|
```ruby
|
4484
5094
|
response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
4485
5095
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # campaign_id: キャンペーンID
|
4486
|
-
name: "
|
4487
|
-
starts_at: "
|
4488
|
-
ends_at: "
|
4489
|
-
priority:
|
4490
|
-
event: "
|
4491
|
-
description: "
|
4492
|
-
status: "
|
4493
|
-
point_expires_at: "
|
4494
|
-
point_expires_in_days:
|
5096
|
+
name: "byfcjYNDVx4A2ovqPMZA8irXJ9E6ZcMzkLyAqgwSoddiujWTgn11mpxaVIYgQo5GvBiHKw3I5f57jFE45d3P21Pzx2jnlKrw0LdNS", # キャンペーン名
|
5097
|
+
starts_at: "2020-05-12T19:19:16.000000Z", # キャンペーン開始日時
|
5098
|
+
ends_at: "2022-06-26T17:10:33.000000Z", # キャンペーン終了日時
|
5099
|
+
priority: 8101, # キャンペーンの適用優先度
|
5100
|
+
event: "topup", # イベント種別
|
5101
|
+
description: "tkXCDrt0LJOE3QgwrCcszhfH09Y5OthVwPmvHXBFS5mnHJDaN7ByqCBViT8YJSc5gafw5E7JxTvjUc1aT5EbGpCQn8B7l65BYMvNkhEwbRq7C0zj85JoEScisdzkhxnXFFT7CX", # キャンペーンの説明文
|
5102
|
+
status: "disabled", # キャンペーン作成時の状態
|
5103
|
+
point_expires_at: "2024-01-25T19:14:44.000000Z", # ポイント有効期限(絶対日時指定)
|
5104
|
+
point_expires_in_days: 7438, # ポイント有効期限(相対日数指定)
|
4495
5105
|
is_exclusive: false, # キャンペーンの重複設定
|
4496
5106
|
subject: "money", # ポイント付与の対象金額の種別
|
4497
5107
|
amount_based_point_rules: [{
|
@@ -4499,25 +5109,27 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4499
5109
|
"point_amount_unit": "percent",
|
4500
5110
|
"subject_more_than_or_equal": 1000,
|
4501
5111
|
"subject_less_than": 5000
|
4502
|
-
},
|
5112
|
+
}], # 取引金額ベースのポイント付与ルール
|
5113
|
+
product_based_point_rules: [{
|
4503
5114
|
"point_amount": 5,
|
4504
5115
|
"point_amount_unit": "percent",
|
4505
|
-
"
|
4506
|
-
"
|
5116
|
+
"product_code": "4912345678904",
|
5117
|
+
"is_multiply_by_count": true,
|
5118
|
+
"required_count": 2
|
4507
5119
|
}, {
|
4508
5120
|
"point_amount": 5,
|
4509
5121
|
"point_amount_unit": "percent",
|
4510
|
-
"
|
4511
|
-
"
|
4512
|
-
|
4513
|
-
|
5122
|
+
"product_code": "4912345678904",
|
5123
|
+
"is_multiply_by_count": true,
|
5124
|
+
"required_count": 2
|
5125
|
+
}, {
|
4514
5126
|
"point_amount": 5,
|
4515
5127
|
"point_amount_unit": "percent",
|
4516
5128
|
"product_code": "4912345678904",
|
4517
5129
|
"is_multiply_by_count": true,
|
4518
5130
|
"required_count": 2
|
4519
5131
|
}], # 商品情報ベースのポイント付与ルール
|
4520
|
-
applicable_days_of_week: [
|
5132
|
+
applicable_days_of_week: [1, 6], # キャンペーンを適用する曜日 (複数指定)
|
4521
5133
|
applicable_time_ranges: [{
|
4522
5134
|
"from": "12:00",
|
4523
5135
|
"to": "23:59"
|
@@ -4529,14 +5141,15 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4529
5141
|
"to": "23:59"
|
4530
5142
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
4531
5143
|
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
4532
|
-
minimum_number_for_combination_purchase:
|
5144
|
+
minimum_number_for_combination_purchase: 2003, # 複数種類の商品を同時購入するときの商品種別数の下限
|
4533
5145
|
exist_in_each_product_groups: false, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
4534
|
-
max_point_amount:
|
4535
|
-
max_total_point_amount:
|
5146
|
+
max_point_amount: 7120, # キャンペーンによって付与されるポイントの上限
|
5147
|
+
max_total_point_amount: 30, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
4536
5148
|
applicable_account_metadata: {
|
4537
5149
|
"key": "sex",
|
4538
5150
|
"value": "male"
|
4539
|
-
}
|
5151
|
+
}, # ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
5152
|
+
budget_caps_amount: 306881955 # キャンペーン予算上限
|
4540
5153
|
))
|
4541
5154
|
```
|
4542
5155
|
|
@@ -4591,7 +5204,9 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4591
5204
|
---
|
4592
5205
|
`priority`
|
4593
5206
|
```json
|
4594
|
-
{
|
5207
|
+
{
|
5208
|
+
"type": "integer"
|
5209
|
+
}
|
4595
5210
|
```
|
4596
5211
|
キャンペーンの適用優先度です。
|
4597
5212
|
|
@@ -4603,7 +5218,11 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4603
5218
|
```json
|
4604
5219
|
{
|
4605
5220
|
"type": "string",
|
4606
|
-
"enum": [
|
5221
|
+
"enum": [
|
5222
|
+
"topup",
|
5223
|
+
"payment",
|
5224
|
+
"external-transaction"
|
5225
|
+
]
|
4607
5226
|
}
|
4608
5227
|
```
|
4609
5228
|
キャンペーンのトリガーとなるイベントの種類を指定します。
|
@@ -4632,7 +5251,10 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4632
5251
|
```json
|
4633
5252
|
{
|
4634
5253
|
"type": "string",
|
4635
|
-
"enum":
|
5254
|
+
"enum": [
|
5255
|
+
"enabled",
|
5256
|
+
"disabled"
|
5257
|
+
]
|
4636
5258
|
}
|
4637
5259
|
```
|
4638
5260
|
キャンペーン作成時の状態を指定します。デフォルトではenabledです。
|
@@ -4669,7 +5291,9 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
4669
5291
|
---
|
4670
5292
|
`is_exclusive`
|
4671
5293
|
```json
|
4672
|
-
{
|
5294
|
+
{
|
5295
|
+
"type": "boolean"
|
5296
|
+
}
|
4673
5297
|
```
|
4674
5298
|
キャンペーンの重ね掛けを行うかどうかのフラグです。
|
4675
5299
|
|
@@ -4681,7 +5305,10 @@ falseを指定すると次の優先度の重ね掛け可能なキャンペーン
|
|
4681
5305
|
```json
|
4682
5306
|
{
|
4683
5307
|
"type": "string",
|
4684
|
-
"enum":
|
5308
|
+
"enum": [
|
5309
|
+
"money",
|
5310
|
+
"all"
|
5311
|
+
]
|
4685
5312
|
}
|
4686
5313
|
```
|
4687
5314
|
ポイント付与額を計算する対象となる金額の種類を指定します。デフォルト値はallです。
|
@@ -4701,7 +5328,9 @@ all を指定すると決済額全体を対象にします (「ポイント」
|
|
4701
5328
|
```json
|
4702
5329
|
{
|
4703
5330
|
"type": "array",
|
4704
|
-
"items": {
|
5331
|
+
"items": {
|
5332
|
+
"type": "object"
|
5333
|
+
}
|
4705
5334
|
}
|
4706
5335
|
```
|
4707
5336
|
金額をベースとしてポイント付与を行うルールを指定します。
|
@@ -4732,7 +5361,9 @@ amount_based_point_rules と product_based_point_rules はどちらか一方し
|
|
4732
5361
|
```json
|
4733
5362
|
{
|
4734
5363
|
"type": "array",
|
4735
|
-
"items": {
|
5364
|
+
"items": {
|
5365
|
+
"type": "object"
|
5366
|
+
}
|
4736
5367
|
}
|
4737
5368
|
```
|
4738
5369
|
商品情報をベースとしてポイント付与を行うルールを指定します。
|
@@ -4864,7 +5495,9 @@ event が payment か external-transaction の時のみ有効です。
|
|
4864
5495
|
---
|
4865
5496
|
`exist_in_each_product_groups`
|
4866
5497
|
```json
|
4867
|
-
{
|
5498
|
+
{
|
5499
|
+
"type": "boolean"
|
5500
|
+
}
|
4868
5501
|
```
|
4869
5502
|
複数の商品グループの各グループにつき1種類以上の商品が購入されることによって発火するキャンペーンであるときに真を指定します。デフォルトは偽です。
|
4870
5503
|
|
@@ -4974,7 +5607,9 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
4974
5607
|
---
|
4975
5608
|
`applicable_account_metadata`
|
4976
5609
|
```json
|
4977
|
-
{
|
5610
|
+
{
|
5611
|
+
"type": "object"
|
5612
|
+
}
|
4978
5613
|
```
|
4979
5614
|
ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
4980
5615
|
メタデータの属性名 key とメタデータの値 value の組をオブジェクトとして指定します。
|
@@ -5002,6 +5637,22 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|
|
5002
5637
|
}
|
5003
5638
|
```
|
5004
5639
|
|
5640
|
+
---
|
5641
|
+
`budget_caps_amount`
|
5642
|
+
```json
|
5643
|
+
{
|
5644
|
+
"type": "integer",
|
5645
|
+
"minimum": 1,
|
5646
|
+
"maximum": 10000000000
|
5647
|
+
}
|
5648
|
+
```
|
5649
|
+
キャンペーンの予算上限を指定します。
|
5650
|
+
|
5651
|
+
キャンペーン予算上限が設定されておらずこのパラメータに数値が指定されている場合、このキャンペーンの適用により付与されたポイント全体を定期的に集計し、その合計が上限を越えていた場合にはキャンペーンを無効にします。
|
5652
|
+
一度この値を越えて無効となったキャンペーンを再度有効にすることは出来ません。
|
5653
|
+
キャンペーン予算上限が設定されておらずこのパラメータにnullが指定されている場合、何も発生しない。
|
5654
|
+
キャンペーン予算上限が設定されておりこのパラメータにnullが指定された場合、キャンペーン予算上限は止まります。
|
5655
|
+
|
5005
5656
|
---
|
5006
5657
|
成功したときは[Campaign](#campaign)オブジェクトを返します
|
5007
5658
|
### Webhook
|
@@ -5017,7 +5668,7 @@ WebHookにはURLとタスク名、有効化されているかを設定するこ
|
|
5017
5668
|
```ruby
|
5018
5669
|
response = $client.send(Pokepay::Request::CreateWebhook.new(
|
5019
5670
|
"process_user_stats_operation", # task: タスク名
|
5020
|
-
"
|
5671
|
+
"PFa" # url: URL
|
5021
5672
|
))
|
5022
5673
|
```
|
5023
5674
|
|
@@ -5026,7 +5677,10 @@ response = $client.send(Pokepay::Request::CreateWebhook.new(
|
|
5026
5677
|
```json
|
5027
5678
|
{
|
5028
5679
|
"type": "string",
|
5029
|
-
"enum":
|
5680
|
+
"enum": [
|
5681
|
+
"bulk_shops",
|
5682
|
+
"process_user_stats_operation"
|
5683
|
+
]
|
5030
5684
|
}
|
5031
5685
|
```
|
5032
5686
|
ワーカータスク名を指定します
|
@@ -5034,7 +5688,9 @@ response = $client.send(Pokepay::Request::CreateWebhook.new(
|
|
5034
5688
|
---
|
5035
5689
|
`url`
|
5036
5690
|
```json
|
5037
|
-
{
|
5691
|
+
{
|
5692
|
+
"type": "string"
|
5693
|
+
}
|
5038
5694
|
```
|
5039
5695
|
通知先のURLを指定します
|
5040
5696
|
|
@@ -5077,7 +5733,7 @@ response = $client.send(Pokepay::Request::ListWebhooks.new(
|
|
5077
5733
|
```ruby
|
5078
5734
|
response = $client.send(Pokepay::Request::UpdateWebhook.new(
|
5079
5735
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # webhook_id: Webhook ID
|
5080
|
-
url: "
|
5736
|
+
url: "2Q0QZF", # URL
|
5081
5737
|
is_active: true, # 有効/無効
|
5082
5738
|
task: "bulk_shops" # タスク名
|
5083
5739
|
))
|
@@ -5096,14 +5752,18 @@ response = $client.send(Pokepay::Request::UpdateWebhook.new(
|
|
5096
5752
|
---
|
5097
5753
|
`url`
|
5098
5754
|
```json
|
5099
|
-
{
|
5755
|
+
{
|
5756
|
+
"type": "string"
|
5757
|
+
}
|
5100
5758
|
```
|
5101
5759
|
変更するURLを指定します
|
5102
5760
|
|
5103
5761
|
---
|
5104
5762
|
`is_active`
|
5105
5763
|
```json
|
5106
|
-
{
|
5764
|
+
{
|
5765
|
+
"type": "boolean"
|
5766
|
+
}
|
5107
5767
|
```
|
5108
5768
|
trueならWebhookによる通知が有効になり、falseなら無効になります
|
5109
5769
|
|
@@ -5112,26 +5772,53 @@ trueならWebhookによる通知が有効になり、falseなら無効になり
|
|
5112
5772
|
```json
|
5113
5773
|
{
|
5114
5774
|
"type": "string",
|
5115
|
-
"enum":
|
5775
|
+
"enum": [
|
5776
|
+
"bulk_shops",
|
5777
|
+
"process_user_stats_operation"
|
5778
|
+
]
|
5116
5779
|
}
|
5117
5780
|
```
|
5118
5781
|
指定したタスクが終了したときにWebhookによる通知がされます
|
5119
5782
|
|
5783
|
+
---
|
5784
|
+
成功したときは[OrganizationWorkerTaskWebhook](#organization-worker-task-webhook)オブジェクトを返します
|
5785
|
+
<a name="delete-webhook"></a>
|
5786
|
+
#### Webhookの削除
|
5787
|
+
指定したWebhookを削除します
|
5788
|
+
```ruby
|
5789
|
+
response = $client.send(Pokepay::Request::DeleteWebhook.new(
|
5790
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # webhook_id: Webhook ID
|
5791
|
+
))
|
5792
|
+
```
|
5793
|
+
|
5794
|
+
---
|
5795
|
+
`webhook_id`
|
5796
|
+
```json
|
5797
|
+
{
|
5798
|
+
"type": "string",
|
5799
|
+
"format": "uuid"
|
5800
|
+
}
|
5801
|
+
```
|
5802
|
+
削除するWebhookのIDです。
|
5803
|
+
|
5120
5804
|
---
|
5121
5805
|
成功したときは[OrganizationWorkerTaskWebhook](#organization-worker-task-webhook)オブジェクトを返します
|
5122
5806
|
### Coupon
|
5807
|
+
Couponは支払い時に指定し、支払い処理の前にCouponに指定の方法で値引き処理を行います。
|
5808
|
+
Couponは特定店舗で利用できるものや利用可能期間、配信条件などを設定できます。
|
5809
|
+
|
5123
5810
|
<a name="list-coupons"></a>
|
5124
5811
|
#### クーポン一覧の取得
|
5125
5812
|
指定したマネーのクーポン一覧を取得します
|
5126
5813
|
```ruby
|
5127
5814
|
response = $client.send(Pokepay::Request::ListCoupons.new(
|
5128
5815
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 対象クーポンのマネーID
|
5129
|
-
coupon_id: "
|
5130
|
-
coupon_name: "
|
5131
|
-
issued_shop_name: "
|
5132
|
-
available_shop_name: "
|
5133
|
-
available_from: "
|
5134
|
-
available_to: "
|
5816
|
+
coupon_id: "PWcwwu3uh", # クーポンID
|
5817
|
+
coupon_name: "9f", # クーポン名
|
5818
|
+
issued_shop_name: "L3S3N", # 発行店舗名
|
5819
|
+
available_shop_name: "vBIxMXxVO", # 利用可能店舗名
|
5820
|
+
available_from: "2020-12-04T01:56:35.000000Z", # 利用可能期間 (開始日時)
|
5821
|
+
available_to: "2022-10-18T15:11:52.000000Z", # 利用可能期間 (終了日時)
|
5135
5822
|
page: 1, # ページ番号
|
5136
5823
|
per_page: 50 # 1ページ分の取得数
|
5137
5824
|
))
|
@@ -5152,7 +5839,9 @@ response = $client.send(Pokepay::Request::ListCoupons.new(
|
|
5152
5839
|
---
|
5153
5840
|
`coupon_id`
|
5154
5841
|
```json
|
5155
|
-
{
|
5842
|
+
{
|
5843
|
+
"type": "string"
|
5844
|
+
}
|
5156
5845
|
```
|
5157
5846
|
指定されたクーポンIDで結果をフィルターします。
|
5158
5847
|
部分一致(前方一致)します。
|
@@ -5161,7 +5850,9 @@ response = $client.send(Pokepay::Request::ListCoupons.new(
|
|
5161
5850
|
---
|
5162
5851
|
`coupon_name`
|
5163
5852
|
```json
|
5164
|
-
{
|
5853
|
+
{
|
5854
|
+
"type": "string"
|
5855
|
+
}
|
5165
5856
|
```
|
5166
5857
|
指定されたクーポン名で結果をフィルターします。
|
5167
5858
|
|
@@ -5169,7 +5860,9 @@ response = $client.send(Pokepay::Request::ListCoupons.new(
|
|
5169
5860
|
---
|
5170
5861
|
`issued_shop_name`
|
5171
5862
|
```json
|
5172
|
-
{
|
5863
|
+
{
|
5864
|
+
"type": "string"
|
5865
|
+
}
|
5173
5866
|
```
|
5174
5867
|
指定された発行店舗で結果をフィルターします。
|
5175
5868
|
|
@@ -5177,7 +5870,9 @@ response = $client.send(Pokepay::Request::ListCoupons.new(
|
|
5177
5870
|
---
|
5178
5871
|
`available_shop_name`
|
5179
5872
|
```json
|
5180
|
-
{
|
5873
|
+
{
|
5874
|
+
"type": "string"
|
5875
|
+
}
|
5181
5876
|
```
|
5182
5877
|
指定された利用可能店舗で結果をフィルターします。
|
5183
5878
|
|
@@ -5226,6 +5921,59 @@ response = $client.send(Pokepay::Request::ListCoupons.new(
|
|
5226
5921
|
|
5227
5922
|
---
|
5228
5923
|
成功したときは[PaginatedCoupons](#paginated-coupons)オブジェクトを返します
|
5924
|
+
<a name="create-coupon"></a>
|
5925
|
+
#### クーポンの登録
|
5926
|
+
新しいクーポンを登録します
|
5927
|
+
```ruby
|
5928
|
+
response = $client.send(Pokepay::Request::CreateCoupon.new(
|
5929
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
5930
|
+
"VOpiS1EeKe2EnvF9kW30yXFj5pEZQNOtIwcrR2Tap7tnXzfq7vVXcZZXkAjYTEO65NQtFJaRQvj5yyqZjpM3EGDvxc2vHpfKAF",
|
5931
|
+
"2023-12-27T02:00:10.000000Z",
|
5932
|
+
"2020-12-24T15:11:19.000000Z",
|
5933
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # issued_shop_id: 発行元の店舗ID
|
5934
|
+
description: "MK87o5EDfCnjGchqfzXJGnbGhZsKdVrETxLEt4GFvxAKZGN2hkrp4AuDVFN5fAvBVJFsjezB3YP3w02SjMN6p0E72qWtOk3QUVbESEWPtcFyu37VMAkI2ylOPtFPfUfw5cNQlmY98v9Ekah2FpsKs0KWXhqcS1Ua3AE",
|
5935
|
+
discount_amount: 7493,
|
5936
|
+
discount_percentage: 1817.0,
|
5937
|
+
discount_upper_limit: 6246,
|
5938
|
+
display_starts_at: "2023-12-14T13:09:00.000000Z", # クーポンの掲載期間(開始日時)
|
5939
|
+
display_ends_at: "2020-10-11T12:17:29.000000Z", # クーポンの掲載期間(終了日時)
|
5940
|
+
is_disabled: true, # 無効化フラグ
|
5941
|
+
is_hidden: false, # クーポン一覧に掲載されるかどうか
|
5942
|
+
is_public: false, # アプリ配信なしで受け取れるかどうか
|
5943
|
+
code: "Coy2", # クーポン受け取りコード
|
5944
|
+
usage_limit: 2811, # ユーザごとの利用可能回数(NULLの場合は無制限)
|
5945
|
+
min_amount: 8036, # クーポン適用可能な最小取引額
|
5946
|
+
is_shop_specified: false, # 特定店舗限定のクーポンかどうか
|
5947
|
+
available_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 利用可能店舗リスト
|
5948
|
+
storage_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ストレージID
|
5949
|
+
))
|
5950
|
+
```
|
5951
|
+
`is_shop_specified`と`available_shop_ids`は同時に指定する必要があります。
|
5952
|
+
|
5953
|
+
|
5954
|
+
---
|
5955
|
+
`is_hidden`
|
5956
|
+
```json
|
5957
|
+
{
|
5958
|
+
"type": "boolean"
|
5959
|
+
}
|
5960
|
+
```
|
5961
|
+
アプリに表示されるクーポン一覧に掲載されるかどうか。
|
5962
|
+
主に一時的に掲載から外したいときに用いられる。そのためis_publicの設定よりも優先される。
|
5963
|
+
|
5964
|
+
|
5965
|
+
---
|
5966
|
+
`storage_id`
|
5967
|
+
```json
|
5968
|
+
{
|
5969
|
+
"type": "string",
|
5970
|
+
"format": "uuid"
|
5971
|
+
}
|
5972
|
+
```
|
5973
|
+
Storage APIでアップロードしたクーポン画像のStorage IDを指定します
|
5974
|
+
|
5975
|
+
---
|
5976
|
+
成功したときは[CouponDetail](#coupon-detail)オブジェクトを返します
|
5229
5977
|
<a name="get-coupon"></a>
|
5230
5978
|
#### クーポンの取得
|
5231
5979
|
指定したIDを持つクーポンを取得します
|
@@ -5236,7 +5984,7 @@ response = $client.send(Pokepay::Request::GetCoupon.new(
|
|
5236
5984
|
```
|
5237
5985
|
|
5238
5986
|
---
|
5239
|
-
`
|
5987
|
+
`coupon_id`
|
5240
5988
|
```json
|
5241
5989
|
{
|
5242
5990
|
"type": "string",
|
@@ -5249,6 +5997,150 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5249
5997
|
|
5250
5998
|
---
|
5251
5999
|
成功したときは[CouponDetail](#coupon-detail)オブジェクトを返します
|
6000
|
+
<a name="update-coupon"></a>
|
6001
|
+
#### クーポンの更新
|
6002
|
+
指定したクーポンを更新します
|
6003
|
+
```ruby
|
6004
|
+
response = $client.send(Pokepay::Request::UpdateCoupon.new(
|
6005
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # coupon_id: クーポンID
|
6006
|
+
name: "tWk5Skp4k9FjiQcyxviUOicaOZqLE3MkcTFrJK4NHPvl4VhqOdqyKHcIOPhbvogj2mEAT9kQkxX80ARofdpsoiXVeBxFuF7c05YcbHgR",
|
6007
|
+
description: "SFdYgsuZbSsGmFYxkuLrQMChiww3RYCIbC9pf8Wzgm4choir96Zk4wBbHbRE9tWUhNPatHCNYgstx4oloda7k12vM37GlbZJKSAFS4eQAmyXqltVLiYXrByWE1iViSMuTkME7Xo3gZLzoJUOW0EXfGSkB9sMClBaFjZtZBNIprWMfHv0Adc0",
|
6008
|
+
discount_amount: 9517,
|
6009
|
+
discount_percentage: 7738.0,
|
6010
|
+
discount_upper_limit: 2558,
|
6011
|
+
starts_at: "2020-06-21T15:37:39.000000Z",
|
6012
|
+
ends_at: "2021-11-26T03:58:42.000000Z",
|
6013
|
+
display_starts_at: "2022-11-02T16:38:43.000000Z", # クーポンの掲載期間(開始日時)
|
6014
|
+
display_ends_at: "2023-02-18T02:15:15.000000Z", # クーポンの掲載期間(終了日時)
|
6015
|
+
is_disabled: false, # 無効化フラグ
|
6016
|
+
is_hidden: false, # クーポン一覧に掲載されるかどうか
|
6017
|
+
is_public: false, # アプリ配信なしで受け取れるかどうか
|
6018
|
+
code: "JKZKHW", # クーポン受け取りコード
|
6019
|
+
usage_limit: 4047, # ユーザごとの利用可能回数(NULLの場合は無制限)
|
6020
|
+
min_amount: 7303, # クーポン適用可能な最小取引額
|
6021
|
+
is_shop_specified: false, # 特定店舗限定のクーポンかどうか
|
6022
|
+
available_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 利用可能店舗リスト
|
6023
|
+
storage_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ストレージID
|
6024
|
+
))
|
6025
|
+
```
|
6026
|
+
`discount_amount`と`discount_percentage`の少なくとも一方は指定する必要があります。
|
6027
|
+
|
6028
|
+
|
6029
|
+
---
|
6030
|
+
`is_hidden`
|
6031
|
+
```json
|
6032
|
+
{
|
6033
|
+
"type": "boolean"
|
6034
|
+
}
|
6035
|
+
```
|
6036
|
+
アプリに表示されるクーポン一覧に掲載されるかどうか。
|
6037
|
+
主に一時的に掲載から外したいときに用いられる。そのためis_publicの設定よりも優先される。
|
6038
|
+
|
6039
|
+
|
6040
|
+
---
|
6041
|
+
`storage_id`
|
6042
|
+
```json
|
6043
|
+
{
|
6044
|
+
"type": "string",
|
6045
|
+
"format": "uuid"
|
6046
|
+
}
|
6047
|
+
```
|
6048
|
+
Storage APIでアップロードしたクーポン画像のStorage IDを指定します
|
6049
|
+
|
6050
|
+
---
|
6051
|
+
成功したときは[CouponDetail](#coupon-detail)オブジェクトを返します
|
6052
|
+
### UserDevice
|
6053
|
+
UserDeviceはユーザー毎のデバイスを管理します。
|
6054
|
+
あるユーザーが使っている端末を区別する必要がある場合に用いられます。
|
6055
|
+
これが必要な理由はBank Payを用いたチャージを行う場合は端末を区別できることが要件としてあるためです。
|
6056
|
+
|
6057
|
+
<a name="create-user-device"></a>
|
6058
|
+
#### ユーザーのデバイス登録
|
6059
|
+
ユーザーのデバイスを新規に登録します
|
6060
|
+
```ruby
|
6061
|
+
response = $client.send(Pokepay::Request::CreateUserDevice.new(
|
6062
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
6063
|
+
metadata: "{\"user_agent\": \"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:120.0) Gecko/20100101 Firefox/120.0\"}" # ユーザーデバイスのメタデータ
|
6064
|
+
))
|
6065
|
+
```
|
6066
|
+
|
6067
|
+
---
|
6068
|
+
`metadata`
|
6069
|
+
```json
|
6070
|
+
{
|
6071
|
+
"type": "string",
|
6072
|
+
"format": "json"
|
6073
|
+
}
|
6074
|
+
```
|
6075
|
+
ユーザーのデバイス用の情報をメタデータを保持するために用います。
|
6076
|
+
例: 端末の固有情報やブラウザのUser-Agent
|
6077
|
+
|
6078
|
+
|
6079
|
+
---
|
6080
|
+
成功したときは[UserDevice](#user-device)オブジェクトを返します
|
6081
|
+
<a name="get-user-device"></a>
|
6082
|
+
#### ユーザーのデバイスを取得
|
6083
|
+
ユーザーのデバイスの情報を取得します
|
6084
|
+
```ruby
|
6085
|
+
response = $client.send(Pokepay::Request::GetUserDevice.new(
|
6086
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # user_device_id: ユーザーデバイスID
|
6087
|
+
))
|
6088
|
+
```
|
6089
|
+
成功したときは[UserDevice](#user-device)オブジェクトを返します
|
6090
|
+
<a name="activate-user-device"></a>
|
6091
|
+
#### デバイスの有効化
|
6092
|
+
指定のデバイスを有効化し、それ以外の同一ユーザーのデバイスを無効化します。
|
6093
|
+
|
6094
|
+
```ruby
|
6095
|
+
response = $client.send(Pokepay::Request::ActivateUserDevice.new(
|
6096
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # user_device_id: ユーザーデバイスID
|
6097
|
+
))
|
6098
|
+
```
|
6099
|
+
成功したときは[UserDevice](#user-device)オブジェクトを返します
|
6100
|
+
### BankPay
|
6101
|
+
BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
|
6102
|
+
|
6103
|
+
<a name="create-bank"></a>
|
6104
|
+
#### 銀行口座の登録
|
6105
|
+
銀行口座の登録を始めるAPIです。レスポンスに含まれるredirect_urlをユーザーの端末で開き銀行を登録します。
|
6106
|
+
|
6107
|
+
ユーザーが銀行口座の登録に成功すると、callback_urlにリクエストが行われます。
|
6108
|
+
アプリの場合はDeep Linkを使うことを想定しています。
|
6109
|
+
|
6110
|
+
```ruby
|
6111
|
+
response = $client.send(Pokepay::Request::CreateBank.new(
|
6112
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_device_id: デバイスID
|
6113
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
6114
|
+
"<Deep Link>", # callback_url: コールバックURL
|
6115
|
+
"ポケペイタロウ", # kana: ユーザーの氏名 (片仮名で指定)
|
6116
|
+
email: "y8Xa1naLbp@7yoC.com", # ユーザーのメールアドレス
|
6117
|
+
birthdate: "19901142" # 生年月日
|
6118
|
+
))
|
6119
|
+
```
|
6120
|
+
成功したときは[BankRegisteringInfo](#bank-registering-info)オブジェクトを返します
|
6121
|
+
<a name="list-banks"></a>
|
6122
|
+
#### 登録した銀行の一覧
|
6123
|
+
登録した銀行を一覧します
|
6124
|
+
```ruby
|
6125
|
+
response = $client.send(Pokepay::Request::ListBanks.new(
|
6126
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_device_id: デバイスID
|
6127
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
6128
|
+
))
|
6129
|
+
```
|
6130
|
+
成功したときは[Banks](#banks)オブジェクトを返します
|
6131
|
+
<a name="create-bank-topup-transaction"></a>
|
6132
|
+
#### 銀行からのチャージ
|
6133
|
+
指定のマネーのアカウントにbank_idの口座を用いてチャージを行います。
|
6134
|
+
```ruby
|
6135
|
+
response = $client.send(Pokepay::Request::CreateBankTopupTransaction.new(
|
6136
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_device_id: デバイスID
|
6137
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
6138
|
+
3436, # amount: チャージ金額
|
6139
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bank_id: 銀行ID
|
6140
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # request_id: リクエストID
|
6141
|
+
))
|
6142
|
+
```
|
6143
|
+
成功したときは[TransactionDetail](#transaction-detail)オブジェクトを返します
|
5252
6144
|
## Responses
|
5253
6145
|
|
5254
6146
|
|
@@ -5311,6 +6203,7 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5311
6203
|
* `is_onetime (boolean)`: 使用回数が一回限りかどうか
|
5312
6204
|
* `is_disabled (boolean)`: 無効化されているかどうか
|
5313
6205
|
* `expires_at (string)`: チャージQRコード自体の失効日時
|
6206
|
+
* `last_used_at (string)`:
|
5314
6207
|
* `private_money (PrivateMoney)`: 対象マネー情報
|
5315
6208
|
* `usage_limit (integer)`: 一回限りでない場合の最大読み取り回数
|
5316
6209
|
* `usage_count (double)`: 一回限りでない場合の現在までに読み取られた回数
|
@@ -5322,6 +6215,16 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5322
6215
|
|
5323
6216
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
5324
6217
|
|
6218
|
+
<a name="paginated-checks"></a>
|
6219
|
+
## PaginatedChecks
|
6220
|
+
* `rows (array of Checks)`:
|
6221
|
+
* `count (integer)`:
|
6222
|
+
* `pagination (Pagination)`:
|
6223
|
+
|
6224
|
+
`rows`は [Check](#check) オブジェクトの配列を返します。
|
6225
|
+
|
6226
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
6227
|
+
|
5325
6228
|
<a name="cpm-token"></a>
|
5326
6229
|
## CpmToken
|
5327
6230
|
* `cpm_token (string)`:
|
@@ -5374,6 +6277,11 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5374
6277
|
* `name (string)`: ユーザー (または店舗) 名
|
5375
6278
|
* `is_merchant (boolean)`: 店舗ユーザーかどうか
|
5376
6279
|
|
6280
|
+
<a name="organization"></a>
|
6281
|
+
## Organization
|
6282
|
+
* `code (string)`: 組織コード
|
6283
|
+
* `name (string)`: 組織名
|
6284
|
+
|
5377
6285
|
<a name="transaction-detail"></a>
|
5378
6286
|
## TransactionDetail
|
5379
6287
|
* `id (string)`: 取引ID
|
@@ -5425,8 +6333,8 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5425
6333
|
* `submitted_at (string)`: バルク取引が登録された日時
|
5426
6334
|
* `updated_at (string)`: バルク取引が更新された日時
|
5427
6335
|
|
5428
|
-
<a name="external-transaction"></a>
|
5429
|
-
##
|
6336
|
+
<a name="external-transaction-detail"></a>
|
6337
|
+
## ExternalTransactionDetail
|
5430
6338
|
* `id (string)`: ポケペイ外部取引ID
|
5431
6339
|
* `is_modified (boolean)`: 返金された取引かどうか
|
5432
6340
|
* `sender (User)`: 送金者情報
|
@@ -5436,11 +6344,14 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5436
6344
|
* `amount (double)`: 決済額
|
5437
6345
|
* `done_at (string)`: 取引日時
|
5438
6346
|
* `description (string)`: 取引説明文
|
6347
|
+
* `transaction (TransactionDetail)`: 関連ポケペイ取引詳細
|
5439
6348
|
|
5440
6349
|
`receiver`と`sender`は [User](#user) オブジェクトを返します。
|
5441
6350
|
|
5442
6351
|
`receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
|
5443
6352
|
|
6353
|
+
`transaction`は [TransactionDetail](#transaction-detail) オブジェクトを返します。
|
6354
|
+
|
5444
6355
|
<a name="paginated-private-money-organization-summaries"></a>
|
5445
6356
|
## PaginatedPrivateMoneyOrganizationSummaries
|
5446
6357
|
* `rows (array of PrivateMoneyOrganizationSummaries)`:
|
@@ -5458,6 +6369,8 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5458
6369
|
* `payment_amount (double)`:
|
5459
6370
|
* `refunded_payment_amount (double)`:
|
5460
6371
|
* `added_point_amount (double)`:
|
6372
|
+
* `topup_point_amount (double)`:
|
6373
|
+
* `campaign_point_amount (double)`:
|
5461
6374
|
* `refunded_added_point_amount (double)`:
|
5462
6375
|
* `exchange_inflow_amount (double)`:
|
5463
6376
|
* `exchange_outflow_amount (double)`:
|
@@ -5474,6 +6387,27 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5474
6387
|
* `file_url (string)`: 集計結果のCSVのダウンロードURL
|
5475
6388
|
* `requested_at (string)`: 集計リクエストを行った時刻
|
5476
6389
|
|
6390
|
+
<a name="user-device"></a>
|
6391
|
+
## UserDevice
|
6392
|
+
* `id (string)`: デバイスID
|
6393
|
+
* `user (User)`: デバイスを使用するユーザ
|
6394
|
+
* `is_active (boolean)`: デバイスが有効か
|
6395
|
+
* `metadata (string)`: デバイスのメタデータ
|
6396
|
+
|
6397
|
+
`user`は [User](#user) オブジェクトを返します。
|
6398
|
+
|
6399
|
+
<a name="bank-registering-info"></a>
|
6400
|
+
## BankRegisteringInfo
|
6401
|
+
* `redirect_url (string)`:
|
6402
|
+
* `paytree_customer_number (string)`:
|
6403
|
+
|
6404
|
+
<a name="banks"></a>
|
6405
|
+
## Banks
|
6406
|
+
* `rows (array of Banks)`:
|
6407
|
+
* `count (integer)`:
|
6408
|
+
|
6409
|
+
`rows`は [Bank](#bank) オブジェクトの配列を返します。
|
6410
|
+
|
5477
6411
|
<a name="paginated-transaction"></a>
|
5478
6412
|
## PaginatedTransaction
|
5479
6413
|
* `rows (array of Transactions)`:
|
@@ -5593,6 +6527,9 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5593
6527
|
* `point_calculation_rule (string)`: ポイント計算ルール (banklisp表記)
|
5594
6528
|
* `point_calculation_rule_object (string)`: ポイント計算ルール (JSON文字列による表記)
|
5595
6529
|
* `status (string)`: キャンペーンの現在の状態
|
6530
|
+
* `budget_caps_amount (integer)`: キャンペーンの予算上限額
|
6531
|
+
* `budget_current_amount (integer)`: キャンペーンの付与合計額
|
6532
|
+
* `budget_current_time (string)`: キャンペーンの付与集計日時
|
5596
6533
|
|
5597
6534
|
`applicable-shops`は [User](#user) オブジェクトの配列を返します。
|
5598
6535
|
|
@@ -5676,6 +6613,16 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5676
6613
|
|
5677
6614
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
5678
6615
|
|
6616
|
+
<a name="paginated-organizations"></a>
|
6617
|
+
## PaginatedOrganizations
|
6618
|
+
* `rows (array of Organizations)`:
|
6619
|
+
* `count (integer)`:
|
6620
|
+
* `pagination (Pagination)`:
|
6621
|
+
|
6622
|
+
`rows`は [Organization](#organization) オブジェクトの配列を返します。
|
6623
|
+
|
6624
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
6625
|
+
|
5679
6626
|
<a name="private-money"></a>
|
5680
6627
|
## PrivateMoney
|
5681
6628
|
* `id (string)`: マネーID
|
@@ -5695,6 +6642,14 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5695
6642
|
|
5696
6643
|
`organization`は [Organization](#organization) オブジェクトを返します。
|
5697
6644
|
|
6645
|
+
<a name="pagination"></a>
|
6646
|
+
## Pagination
|
6647
|
+
* `current (integer)`:
|
6648
|
+
* `per_page (integer)`:
|
6649
|
+
* `max_page (integer)`:
|
6650
|
+
* `has_prev (boolean)`:
|
6651
|
+
* `has_next (boolean)`:
|
6652
|
+
|
5698
6653
|
<a name="transaction"></a>
|
5699
6654
|
## Transaction
|
5700
6655
|
* `id (string)`: 取引ID
|
@@ -5716,6 +6671,22 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5716
6671
|
|
5717
6672
|
`receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
|
5718
6673
|
|
6674
|
+
<a name="external-transaction"></a>
|
6675
|
+
## ExternalTransaction
|
6676
|
+
* `id (string)`: ポケペイ外部取引ID
|
6677
|
+
* `is_modified (boolean)`: 返金された取引かどうか
|
6678
|
+
* `sender (User)`: 送金者情報
|
6679
|
+
* `sender_account (Account)`: 送金ウォレット情報
|
6680
|
+
* `receiver (User)`: 受取者情報
|
6681
|
+
* `receiver_account (Account)`: 受取ウォレット情報
|
6682
|
+
* `amount (double)`: 決済額
|
6683
|
+
* `done_at (string)`: 取引日時
|
6684
|
+
* `description (string)`: 取引説明文
|
6685
|
+
|
6686
|
+
`receiver`と`sender`は [User](#user) オブジェクトを返します。
|
6687
|
+
|
6688
|
+
`receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
|
6689
|
+
|
5719
6690
|
<a name="cashtray-attempt"></a>
|
5720
6691
|
## CashtrayAttempt
|
5721
6692
|
* `account (AccountWithUser)`: エンドユーザーのウォレット
|
@@ -5769,13 +6740,19 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5769
6740
|
|
5770
6741
|
`payment`と`topup`は [OrganizationSummary](#organization-summary) オブジェクトを返します。
|
5771
6742
|
|
5772
|
-
<a name="
|
5773
|
-
##
|
5774
|
-
* `
|
5775
|
-
* `
|
5776
|
-
* `
|
5777
|
-
* `
|
5778
|
-
* `
|
6743
|
+
<a name="bank"></a>
|
6744
|
+
## Bank
|
6745
|
+
* `id (string)`:
|
6746
|
+
* `private_money (PrivateMoney)`:
|
6747
|
+
* `bank_name (string)`:
|
6748
|
+
* `bank_code (string)`:
|
6749
|
+
* `branch_number (string)`:
|
6750
|
+
* `branch_name (string)`:
|
6751
|
+
* `deposit_type (string)`:
|
6752
|
+
* `masked_account_number (string)`:
|
6753
|
+
* `account_name (string)`:
|
6754
|
+
|
6755
|
+
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
5779
6756
|
|
5780
6757
|
<a name="account-balance"></a>
|
5781
6758
|
## AccountBalance
|
@@ -5826,11 +6803,6 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5826
6803
|
|
5827
6804
|
`issued_shop`は [User](#user) オブジェクトを返します。
|
5828
6805
|
|
5829
|
-
<a name="organization"></a>
|
5830
|
-
## Organization
|
5831
|
-
* `code (string)`: 組織コード
|
5832
|
-
* `name (string)`: 組織名
|
5833
|
-
|
5834
6806
|
<a name="account-without-private-money-detail"></a>
|
5835
6807
|
## AccountWithoutPrivateMoneyDetail
|
5836
6808
|
* `id (string)`:
|
@@ -5848,4 +6820,6 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
|
|
5848
6820
|
* `money_amount (double)`:
|
5849
6821
|
* `money_count (integer)`:
|
5850
6822
|
* `point_amount (double)`:
|
6823
|
+
* `raw_point_amount (double)`:
|
6824
|
+
* `campaign_point_amount (double)`:
|
5851
6825
|
* `point_count (integer)`:
|