pokepay_partner_ruby_sdk 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -8
- data/docs/index.md +1035 -157
- data/lib/pokepay_partner_ruby_sdk/client.rb +11 -1
- data/lib/pokepay_partner_ruby_sdk/request/get_account_transfer_summary.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_bulk_transaction_jobs.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_transfers_v2.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/request_user_stats.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/account_transfer_summary.rb +11 -0
- data/lib/pokepay_partner_ruby_sdk/response/account_transfer_summary_element.rb +17 -0
- data/lib/pokepay_partner_ruby_sdk/response/bulk_transaction_job.rb +42 -0
- data/lib/pokepay_partner_ruby_sdk/response/campaign.rb +2 -0
- data/lib/pokepay_partner_ruby_sdk/response/check.rb +6 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_bulk_transaction_job.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_transfers_v2.rb +19 -0
- data/lib/pokepay_partner_ruby_sdk/response/unpermitted_admin_user.rb +13 -0
- data/lib/pokepay_partner_ruby_sdk/response/user_stats_operation.rb +25 -0
- data/lib/pokepay_partner_ruby_sdk/response/user_stats_operation_service_unavailable.rb +13 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +12 -0
- data/partner.yaml +1038 -7
- data/pokepay_partner_ruby_sdk.gemspec +1 -1
- metadata +17 -5
data/docs/index.md
CHANGED
|
@@ -168,7 +168,11 @@ response.body
|
|
|
168
168
|
- [GetTransaction](#get-transaction): 取引情報を取得する
|
|
169
169
|
- [RefundTransaction](#refund-transaction): 取引をキャンセルする
|
|
170
170
|
- [GetTransactionByRequestId](#get-transaction-by-request-id): リクエストIDから取引情報を取得する
|
|
171
|
+
- [RequestUserStats](#request-user-stats): 指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする
|
|
172
|
+
- [GetAccountTransferSummary](#get-account-transfer-summary):
|
|
171
173
|
- [ListTransfers](#list-transfers):
|
|
174
|
+
- [ListTransfersV2](#list-transfers-v2):
|
|
175
|
+
- [CreateCheck](#create-check): チャージQRコードの発行
|
|
172
176
|
- [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
|
|
173
177
|
- [ListBills](#list-bills): 支払いQRコード一覧を表示する
|
|
174
178
|
- [CreateBill](#create-bill): 支払いQRコードの発行
|
|
@@ -182,9 +186,9 @@ response.body
|
|
|
182
186
|
- [DeleteAccount](#delete-account): ウォレットを退会する
|
|
183
187
|
- [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
|
|
184
188
|
- [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
|
|
185
|
-
- [UpdateCustomerAccount](#update-customer-account):
|
|
189
|
+
- [UpdateCustomerAccount](#update-customer-account): エンドユーザーのウォレット情報を更新する
|
|
186
190
|
- [GetCustomerAccounts](#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
|
|
187
|
-
- [CreateCustomerAccount](#create-customer-account):
|
|
191
|
+
- [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーをウォレットと共に追加する
|
|
188
192
|
- [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
|
|
189
193
|
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
|
190
194
|
- [ListShops](#list-shops): 店舗一覧を取得する
|
|
@@ -210,7 +214,7 @@ response.body
|
|
|
210
214
|
CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
|
|
211
215
|
```ruby
|
|
212
216
|
response = $client.send(Pokepay::Request::GetCpmToken.new(
|
|
213
|
-
"
|
|
217
|
+
"uEOVKpPzDCyUBg3VaVg5lQ" # cpm_token: CPMトークン
|
|
214
218
|
))
|
|
215
219
|
```
|
|
216
220
|
|
|
@@ -232,15 +236,15 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
|
|
|
232
236
|
取引一覧を返します。
|
|
233
237
|
```ruby
|
|
234
238
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
235
|
-
from: "
|
|
236
|
-
to: "
|
|
239
|
+
from: "2020-09-03T10:24:34.000000+09:00", # 開始日時
|
|
240
|
+
to: "2017-08-26T09:53:13.000000+09:00", # 終了日時
|
|
237
241
|
page: 1, # ページ番号
|
|
238
242
|
per_page: 50, # 1ページ分の取引数
|
|
239
243
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
240
244
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
241
245
|
customer_name: "太郎", # エンドユーザー名
|
|
242
246
|
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
|
243
|
-
transaction_id: "
|
|
247
|
+
transaction_id: "irhr", # 取引ID
|
|
244
248
|
organization_code: "pocketchange", # 組織コード
|
|
245
249
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
246
250
|
is_modified: true, # キャンセルフラグ
|
|
@@ -444,10 +448,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
|
444
448
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
445
449
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
446
450
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
447
|
-
money_amount:
|
|
448
|
-
point_amount:
|
|
449
|
-
point_expires_at: "
|
|
450
|
-
description: "
|
|
451
|
+
money_amount: 4512,
|
|
452
|
+
point_amount: 8509,
|
|
453
|
+
point_expires_at: "2018-10-18T14:03:35.000000+09:00", # ポイント有効期限
|
|
454
|
+
description: "bFTGr24vRn0V1KmKqNhpuD1AS4IxvpFPGaTF6gXtd3nJyyNe74Q2bvFtDokudzPS7PJ09whlF6CVlMKFHkTHEGRWUBVUZa1rmAxzFUF6ihvlI4uoOEnKraNjpsN9SjDxtxrgs7e0dkiAAa8jwX6FLCB1XlvzBazSCE1hEG2EkkP2VIPy7HW7Ee7skB9BB1YNClE"
|
|
451
455
|
))
|
|
452
456
|
```
|
|
453
457
|
|
|
@@ -476,11 +480,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
476
480
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
477
481
|
customer_name: "太郎", # エンドユーザー名
|
|
478
482
|
description: "店頭QRコードによる支払い", # 取引説明文
|
|
479
|
-
transaction_id: "
|
|
480
|
-
is_modified:
|
|
483
|
+
transaction_id: "n", # 取引ID
|
|
484
|
+
is_modified: false, # キャンセルフラグ
|
|
481
485
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
482
|
-
from: "
|
|
483
|
-
to: "
|
|
486
|
+
from: "2017-08-18T12:45:05.000000+09:00", # 開始日時
|
|
487
|
+
to: "2025-01-16T16:54:19.000000+09:00", # 終了日時
|
|
484
488
|
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransactionのID
|
|
485
489
|
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransactionのID
|
|
486
490
|
per_page: 50 # 1ページ分の取引数
|
|
@@ -709,9 +713,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
709
713
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
710
714
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
711
715
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
712
|
-
money_amount:
|
|
713
|
-
point_amount:
|
|
714
|
-
point_expires_at: "
|
|
716
|
+
money_amount: 6192, # マネー額
|
|
717
|
+
point_amount: 5644, # ポイント額
|
|
718
|
+
point_expires_at: "2024-01-05T01:07:10.000000+09:00", # ポイント有効期限
|
|
715
719
|
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
|
716
720
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
717
721
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
@@ -853,7 +857,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
853
857
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
854
858
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
855
859
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
856
|
-
|
|
860
|
+
8459, # amount: 支払い額
|
|
857
861
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
858
862
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
859
863
|
products: [{"jan_code":"abc",
|
|
@@ -861,6 +865,16 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
861
865
|
"unit_price":100,
|
|
862
866
|
"price": 100,
|
|
863
867
|
"is_discounted": false,
|
|
868
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
869
|
+
"name":"name1",
|
|
870
|
+
"unit_price":100,
|
|
871
|
+
"price": 100,
|
|
872
|
+
"is_discounted": false,
|
|
873
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
874
|
+
"name":"name1",
|
|
875
|
+
"unit_price":100,
|
|
876
|
+
"price": 100,
|
|
877
|
+
"is_discounted": false,
|
|
864
878
|
"other":"{}"}], # 商品情報データ
|
|
865
879
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
866
880
|
))
|
|
@@ -979,9 +993,9 @@ CPMトークンに設定されたスコープの取引を作ることができ
|
|
|
979
993
|
|
|
980
994
|
```ruby
|
|
981
995
|
response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
|
982
|
-
"
|
|
996
|
+
"spNWH9u8x4Yq2mxjIub5W9", # cpm_token: CPMトークン
|
|
983
997
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
984
|
-
|
|
998
|
+
6756.0, # amount: 取引金額
|
|
985
999
|
description: "たい焼き(小倉)", # 取引説明文
|
|
986
1000
|
metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
|
|
987
1001
|
products: [{"jan_code":"abc",
|
|
@@ -1101,7 +1115,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
1101
1115
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
1102
1116
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
1103
1117
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1104
|
-
|
|
1118
|
+
3508.0, # amount: 送金額
|
|
1105
1119
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
1106
1120
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1107
1121
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
@@ -1203,8 +1217,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
|
1203
1217
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1204
1218
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1205
1219
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1206
|
-
|
|
1207
|
-
description: "
|
|
1220
|
+
4583.0,
|
|
1221
|
+
description: "79SnOHSfjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpX",
|
|
1208
1222
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
1209
1223
|
))
|
|
1210
1224
|
```
|
|
@@ -1260,9 +1274,22 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
|
1260
1274
|
```ruby
|
|
1261
1275
|
response = $client.send(Pokepay::Request::RefundTransaction.new(
|
|
1262
1276
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
|
|
1263
|
-
description: "返品対応のため"
|
|
1277
|
+
description: "返品対応のため", # 取引履歴に表示する返金事由
|
|
1278
|
+
returning_point_expires_at: "2021-06-29T03:01:24.000000+09:00" # 返却ポイントの有効期限
|
|
1264
1279
|
))
|
|
1265
1280
|
```
|
|
1281
|
+
|
|
1282
|
+
---
|
|
1283
|
+
`returning_point_expires_at`
|
|
1284
|
+
```json
|
|
1285
|
+
{
|
|
1286
|
+
"type": "string",
|
|
1287
|
+
"format": "date-time"
|
|
1288
|
+
}
|
|
1289
|
+
```
|
|
1290
|
+
ポイント支払いを含む支払い取引をキャンセルする際にユーザへ返却されるポイントの有効期限です。デフォルトでは未指定です。
|
|
1291
|
+
|
|
1292
|
+
---
|
|
1266
1293
|
成功したときは[TransactionDetail](#transaction-detail)オブジェクトを返します
|
|
1267
1294
|
<a name="get-transaction-by-request-id"></a>
|
|
1268
1295
|
#### リクエストIDから取引情報を取得する
|
|
@@ -1287,23 +1314,145 @@ response = $client.send(Pokepay::Request::GetTransactionByRequestId.new(
|
|
|
1287
1314
|
|
|
1288
1315
|
---
|
|
1289
1316
|
成功したときは[TransactionDetail](#transaction-detail)オブジェクトを返します
|
|
1317
|
+
<a name="request-user-stats"></a>
|
|
1318
|
+
#### 指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする
|
|
1319
|
+
期間を指定して、期間内に発行マネーの全顧客が行った取引の総額・回数などをCSVでダウンロードする機能です。
|
|
1320
|
+
CSVの作成は非同期で行われるため完了まで少しの間待つ必要がありますが、完了時にダウンロードできるURLをレスポンスとして返します。
|
|
1321
|
+
このURLの有効期限はリクエスト日時から7日間です。
|
|
1322
|
+
|
|
1323
|
+
ダウンロードできるCSVのデータは以下のものです。
|
|
1324
|
+
|
|
1325
|
+
* organization_code: 取引を行った組織コード
|
|
1326
|
+
* private_money_id: 取引されたマネーのID
|
|
1327
|
+
* private_money_name: 取引されたマネーの名前
|
|
1328
|
+
* user_id: 決済したユーザーID
|
|
1329
|
+
* user_external_id: 決済したユーザーの外部ID
|
|
1330
|
+
* payment_money_amount: 指定期間内に決済に使ったマネーの総額
|
|
1331
|
+
* payment_point_amount: 指定期間内に決済に使ったポイントの総額
|
|
1332
|
+
* payment_transaction_count: 指定期間内に決済した回数。キャンセルされた取引は含まない
|
|
1333
|
+
|
|
1334
|
+
また、指定期間より前の決済を時間をおいてキャンセルした場合などには payment_money_amount, payment_point_amount, payment_transaction_count が負の値になることもあることに留意してください。
|
|
1335
|
+
```ruby
|
|
1336
|
+
response = $client.send(Pokepay::Request::RequestUserStats.new(
|
|
1337
|
+
"2019-07-26T21:37:35.000000+09:00", # from: 集計期間の開始時刻
|
|
1338
|
+
"2025-02-11T02:09:15.000000+09:00" # to: 集計期間の終了時刻
|
|
1339
|
+
))
|
|
1340
|
+
```
|
|
1341
|
+
|
|
1342
|
+
---
|
|
1343
|
+
`from`
|
|
1344
|
+
```json
|
|
1345
|
+
{
|
|
1346
|
+
"type": "string",
|
|
1347
|
+
"format": "date-time"
|
|
1348
|
+
}
|
|
1349
|
+
```
|
|
1350
|
+
集計する期間の開始時刻をISO8601形式で指定します。
|
|
1351
|
+
時刻は現在時刻、及び `to` で指定する時刻以前である必要があります。
|
|
1352
|
+
|
|
1353
|
+
---
|
|
1354
|
+
`to`
|
|
1355
|
+
```json
|
|
1356
|
+
{
|
|
1357
|
+
"type": "string",
|
|
1358
|
+
"format": "date-time"
|
|
1359
|
+
}
|
|
1360
|
+
```
|
|
1361
|
+
集計する期間の終了時刻をISO8601形式で指定します。
|
|
1362
|
+
時刻は現在時刻、及び `from` で指定する時刻の間である必要があります。
|
|
1363
|
+
|
|
1364
|
+
---
|
|
1365
|
+
成功したときは[UserStatsOperation](#user-stats-operation)オブジェクトを返します
|
|
1366
|
+
### Transfer
|
|
1367
|
+
<a name="get-account-transfer-summary"></a>
|
|
1368
|
+
####
|
|
1369
|
+
ウォレットを指定して取引明細種別毎の集計を返す
|
|
1370
|
+
```ruby
|
|
1371
|
+
response = $client.send(Pokepay::Request::GetAccountTransferSummary.new(
|
|
1372
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1373
|
+
from: "2020-02-19T23:43:27.000000+09:00", # 集計期間の開始時刻
|
|
1374
|
+
to: "2016-06-13T17:11:34.000000+09:00", # 集計期間の終了時刻
|
|
1375
|
+
transfer_types: ["topup", "payment"] # 取引明細種別 (複数指定可)
|
|
1376
|
+
))
|
|
1377
|
+
```
|
|
1378
|
+
|
|
1379
|
+
---
|
|
1380
|
+
`account_id`
|
|
1381
|
+
```json
|
|
1382
|
+
{
|
|
1383
|
+
"type": "string",
|
|
1384
|
+
"format": "uuid"
|
|
1385
|
+
}
|
|
1386
|
+
```
|
|
1387
|
+
ウォレットIDです。
|
|
1388
|
+
|
|
1389
|
+
ここで指定したウォレットIDの取引明細レベルでの集計を取得します。
|
|
1390
|
+
|
|
1391
|
+
---
|
|
1392
|
+
`transfer_types`
|
|
1393
|
+
```json
|
|
1394
|
+
{
|
|
1395
|
+
"type": "array",
|
|
1396
|
+
"items": {
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"enum": {
|
|
1399
|
+
"payment": "topup",
|
|
1400
|
+
"campaign-topup": "use-coupon",
|
|
1401
|
+
"refund-payment": "refund-topup",
|
|
1402
|
+
"refund-campaign": "refund-coupon",
|
|
1403
|
+
"exchange-inflow": "exchange-outflow",
|
|
1404
|
+
"refund-exchange-inflow": "refund-exchange-outflow"
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
```
|
|
1409
|
+
取引明細の種別でフィルターします。
|
|
1410
|
+
以下の種別を指定できます。
|
|
1411
|
+
|
|
1412
|
+
- payment
|
|
1413
|
+
エンドユーザーから店舗への送金取引(支払い取引)
|
|
1414
|
+
- topup
|
|
1415
|
+
店舗からエンドユーザーへの送金取引(チャージ取引)
|
|
1416
|
+
- campaign-topup
|
|
1417
|
+
キャンペーンによるエンドユーザーへのポイント付与取引(ポイントチャージ)
|
|
1418
|
+
- use-coupon
|
|
1419
|
+
支払い時のクーポン使用による値引き取引
|
|
1420
|
+
- refund-payment
|
|
1421
|
+
支払い取引に対するキャンセル取引
|
|
1422
|
+
- refund-topup
|
|
1423
|
+
チャージ取引に対するキャンセル取引
|
|
1424
|
+
- refund-campaign
|
|
1425
|
+
キャンペーンによるポイント付与取引に対するキャンセル取引
|
|
1426
|
+
- refund-coupon
|
|
1427
|
+
クーポン使用による値引き取引に対するキャンセル取引
|
|
1428
|
+
- exchange-inflow
|
|
1429
|
+
交換による他マネーからの流入取引
|
|
1430
|
+
- exchange-outflow
|
|
1431
|
+
交換による他マネーへの流出取引
|
|
1432
|
+
- refund-exchange-inflow
|
|
1433
|
+
交換による他マネーからの流入取引に対するキャンセル取引
|
|
1434
|
+
- refund-exchange-outflow
|
|
1435
|
+
交換による他マネーへの流出取引に対するキャンセル取引
|
|
1436
|
+
|
|
1437
|
+
---
|
|
1438
|
+
成功したときは[AccountTransferSummary](#account-transfer-summary)オブジェクトを返します
|
|
1290
1439
|
<a name="list-transfers"></a>
|
|
1291
1440
|
####
|
|
1292
1441
|
```ruby
|
|
1293
1442
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
1294
|
-
from: "
|
|
1295
|
-
to: "
|
|
1296
|
-
page:
|
|
1297
|
-
per_page:
|
|
1443
|
+
from: "2018-10-07T20:22:59.000000+09:00",
|
|
1444
|
+
to: "2016-09-27T06:40:27.000000+09:00",
|
|
1445
|
+
page: 2674,
|
|
1446
|
+
per_page: 5578,
|
|
1298
1447
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1299
|
-
shop_name: "
|
|
1448
|
+
shop_name: "MOcjyqB",
|
|
1300
1449
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1301
|
-
customer_name: "
|
|
1450
|
+
customer_name: "KlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kY",
|
|
1302
1451
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1303
1452
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1304
|
-
is_modified:
|
|
1305
|
-
transaction_types: ["topup", "
|
|
1306
|
-
transfer_types: ["
|
|
1453
|
+
is_modified: true,
|
|
1454
|
+
transaction_types: ["payment", "exchange", "topup", "cashback", "expire", "transfer"],
|
|
1455
|
+
transfer_types: ["exchange", "coupon", "campaign", "payment", "topup", "transfer", "cashback", "expire"], # 取引明細の種類でフィルターします。
|
|
1307
1456
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
1308
1457
|
))
|
|
1309
1458
|
```
|
|
@@ -1363,6 +1512,272 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
|
1363
1512
|
|
|
1364
1513
|
---
|
|
1365
1514
|
成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
|
|
1515
|
+
<a name="list-transfers-v2"></a>
|
|
1516
|
+
####
|
|
1517
|
+
```ruby
|
|
1518
|
+
response = $client.send(Pokepay::Request::ListTransfersV2.new(
|
|
1519
|
+
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
1520
|
+
shop_name: "nZBUv4F8J7UzyDYEv7bctcmIqdmvTV8RBzp0gixsKZWoUeORL98QDv9TW3tonru5DxxR1kiR4daTST401zYU9O5bmxo5R8HDeIrg38UDixRQOsOxJyiut30oRsSLi4FAWjvNFlMGhO7Mj", # 店舗名
|
|
1521
|
+
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
1522
|
+
customer_name: "oFiHLtN9Yqy", # エンドユーザー名
|
|
1523
|
+
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
|
|
1524
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1525
|
+
is_modified: false, # キャンセルフラグ
|
|
1526
|
+
transaction_types: ["topup", "exchange", "cashback", "transfer", "expire", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
1527
|
+
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransferのID
|
|
1528
|
+
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransferのID
|
|
1529
|
+
per_page: 50, # 1ページ分の取引数
|
|
1530
|
+
transfer_types: ["campaign", "payment", "topup"], # 取引明細種別 (複数指定可)
|
|
1531
|
+
description: "店頭QRコードによる支払い", # 取引詳細説明文
|
|
1532
|
+
from: "2024-01-14T18:07:53.000000+09:00", # 開始日時
|
|
1533
|
+
to: "2020-10-01T04:15:53.000000+09:00" # 終了日時
|
|
1534
|
+
))
|
|
1535
|
+
```
|
|
1536
|
+
|
|
1537
|
+
---
|
|
1538
|
+
`shop_id`
|
|
1539
|
+
```json
|
|
1540
|
+
{
|
|
1541
|
+
"type": "string",
|
|
1542
|
+
"format": "uuid"
|
|
1543
|
+
}
|
|
1544
|
+
```
|
|
1545
|
+
店舗IDです。
|
|
1546
|
+
|
|
1547
|
+
フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
|
|
1548
|
+
|
|
1549
|
+
---
|
|
1550
|
+
`shop_name`
|
|
1551
|
+
```json
|
|
1552
|
+
{
|
|
1553
|
+
"type": "string",
|
|
1554
|
+
"maxLength": 256
|
|
1555
|
+
}
|
|
1556
|
+
```
|
|
1557
|
+
店舗名です。
|
|
1558
|
+
|
|
1559
|
+
フィルターとして使われ、入力された名前に部分一致する店舗での取引のみ一覧に表示されます。
|
|
1560
|
+
|
|
1561
|
+
---
|
|
1562
|
+
`customer_id`
|
|
1563
|
+
```json
|
|
1564
|
+
{
|
|
1565
|
+
"type": "string",
|
|
1566
|
+
"format": "uuid"
|
|
1567
|
+
}
|
|
1568
|
+
```
|
|
1569
|
+
エンドユーザーIDです。
|
|
1570
|
+
|
|
1571
|
+
フィルターとして使われ、指定されたエンドユーザーの取引のみ一覧に表示されます。
|
|
1572
|
+
|
|
1573
|
+
---
|
|
1574
|
+
`customer_name`
|
|
1575
|
+
```json
|
|
1576
|
+
{
|
|
1577
|
+
"type": "string",
|
|
1578
|
+
"maxLength": 256
|
|
1579
|
+
}
|
|
1580
|
+
```
|
|
1581
|
+
エンドユーザー名です。
|
|
1582
|
+
|
|
1583
|
+
フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
|
|
1584
|
+
|
|
1585
|
+
---
|
|
1586
|
+
`transaction_id`
|
|
1587
|
+
```json
|
|
1588
|
+
{
|
|
1589
|
+
"type": "string",
|
|
1590
|
+
"format": "uuid"
|
|
1591
|
+
}
|
|
1592
|
+
```
|
|
1593
|
+
取引IDです。
|
|
1594
|
+
|
|
1595
|
+
フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
|
|
1596
|
+
|
|
1597
|
+
---
|
|
1598
|
+
`private_money_id`
|
|
1599
|
+
```json
|
|
1600
|
+
{
|
|
1601
|
+
"type": "string",
|
|
1602
|
+
"format": "uuid"
|
|
1603
|
+
}
|
|
1604
|
+
```
|
|
1605
|
+
マネーIDです。
|
|
1606
|
+
|
|
1607
|
+
指定したマネーでの取引が一覧に表示されます。
|
|
1608
|
+
|
|
1609
|
+
---
|
|
1610
|
+
`is_modified`
|
|
1611
|
+
```json
|
|
1612
|
+
{ "type": "boolean" }
|
|
1613
|
+
```
|
|
1614
|
+
キャンセルフラグです。
|
|
1615
|
+
|
|
1616
|
+
これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
|
|
1617
|
+
デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
|
|
1618
|
+
|
|
1619
|
+
---
|
|
1620
|
+
`transaction_types`
|
|
1621
|
+
```json
|
|
1622
|
+
{
|
|
1623
|
+
"type": "array",
|
|
1624
|
+
"items": {
|
|
1625
|
+
"type": "string",
|
|
1626
|
+
"enum": {
|
|
1627
|
+
"topup": "payment",
|
|
1628
|
+
"transfer": "exchange",
|
|
1629
|
+
"cashback": "expire"
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
```
|
|
1634
|
+
取引の種類でフィルターします。
|
|
1635
|
+
|
|
1636
|
+
以下の種類を指定できます。
|
|
1637
|
+
|
|
1638
|
+
1. topup
|
|
1639
|
+
店舗からエンドユーザーへの送金取引(チャージ)
|
|
1640
|
+
|
|
1641
|
+
2. payment
|
|
1642
|
+
エンドユーザーから店舗への送金取引(支払い)
|
|
1643
|
+
|
|
1644
|
+
3. exchange-outflow
|
|
1645
|
+
他マネーへの流出
|
|
1646
|
+
private_money_idが指定されたとき、そのマネーから見て流出方向の交換取引が抽出されます。
|
|
1647
|
+
private_money_idを省略した場合は表示されません。
|
|
1648
|
+
|
|
1649
|
+
4. exchange-inflow
|
|
1650
|
+
他マネーからの流入
|
|
1651
|
+
private_money_idが指定されたとき、そのマネーから見て流入方向の交換取引が抽出されます。
|
|
1652
|
+
private_money_idを省略した場合は表示されません。
|
|
1653
|
+
|
|
1654
|
+
5. cashback
|
|
1655
|
+
退会時返金取引
|
|
1656
|
+
|
|
1657
|
+
6. expire
|
|
1658
|
+
退会時失効取引
|
|
1659
|
+
|
|
1660
|
+
---
|
|
1661
|
+
`next_page_cursor_id`
|
|
1662
|
+
```json
|
|
1663
|
+
{
|
|
1664
|
+
"type": "string",
|
|
1665
|
+
"format": "uuid"
|
|
1666
|
+
}
|
|
1667
|
+
```
|
|
1668
|
+
次ページへ遷移する際に起点となるtransferのID(前ページの末尾要素のID)です。
|
|
1669
|
+
本APIのレスポンスにもnext_page_cursor_idが含まれており、これがnull値の場合は最後のページであることを意味します。
|
|
1670
|
+
UUIDである場合は次のページが存在することを意味し、このnext_page_cursor_idをリクエストパラメータに含めることで次ページに遷移します。
|
|
1671
|
+
|
|
1672
|
+
next_page_cursor_idのtransfer自体は次のページには含まれません。
|
|
1673
|
+
|
|
1674
|
+
---
|
|
1675
|
+
`prev_page_cursor_id`
|
|
1676
|
+
```json
|
|
1677
|
+
{
|
|
1678
|
+
"type": "string",
|
|
1679
|
+
"format": "uuid"
|
|
1680
|
+
}
|
|
1681
|
+
```
|
|
1682
|
+
前ページへ遷移する際に起点となるtransferのID(次ページの先頭要素のID)です。
|
|
1683
|
+
|
|
1684
|
+
本APIのレスポンスにもprev_page_cursor_idが含まれており、これがnull値の場合は先頭のページであることを意味します。
|
|
1685
|
+
UUIDである場合は前のページが存在することを意味し、このprev_page_cursor_idをリクエストパラメータに含めることで前ページに遷移します。
|
|
1686
|
+
|
|
1687
|
+
prev_page_cursor_idのtransfer自体は前のページには含まれません。
|
|
1688
|
+
|
|
1689
|
+
---
|
|
1690
|
+
`per_page`
|
|
1691
|
+
```json
|
|
1692
|
+
{
|
|
1693
|
+
"type": "integer",
|
|
1694
|
+
"minimum": 1,
|
|
1695
|
+
"maximum": 1000
|
|
1696
|
+
}
|
|
1697
|
+
```
|
|
1698
|
+
1ページ分の取引数です。
|
|
1699
|
+
|
|
1700
|
+
デフォルト値は50です。
|
|
1701
|
+
|
|
1702
|
+
---
|
|
1703
|
+
`transfer_types`
|
|
1704
|
+
```json
|
|
1705
|
+
{
|
|
1706
|
+
"type": "array",
|
|
1707
|
+
"items": {
|
|
1708
|
+
"type": "string",
|
|
1709
|
+
"enum": {
|
|
1710
|
+
"topup": "payment",
|
|
1711
|
+
"exchange": "transfer",
|
|
1712
|
+
"coupon": "campaign",
|
|
1713
|
+
"cashback": "expire"
|
|
1714
|
+
}
|
|
1715
|
+
}
|
|
1716
|
+
}
|
|
1717
|
+
```
|
|
1718
|
+
取引明細の種類でフィルターします。
|
|
1719
|
+
|
|
1720
|
+
以下の種類を指定できます。
|
|
1721
|
+
|
|
1722
|
+
1. topup
|
|
1723
|
+
店舗からエンドユーザーへの送金取引(チャージ)、またはそのキャンセル取引
|
|
1724
|
+
|
|
1725
|
+
2. payment
|
|
1726
|
+
エンドユーザーから店舗への送金取引(支払い)、またはそのキャンセル取引
|
|
1727
|
+
|
|
1728
|
+
3. exchange
|
|
1729
|
+
他マネーへの流出/流入
|
|
1730
|
+
|
|
1731
|
+
4. campaign
|
|
1732
|
+
取引に対するポイント還元キャンペーンによるポイント付与、またはそのキャンセル取引
|
|
1733
|
+
|
|
1734
|
+
5. coupon
|
|
1735
|
+
クーポンによる値引き処理、またはそのキャンセル取引
|
|
1736
|
+
|
|
1737
|
+
6. cashback
|
|
1738
|
+
退会時の返金取引
|
|
1739
|
+
|
|
1740
|
+
7. expire
|
|
1741
|
+
退会時失効取引
|
|
1742
|
+
|
|
1743
|
+
---
|
|
1744
|
+
`description`
|
|
1745
|
+
```json
|
|
1746
|
+
{
|
|
1747
|
+
"type": "string",
|
|
1748
|
+
"maxLength": 200
|
|
1749
|
+
}
|
|
1750
|
+
```
|
|
1751
|
+
取引詳細を指定の取引詳細説明文でフィルターします。
|
|
1752
|
+
|
|
1753
|
+
取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
|
|
1754
|
+
|
|
1755
|
+
---
|
|
1756
|
+
`from`
|
|
1757
|
+
```json
|
|
1758
|
+
{
|
|
1759
|
+
"type": "string",
|
|
1760
|
+
"format": "date-time"
|
|
1761
|
+
}
|
|
1762
|
+
```
|
|
1763
|
+
抽出期間の開始日時です。
|
|
1764
|
+
|
|
1765
|
+
フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
|
|
1766
|
+
|
|
1767
|
+
---
|
|
1768
|
+
`to`
|
|
1769
|
+
```json
|
|
1770
|
+
{
|
|
1771
|
+
"type": "string",
|
|
1772
|
+
"format": "date-time"
|
|
1773
|
+
}
|
|
1774
|
+
```
|
|
1775
|
+
抽出期間の終了日時です。
|
|
1776
|
+
|
|
1777
|
+
フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
|
|
1778
|
+
|
|
1779
|
+
---
|
|
1780
|
+
成功したときは[PaginatedTransfersV2](#paginated-transfers-v2)オブジェクトを返します
|
|
1366
1781
|
### Check
|
|
1367
1782
|
店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
|
|
1368
1783
|
|
|
@@ -1372,6 +1787,46 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
|
1372
1787
|
|
|
1373
1788
|
QRコードを読み取る方法以外にも、このURLリンクを直接スマートフォン(iOS/Android)上で開くことによりアプリが起動して取引が行われます。(注意: 上記URLはsandbox環境であるため、アプリもsandbox環境のものである必要があります) 上記URL中の `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージQRコードのIDです。
|
|
1374
1789
|
|
|
1790
|
+
<a name="create-check"></a>
|
|
1791
|
+
#### チャージQRコードの発行
|
|
1792
|
+
```ruby
|
|
1793
|
+
response = $client.send(Pokepay::Request::CreateCheck.new(
|
|
1794
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
|
|
1795
|
+
money_amount: 3053.0, # 付与マネー額
|
|
1796
|
+
point_amount: 6429.0, # 付与ポイント額
|
|
1797
|
+
description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
|
|
1798
|
+
is_onetime: true, # ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
|
|
1799
|
+
usage_limit: 2663, # ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
|
|
1800
|
+
expires_at: "2018-06-03T00:56:42.000000+09:00", # チャージQR自体の失効日時
|
|
1801
|
+
point_expires_at: "2024-01-10T07:28:49.000000+09:00", # チャージQRによって付与されるポイントの失効日時
|
|
1802
|
+
point_expires_in_days: 60, # チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
|
|
1803
|
+
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗アカウントのID
|
|
1804
|
+
))
|
|
1805
|
+
```
|
|
1806
|
+
`money_amount`と`point_amount`の少なくとも一方は指定する必要があります。
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
---
|
|
1810
|
+
`is_onetime`
|
|
1811
|
+
```json
|
|
1812
|
+
{ "type": "boolean" }
|
|
1813
|
+
```
|
|
1814
|
+
チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
|
|
1815
|
+
`false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
---
|
|
1819
|
+
`usage_limit`
|
|
1820
|
+
```json
|
|
1821
|
+
{ "type": "integer" }
|
|
1822
|
+
```
|
|
1823
|
+
複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
|
|
1824
|
+
省略すると無制限に読み取り可能なチャージQRコードになります。
|
|
1825
|
+
チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
---
|
|
1829
|
+
成功したときは[Check](#check)オブジェクトを返します
|
|
1375
1830
|
<a name="create-topup-transaction-with-check"></a>
|
|
1376
1831
|
#### チャージQRコードを読み取ることでチャージする
|
|
1377
1832
|
通常チャージQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
|
|
@@ -1418,19 +1873,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
1418
1873
|
支払いQRコード一覧を表示します。
|
|
1419
1874
|
```ruby
|
|
1420
1875
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
1421
|
-
page:
|
|
1422
|
-
per_page:
|
|
1423
|
-
bill_id: "
|
|
1876
|
+
page: 3244, # ページ番号
|
|
1877
|
+
per_page: 4145, # 1ページの表示数
|
|
1878
|
+
bill_id: "IdNSbIr", # 支払いQRコードのID
|
|
1424
1879
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1425
|
-
organization_code: "
|
|
1880
|
+
organization_code: "-MIe--67l72U--B--Tx-0--L", # 組織コード
|
|
1426
1881
|
description: "test bill", # 取引説明文
|
|
1427
|
-
created_from: "
|
|
1428
|
-
created_to: "
|
|
1882
|
+
created_from: "2017-03-06T05:22:10.000000+09:00", # 作成日時(起点)
|
|
1883
|
+
created_to: "2020-09-11T05:26:23.000000+09:00", # 作成日時(終点)
|
|
1429
1884
|
shop_name: "bill test shop1", # 店舗名
|
|
1430
1885
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
1431
|
-
lower_limit_amount:
|
|
1432
|
-
upper_limit_amount:
|
|
1433
|
-
is_disabled:
|
|
1886
|
+
lower_limit_amount: 4641, # 金額の範囲によるフィルタ(下限)
|
|
1887
|
+
upper_limit_amount: 6221, # 金額の範囲によるフィルタ(上限)
|
|
1888
|
+
is_disabled: false # 支払いQRコードが無効化されているかどうか
|
|
1434
1889
|
))
|
|
1435
1890
|
```
|
|
1436
1891
|
|
|
@@ -1574,7 +2029,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
|
1574
2029
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
1575
2030
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
1576
2031
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
1577
|
-
amount:
|
|
2032
|
+
amount: 1634.0, # 支払い額
|
|
1578
2033
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
1579
2034
|
))
|
|
1580
2035
|
```
|
|
@@ -1598,7 +2053,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
|
1598
2053
|
```ruby
|
|
1599
2054
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
1600
2055
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
1601
|
-
amount:
|
|
2056
|
+
amount: 1886.0, # 支払い額
|
|
1602
2057
|
description: "test bill", # 説明文
|
|
1603
2058
|
is_disabled: true # 無効化されているかどうか
|
|
1604
2059
|
))
|
|
@@ -1663,9 +2118,9 @@ Cashtrayを作成します。
|
|
|
1663
2118
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
1664
2119
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1665
2120
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1666
|
-
|
|
2121
|
+
2307.0, # amount: 金額
|
|
1667
2122
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1668
|
-
expires_in:
|
|
2123
|
+
expires_in: 8664 # 失効時間(秒)
|
|
1669
2124
|
))
|
|
1670
2125
|
```
|
|
1671
2126
|
|
|
@@ -1826,9 +2281,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
|
1826
2281
|
```ruby
|
|
1827
2282
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
1828
2283
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
1829
|
-
amount:
|
|
2284
|
+
amount: 2956.0, # 金額
|
|
1830
2285
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1831
|
-
expires_in:
|
|
2286
|
+
expires_in: 5971 # 失効時間(秒)
|
|
1832
2287
|
))
|
|
1833
2288
|
```
|
|
1834
2289
|
|
|
@@ -1899,13 +2354,19 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
|
1899
2354
|
成功したときは[AccountDetail](#account-detail)オブジェクトを返します
|
|
1900
2355
|
<a name="update-account"></a>
|
|
1901
2356
|
#### ウォレット情報を更新する
|
|
1902
|
-
|
|
2357
|
+
ウォレットの状態を更新します。
|
|
2358
|
+
以下の項目が変更できます。
|
|
2359
|
+
|
|
2360
|
+
- ウォレットの凍結/凍結解除の切り替え(エンドユーザー、店舗ユーザー共通)
|
|
2361
|
+
- 店舗でチャージ可能かどうか(店舗ユーザのみ)
|
|
2362
|
+
|
|
2363
|
+
エンドユーザーのウォレット情報更新には UpdateCustomerAccount が使用できます。
|
|
1903
2364
|
```ruby
|
|
1904
2365
|
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
1905
2366
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1906
|
-
is_suspended:
|
|
1907
|
-
status: "
|
|
1908
|
-
can_transfer_topup:
|
|
2367
|
+
is_suspended: true, # ウォレットが凍結されているかどうか
|
|
2368
|
+
status: "suspended", # ウォレット状態
|
|
2369
|
+
can_transfer_topup: false # チャージ可能かどうか
|
|
1909
2370
|
))
|
|
1910
2371
|
```
|
|
1911
2372
|
|
|
@@ -1953,7 +2414,7 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
|
1953
2414
|
```ruby
|
|
1954
2415
|
response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
1955
2416
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1956
|
-
cashback:
|
|
2417
|
+
cashback: true # 返金有無
|
|
1957
2418
|
))
|
|
1958
2419
|
```
|
|
1959
2420
|
|
|
@@ -1984,11 +2445,11 @@ response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
|
1984
2445
|
```ruby
|
|
1985
2446
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
1986
2447
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1987
|
-
page:
|
|
1988
|
-
per_page:
|
|
1989
|
-
expires_at_from: "
|
|
1990
|
-
expires_at_to: "
|
|
1991
|
-
direction: "
|
|
2448
|
+
page: 3815, # ページ番号
|
|
2449
|
+
per_page: 4657, # 1ページ分の取引数
|
|
2450
|
+
expires_at_from: "2022-08-09T03:31:40.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
2451
|
+
expires_at_to: "2016-12-21T20:17:39.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
2452
|
+
direction: "asc" # 有効期限によるソート順序
|
|
1992
2453
|
))
|
|
1993
2454
|
```
|
|
1994
2455
|
|
|
@@ -2062,10 +2523,10 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
|
2062
2523
|
```ruby
|
|
2063
2524
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
2064
2525
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2065
|
-
page:
|
|
2066
|
-
per_page:
|
|
2067
|
-
expires_at_from: "
|
|
2068
|
-
expires_at_to: "
|
|
2526
|
+
page: 6026, # ページ番号
|
|
2527
|
+
per_page: 497, # 1ページ分の取引数
|
|
2528
|
+
expires_at_from: "2018-05-14T10:59:48.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
2529
|
+
expires_at_to: "2018-05-29T03:13:18.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
2069
2530
|
direction: "asc" # 有効期限によるソート順序
|
|
2070
2531
|
))
|
|
2071
2532
|
```
|
|
@@ -2135,14 +2596,15 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
2135
2596
|
---
|
|
2136
2597
|
成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
|
|
2137
2598
|
<a name="update-customer-account"></a>
|
|
2138
|
-
####
|
|
2139
|
-
|
|
2599
|
+
#### エンドユーザーのウォレット情報を更新する
|
|
2600
|
+
エンドユーザーのウォレットの状態を更新します。
|
|
2140
2601
|
```ruby
|
|
2141
2602
|
response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
2142
2603
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2143
|
-
status: "
|
|
2144
|
-
account_name: "
|
|
2145
|
-
external_id: "
|
|
2604
|
+
status: "active", # ウォレット状態
|
|
2605
|
+
account_name: "g7fbzWuGj28bjzoMkUfQZyG6ql9kvIc3ugQfVcwKEOAlMUYblAnOJUw5uYgLUj2LWIHcZ5Kh7Upt9fM2ThdFR4ZGmC3lYSdkRdIHlBo7iMGslQeLzTg9FCP6boJkANEWZ0xko5rtXdkjCZ6KXkiMx1kHTV", # アカウント名
|
|
2606
|
+
external_id: "bpRx79q", # 外部ID
|
|
2607
|
+
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
|
2146
2608
|
))
|
|
2147
2609
|
```
|
|
2148
2610
|
|
|
@@ -2183,10 +2645,35 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
|
2183
2645
|
```json
|
|
2184
2646
|
{
|
|
2185
2647
|
"type": "string",
|
|
2186
|
-
"maxLength": 50
|
|
2648
|
+
"maxLength": 50
|
|
2649
|
+
}
|
|
2650
|
+
```
|
|
2651
|
+
変更する外部IDです。
|
|
2652
|
+
|
|
2653
|
+
---
|
|
2654
|
+
`metadata`
|
|
2655
|
+
```json
|
|
2656
|
+
{
|
|
2657
|
+
"type": "string",
|
|
2658
|
+
"format": "json"
|
|
2187
2659
|
}
|
|
2188
2660
|
```
|
|
2189
|
-
|
|
2661
|
+
ウォレットに付加するメタデータをJSON文字列で指定します。
|
|
2662
|
+
指定できるJSON文字列には以下のような制約があります。
|
|
2663
|
+
- フラットな構造のJSONを文字列化したものであること。
|
|
2664
|
+
- keyは最大32文字の文字列(同じkeyを複数指定することはできません)
|
|
2665
|
+
- valueには128文字以下の文字列が指定できます
|
|
2666
|
+
|
|
2667
|
+
更新時に指定した内容でメタデータ全体が置き換えられることに注意してください。
|
|
2668
|
+
例えば、元々のメタデータが以下だったときに、
|
|
2669
|
+
|
|
2670
|
+
'{"key1":"foo","key2":"bar"}'
|
|
2671
|
+
|
|
2672
|
+
更新APIで以下のように更新するとします。
|
|
2673
|
+
|
|
2674
|
+
'{"key1":"baz"}'
|
|
2675
|
+
|
|
2676
|
+
このときkey1はfooからbazに更新され、key2に対するデータは消去されます。
|
|
2190
2677
|
|
|
2191
2678
|
---
|
|
2192
2679
|
成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
|
|
@@ -2196,15 +2683,15 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
|
2196
2683
|
```ruby
|
|
2197
2684
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
2198
2685
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2199
|
-
page:
|
|
2200
|
-
per_page:
|
|
2201
|
-
created_at_from: "
|
|
2202
|
-
created_at_to: "
|
|
2203
|
-
is_suspended:
|
|
2686
|
+
page: 6128, # ページ番号
|
|
2687
|
+
per_page: 8066, # 1ページ分のウォレット数
|
|
2688
|
+
created_at_from: "2023-01-19T13:14:54.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
2689
|
+
created_at_to: "2023-05-11T02:19:35.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
2690
|
+
is_suspended: true, # ウォレットが凍結状態かどうかでフィルターする
|
|
2204
2691
|
status: "pre-closed", # ウォレット状態
|
|
2205
|
-
external_id: "
|
|
2206
|
-
tel: "
|
|
2207
|
-
email: "
|
|
2692
|
+
external_id: "WGk7rsKgu2ihoMxDsfU3TC1A8fV5nkzyaMo6HNFjN1", # 外部ID
|
|
2693
|
+
tel: "0417-8464796", # エンドユーザーの電話番号
|
|
2694
|
+
email: "SnWyLCIiaS@mxOi.com" # エンドユーザーのメールアドレス
|
|
2208
2695
|
))
|
|
2209
2696
|
```
|
|
2210
2697
|
|
|
@@ -2310,14 +2797,17 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
|
2310
2797
|
---
|
|
2311
2798
|
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
2312
2799
|
<a name="create-customer-account"></a>
|
|
2313
|
-
####
|
|
2314
|
-
|
|
2800
|
+
#### 新規エンドユーザーをウォレットと共に追加する
|
|
2801
|
+
指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも新規に作成します。
|
|
2802
|
+
このAPIにより作成されたユーザは認証情報を持たないため、モバイルSDKやポケペイ標準アプリからはログインすることはできません。
|
|
2803
|
+
Partner APIのみから操作可能な特殊なユーザになります。
|
|
2804
|
+
システム全体をPartner APIのみで構成する場合にのみ使用してください。
|
|
2315
2805
|
```ruby
|
|
2316
2806
|
response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
2317
2807
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2318
2808
|
user_name: "ポケペイ太郎", # ユーザー名
|
|
2319
2809
|
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
|
2320
|
-
external_id: "
|
|
2810
|
+
external_id: "byCFBUZkKwMvzRhZdC9PIbxRIokrSMcAe6" # 外部ID
|
|
2321
2811
|
))
|
|
2322
2812
|
```
|
|
2323
2813
|
|
|
@@ -2371,11 +2861,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
|
|
|
2371
2861
|
```ruby
|
|
2372
2862
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
2373
2863
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2374
|
-
page:
|
|
2375
|
-
per_page:
|
|
2376
|
-
created_at_from: "
|
|
2377
|
-
created_at_to: "
|
|
2378
|
-
is_suspended:
|
|
2864
|
+
page: 8389, # ページ番号
|
|
2865
|
+
per_page: 7136, # 1ページ分のウォレット数
|
|
2866
|
+
created_at_from: "2020-05-15T00:42:37.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
2867
|
+
created_at_to: "2022-01-29T11:47:00.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
2868
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
|
2379
2869
|
))
|
|
2380
2870
|
```
|
|
2381
2871
|
|
|
@@ -2448,10 +2938,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
2448
2938
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2449
2939
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
2450
2940
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
2451
|
-
type: "
|
|
2452
|
-
is_modified:
|
|
2453
|
-
from: "
|
|
2454
|
-
to: "
|
|
2941
|
+
type: "topup", # 取引種別
|
|
2942
|
+
is_modified: false, # キャンセル済みかどうか
|
|
2943
|
+
from: "2017-09-16T11:42:09.000000+09:00", # 開始日時
|
|
2944
|
+
to: "2024-11-26T13:09:59.000000+09:00", # 終了日時
|
|
2455
2945
|
page: 1, # ページ番号
|
|
2456
2946
|
per_page: 50 # 1ページ分の取引数
|
|
2457
2947
|
))
|
|
@@ -2587,11 +3077,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
2587
3077
|
organization_code: "pocketchange", # 組織コード
|
|
2588
3078
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
2589
3079
|
name: "oxスーパー三田店", # 店舗名
|
|
2590
|
-
postal_code: "
|
|
3080
|
+
postal_code: "668-9111", # 店舗の郵便番号
|
|
2591
3081
|
address: "東京都港区芝...", # 店舗の住所
|
|
2592
|
-
tel: "
|
|
2593
|
-
email: "
|
|
2594
|
-
external_id: "
|
|
3082
|
+
tel: "033-1276205", # 店舗の電話番号
|
|
3083
|
+
email: "1zQxL4LWrE@kUrK.com", # 店舗のメールアドレス
|
|
3084
|
+
external_id: "UADYaUMS4V1xY0z6q9RliuqOBINm4Q", # 店舗の外部ID
|
|
2595
3085
|
page: 1, # ページ番号
|
|
2596
3086
|
per_page: 50 # 1ページ分の取引数
|
|
2597
3087
|
))
|
|
@@ -2716,11 +3206,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
2716
3206
|
```ruby
|
|
2717
3207
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
2718
3208
|
"oxスーパー三田店", # shop_name: 店舗名
|
|
2719
|
-
shop_postal_code: "
|
|
3209
|
+
shop_postal_code: "277-2891", # 店舗の郵便番号
|
|
2720
3210
|
shop_address: "東京都港区芝...", # 店舗の住所
|
|
2721
|
-
shop_tel: "
|
|
2722
|
-
shop_email: "
|
|
2723
|
-
shop_external_id: "
|
|
3211
|
+
shop_tel: "066-675620", # 店舗の電話番号
|
|
3212
|
+
shop_email: "X9mQJiEELV@lycf.com", # 店舗のメールアドレス
|
|
3213
|
+
shop_external_id: "dA0sn1Jp9ctBvXrxjspmUg2Jofbf", # 店舗の外部ID
|
|
2724
3214
|
organization_code: "ox-supermarket" # 組織コード
|
|
2725
3215
|
))
|
|
2726
3216
|
```
|
|
@@ -2730,14 +3220,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
|
2730
3220
|
```ruby
|
|
2731
3221
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
2732
3222
|
"oxスーパー三田店", # name: 店舗名
|
|
2733
|
-
postal_code: "
|
|
3223
|
+
postal_code: "4589973", # 店舗の郵便番号
|
|
2734
3224
|
address: "東京都港区芝...", # 店舗の住所
|
|
2735
|
-
tel: "
|
|
2736
|
-
email: "
|
|
2737
|
-
external_id: "
|
|
3225
|
+
tel: "091-3023234", # 店舗の電話番号
|
|
3226
|
+
email: "2ZMpE4WDor@4IAD.com", # 店舗のメールアドレス
|
|
3227
|
+
external_id: "HdTPsjhUsWbuhnbIUFlfv", # 店舗の外部ID
|
|
2738
3228
|
organization_code: "ox-supermarket", # 組織コード
|
|
2739
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2740
|
-
can_topup_private_money_ids: [
|
|
3229
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
3230
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
|
2741
3231
|
))
|
|
2742
3232
|
```
|
|
2743
3233
|
|
|
@@ -2808,12 +3298,12 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
|
2808
3298
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
2809
3299
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
2810
3300
|
name: "oxスーパー三田店", # 店舗名
|
|
2811
|
-
postal_code: "
|
|
3301
|
+
postal_code: "0436866", # 店舗の郵便番号
|
|
2812
3302
|
address: "東京都港区芝...", # 店舗の住所
|
|
2813
|
-
tel: "
|
|
2814
|
-
email: "
|
|
2815
|
-
external_id: "
|
|
2816
|
-
private_money_ids: [
|
|
3303
|
+
tel: "041-363-142", # 店舗の電話番号
|
|
3304
|
+
email: "D1VYnThEQO@Ltlk.com", # 店舗のメールアドレス
|
|
3305
|
+
external_id: "RPIAeI3C1kLwoSJ0t0xwzgZ3SAsjpAu", # 店舗の外部ID
|
|
3306
|
+
private_money_ids: [], # 店舗で有効にするマネーIDの配列
|
|
2817
3307
|
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
2818
3308
|
))
|
|
2819
3309
|
```
|
|
@@ -2915,8 +3405,8 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
|
2915
3405
|
```ruby
|
|
2916
3406
|
response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
2917
3407
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
|
2918
|
-
page:
|
|
2919
|
-
per_page:
|
|
3408
|
+
page: 7634, # ページ番号
|
|
3409
|
+
per_page: 5240 # 1ページ分の取引数
|
|
2920
3410
|
))
|
|
2921
3411
|
```
|
|
2922
3412
|
|
|
@@ -2956,12 +3446,14 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
|
2956
3446
|
成功したときは[PaginatedAccountDetails](#paginated-account-details)オブジェクトを返します
|
|
2957
3447
|
<a name="create-user-account"></a>
|
|
2958
3448
|
#### エンドユーザーのウォレットを作成する
|
|
3449
|
+
既存のエンドユーザーに対して、指定したマネーのウォレットを新規作成します
|
|
2959
3450
|
```ruby
|
|
2960
3451
|
response = $client.send(Pokepay::Request::CreateUserAccount.new(
|
|
2961
3452
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
|
2962
3453
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2963
|
-
name: "
|
|
2964
|
-
external_id: "
|
|
3454
|
+
name: "MExC1w6ifl9ZUstqj7jJ1Xazd0M0QE8si7WktomTSIs3sss0bSZ1cR5rMDg0iBD2et6R89vRehYIZbMh6MfShA8D4Ev7O7TGT70LQ2epxhXvfJrqwCwzvGv5tXB9341AdQSvr2jD2CPBEg6qDXhSH8hafJy0sDTnMPtA7T3E2nC8JZcqIcqZB2nkhw5Vunnh29qWQZz14xB891rP", # ウォレット名
|
|
3455
|
+
external_id: "V7FcdDeB61vcOZ1uNBAdr6lfzbfqKlnsG", # 外部ID
|
|
3456
|
+
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
|
|
2965
3457
|
))
|
|
2966
3458
|
```
|
|
2967
3459
|
|
|
@@ -2987,6 +3479,20 @@ response = $client.send(Pokepay::Request::CreateUserAccount.new(
|
|
|
2987
3479
|
|
|
2988
3480
|
作成するウォレットのマネーを指定します。このパラメータは必須です。
|
|
2989
3481
|
|
|
3482
|
+
---
|
|
3483
|
+
`metadata`
|
|
3484
|
+
```json
|
|
3485
|
+
{
|
|
3486
|
+
"type": "string",
|
|
3487
|
+
"format": "json"
|
|
3488
|
+
}
|
|
3489
|
+
```
|
|
3490
|
+
ウォレットに付加するメタデータをJSON文字列で指定します。
|
|
3491
|
+
指定できるJSON文字列には以下のような制約があります。
|
|
3492
|
+
- フラットな構造のJSONを文字列化したものであること。
|
|
3493
|
+
- keyは最大32文字の文字列(同じkeyを複数指定することはできません)
|
|
3494
|
+
- valueには128文字以下の文字列が指定できます
|
|
3495
|
+
|
|
2990
3496
|
---
|
|
2991
3497
|
成功したときは[AccountDetail](#account-detail)オブジェクトを返します
|
|
2992
3498
|
### Private Money
|
|
@@ -3021,8 +3527,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
|
3021
3527
|
```ruby
|
|
3022
3528
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
3023
3529
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3024
|
-
from: "2018-10-
|
|
3025
|
-
to: "
|
|
3530
|
+
from: "2018-10-18T14:12:36.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
3531
|
+
to: "2024-08-31T11:34:14.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
3026
3532
|
page: 1, # ページ番号
|
|
3027
3533
|
per_page: 50 # 1ページ分の取引数
|
|
3028
3534
|
))
|
|
@@ -3035,8 +3541,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
3035
3541
|
```ruby
|
|
3036
3542
|
response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
3037
3543
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3038
|
-
from: "
|
|
3039
|
-
to: "2020-
|
|
3544
|
+
from: "2024-07-16T14:28:27.000000+09:00", # 開始日時
|
|
3545
|
+
to: "2020-09-28T12:35:03.000000+09:00" # 終了日時
|
|
3040
3546
|
))
|
|
3041
3547
|
```
|
|
3042
3548
|
成功したときは[PrivateMoneySummary](#private-money-summary)オブジェクトを返します
|
|
@@ -3046,10 +3552,11 @@ response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
|
3046
3552
|
CSVファイルから一括取引をします。
|
|
3047
3553
|
```ruby
|
|
3048
3554
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
3049
|
-
"
|
|
3050
|
-
"
|
|
3051
|
-
"
|
|
3052
|
-
description: "
|
|
3555
|
+
"RT90mTv9imeNiY62B", # name: 一括取引タスク名
|
|
3556
|
+
"0n5y", # content: 取引する情報のCSV
|
|
3557
|
+
"xxXvKDa0c2v5NvERR1ovUoSMxuwois43hKOt", # request_id: リクエストID
|
|
3558
|
+
description: "AoX7opuae", # 一括取引の説明
|
|
3559
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # マネーID
|
|
3053
3560
|
))
|
|
3054
3561
|
```
|
|
3055
3562
|
|
|
@@ -3112,6 +3619,16 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
|
3112
3619
|
```
|
|
3113
3620
|
重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
|
|
3114
3621
|
|
|
3622
|
+
---
|
|
3623
|
+
`private_money_id`
|
|
3624
|
+
```json
|
|
3625
|
+
{
|
|
3626
|
+
"type": "string",
|
|
3627
|
+
"format": "uuid"
|
|
3628
|
+
}
|
|
3629
|
+
```
|
|
3630
|
+
マネーIDです。 マネーを指定します。
|
|
3631
|
+
|
|
3115
3632
|
---
|
|
3116
3633
|
成功したときは[BulkTransaction](#bulk-transaction)オブジェクトを返します
|
|
3117
3634
|
### Event
|
|
@@ -3126,7 +3643,7 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
|
3126
3643
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
3127
3644
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
3128
3645
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3129
|
-
|
|
3646
|
+
10000, # amount: 取引額
|
|
3130
3647
|
description: "たい焼き(小倉)", # 取引説明文
|
|
3131
3648
|
metadata: "{\"key\":\"value\"}", # ポケペイ外部取引メタデータ
|
|
3132
3649
|
products: [{"jan_code":"abc",
|
|
@@ -3275,24 +3792,29 @@ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
|
|
|
3275
3792
|
|
|
3276
3793
|
```ruby
|
|
3277
3794
|
response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3278
|
-
"
|
|
3795
|
+
"8Ae6hTnrFSjbB1hiRjTNSU46DKPvyktKcWCyKm4tG2FzeWXxPN6RiMVhZmmGj0TMjPFLM0DLdwVX1nfPZtzGunVJbtCnsdFVcjFxpkr7nBijaa4uqZKlbpHQT4mZQDB6u1kMJt8otXLMwiqJK6MisPTXvJ9APWVf0nkI2cpiZrwht02dhTsSxN", # name: キャンペーン名
|
|
3279
3796
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3280
|
-
"
|
|
3281
|
-
"2022-
|
|
3282
|
-
|
|
3283
|
-
"
|
|
3797
|
+
"2025-08-02T21:20:39.000000+09:00", # starts_at: キャンペーン開始日時
|
|
3798
|
+
"2022-06-12T21:12:38.000000+09:00", # ends_at: キャンペーン終了日時
|
|
3799
|
+
1924, # priority: キャンペーンの適用優先度
|
|
3800
|
+
"external-transaction", # event: イベント種別
|
|
3284
3801
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント負担先店舗ID
|
|
3285
|
-
description: "
|
|
3286
|
-
status: "
|
|
3287
|
-
point_expires_at: "
|
|
3288
|
-
point_expires_in_days:
|
|
3289
|
-
is_exclusive:
|
|
3802
|
+
description: "hLAxPxLgPF7PH9jsPo3qRbXC06hH5q5N6rSqlhclxbbI1pwNVNkX1wbtHq7h4XHkBbxR0RnLtirGJS2N5S6EEO5Bp0TaBrmndiCNxXXwjFaRAeTxfe0YQCHzm8OG8zcqkOxIGcWZjjM6j3edDcpZu9iiEwcokneeQ36NR2IjhyB4vKQ7cGlo7SrCjimdlgwn9", # キャンペーンの説明文
|
|
3803
|
+
status: "disabled", # キャンペーン作成時の状態
|
|
3804
|
+
point_expires_at: "2018-05-06T19:57:31.000000+09:00", # ポイント有効期限(絶対日時指定)
|
|
3805
|
+
point_expires_in_days: 2550, # ポイント有効期限(相対日数指定)
|
|
3806
|
+
is_exclusive: false, # キャンペーンの重複設定
|
|
3290
3807
|
subject: "all", # ポイント付与の対象金額の種別
|
|
3291
3808
|
amount_based_point_rules: [{
|
|
3292
3809
|
"point_amount": 5,
|
|
3293
3810
|
"point_amount_unit": "percent",
|
|
3294
3811
|
"subject_more_than_or_equal": 1000,
|
|
3295
3812
|
"subject_less_than": 5000
|
|
3813
|
+
}, {
|
|
3814
|
+
"point_amount": 5,
|
|
3815
|
+
"point_amount_unit": "percent",
|
|
3816
|
+
"subject_more_than_or_equal": 1000,
|
|
3817
|
+
"subject_less_than": 5000
|
|
3296
3818
|
}], # 取引金額ベースのポイント付与ルール
|
|
3297
3819
|
product_based_point_rules: [{
|
|
3298
3820
|
"point_amount": 5,
|
|
@@ -3300,18 +3822,34 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
|
3300
3822
|
"product_code": "4912345678904",
|
|
3301
3823
|
"is_multiply_by_count": true,
|
|
3302
3824
|
"required_count": 2
|
|
3825
|
+
}, {
|
|
3826
|
+
"point_amount": 5,
|
|
3827
|
+
"point_amount_unit": "percent",
|
|
3828
|
+
"product_code": "4912345678904",
|
|
3829
|
+
"is_multiply_by_count": true,
|
|
3830
|
+
"required_count": 2
|
|
3831
|
+
}, {
|
|
3832
|
+
"point_amount": 5,
|
|
3833
|
+
"point_amount_unit": "percent",
|
|
3834
|
+
"product_code": "4912345678904",
|
|
3835
|
+
"is_multiply_by_count": true,
|
|
3836
|
+
"required_count": 2
|
|
3303
3837
|
}], # 商品情報ベースのポイント付与ルール
|
|
3304
|
-
applicable_days_of_week: [
|
|
3838
|
+
applicable_days_of_week: [3, 0, 6], # キャンペーンを適用する曜日 (複数指定)
|
|
3305
3839
|
applicable_time_ranges: [{
|
|
3306
3840
|
"from": "12:00",
|
|
3307
3841
|
"to": "23:59"
|
|
3308
|
-
}, {
|
|
3309
|
-
"from": "12:00",
|
|
3310
|
-
"to": "23:59"
|
|
3311
3842
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
|
3312
|
-
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
3313
|
-
minimum_number_for_combination_purchase:
|
|
3314
|
-
|
|
3843
|
+
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3844
|
+
minimum_number_for_combination_purchase: 4750, # 複数種類の商品を同時購入するときの商品種別数の下限
|
|
3845
|
+
exist_in_each_product_groups: true, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
|
3846
|
+
max_point_amount: 713, # キャンペーンによって付与されるポイントの上限
|
|
3847
|
+
max_total_point_amount: 7524, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
|
3848
|
+
dest_private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント付与先となるマネーID
|
|
3849
|
+
applicable_account_metadata: {
|
|
3850
|
+
"key": "sex",
|
|
3851
|
+
"value": "male"
|
|
3852
|
+
} # ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
|
3315
3853
|
))
|
|
3316
3854
|
```
|
|
3317
3855
|
|
|
@@ -3645,6 +4183,116 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
3645
4183
|
}
|
|
3646
4184
|
```
|
|
3647
4185
|
|
|
4186
|
+
---
|
|
4187
|
+
`exist_in_each_product_groups`
|
|
4188
|
+
```json
|
|
4189
|
+
{ "type": "boolean" }
|
|
4190
|
+
```
|
|
4191
|
+
複数の商品グループの各グループにつき1種類以上の商品が購入されることによって発火するキャンペーンであるときに真を指定します。デフォルトは偽です。
|
|
4192
|
+
|
|
4193
|
+
このパラメータを指定するときは product_based_point_rules で商品毎のルールが指定され、さらにその中でgroup_idが指定されている必要があります。group_idは正の整数です。
|
|
4194
|
+
exist_in_each_product_groupsが指定されているにも関わらず商品毎のルールでgroup_idが指定されていないものが含まれている場合はinvalid_parametersエラー(missing group_id, エラーコード400)が返ります。
|
|
4195
|
+
|
|
4196
|
+
例えば、商品グループA(商品コードa1, a2)、商品グループB(商品コードb1, b2)の2つの商品グループがあるとします。
|
|
4197
|
+
このとき、各商品グループからそれぞれ少なくとも1種類以上の商品が購入されることにより発火するキャンペーンに対するリクエストパラメータは以下のようなものになります。
|
|
4198
|
+
|
|
4199
|
+
```javascript
|
|
4200
|
+
{
|
|
4201
|
+
exist_in_each_product_groups: true,
|
|
4202
|
+
product_based_point_rules: [
|
|
4203
|
+
{
|
|
4204
|
+
"point_amount": 100,
|
|
4205
|
+
"point_amount_unit": "absolute",
|
|
4206
|
+
"product_code": "a1",
|
|
4207
|
+
"group_id": 1
|
|
4208
|
+
},
|
|
4209
|
+
{
|
|
4210
|
+
"point_amount": 100,
|
|
4211
|
+
"point_amount_unit": "absolute",
|
|
4212
|
+
"product_code": "a2",
|
|
4213
|
+
"group_id": 1
|
|
4214
|
+
},
|
|
4215
|
+
{
|
|
4216
|
+
"point_amount": 200,
|
|
4217
|
+
"point_amount_unit": "absolute",
|
|
4218
|
+
"product_code": "b1",
|
|
4219
|
+
"group_id": 2
|
|
4220
|
+
},
|
|
4221
|
+
{
|
|
4222
|
+
"point_amount": 200,
|
|
4223
|
+
"point_amount_unit": "absolute",
|
|
4224
|
+
"product_code": "b2",
|
|
4225
|
+
"group_id": 2
|
|
4226
|
+
}
|
|
4227
|
+
]
|
|
4228
|
+
}
|
|
4229
|
+
```
|
|
4230
|
+
|
|
4231
|
+
このキャンペーンが設定された状態で、商品a1、b1が同時に購入された場合、各商品に対する個別のルールが適用された上での総和がポイント付与値になります。つまり100 + 200=300がポイント付与値になります。商品a1、a2、 b1、b2が同時に購入された場合は100 + 100 + 200 + 200=600がポイント付与値になります。 商品a1、a2が同時に購入された場合は全商品グループから1種以上購入されるという条件を満たしていないためポイントは付与されません。
|
|
4232
|
+
|
|
4233
|
+
ポイント付与値を各商品毎のルールの総和ではなく固定値にしたい場合には、max_point_amountを指定します。
|
|
4234
|
+
例えば以下のようなリクエストパラメータ指定の場合を考えます。
|
|
4235
|
+
|
|
4236
|
+
```javascript
|
|
4237
|
+
{
|
|
4238
|
+
max_point_amount: 100,
|
|
4239
|
+
exist_in_each_product_groups: true,
|
|
4240
|
+
product_based_point_rules: [
|
|
4241
|
+
{
|
|
4242
|
+
"point_amount": 100,
|
|
4243
|
+
"point_amount_unit": "absolute",
|
|
4244
|
+
"product_code": "a1",
|
|
4245
|
+
"group_id": 1
|
|
4246
|
+
},
|
|
4247
|
+
{
|
|
4248
|
+
"point_amount": 100,
|
|
4249
|
+
"point_amount_unit": "absolute",
|
|
4250
|
+
"product_code": "a2",
|
|
4251
|
+
"group_id": 1
|
|
4252
|
+
},
|
|
4253
|
+
{
|
|
4254
|
+
"point_amount": 100,
|
|
4255
|
+
"point_amount_unit": "absolute",
|
|
4256
|
+
"product_code": "b1",
|
|
4257
|
+
"group_id": 2
|
|
4258
|
+
},
|
|
4259
|
+
{
|
|
4260
|
+
"point_amount": 100,
|
|
4261
|
+
"point_amount_unit": "absolute",
|
|
4262
|
+
"product_code": "b2",
|
|
4263
|
+
"group_id": 2
|
|
4264
|
+
}
|
|
4265
|
+
]
|
|
4266
|
+
}
|
|
4267
|
+
```
|
|
4268
|
+
|
|
4269
|
+
このキャンペーンが設定された状態で、商品a1、b1が同時に購入された場合、各商品に対する個別のルールが適用された上での総和がポイント付与値になりますが、付与値の上限が100ポイントになります。つまり100 + 200=300と計算されますが上限額の100ポイントが実際の付与値になります。商品a1、a2、 b1、b2が同時に購入された場合は100 + 100 + 200 + 200=600ですが上限額の100がポイント付与値になります。 商品a1、a2が同時に購入された場合は全商品グループから1種以上購入されるという条件を満たしていないためポイントは付与されません。
|
|
4270
|
+
|
|
4271
|
+
---
|
|
4272
|
+
`max_point_amount`
|
|
4273
|
+
```json
|
|
4274
|
+
{
|
|
4275
|
+
"type": "integer",
|
|
4276
|
+
"minimum": 1
|
|
4277
|
+
}
|
|
4278
|
+
```
|
|
4279
|
+
キャンペーンによって付与されるポイントの上限を指定します。デフォルトは未指定です。
|
|
4280
|
+
|
|
4281
|
+
このパラメータが指定されている場合、amount_based_point_rules や product_based_point_rules によって計算されるポイント付与値がmax_point_amountを越えている場合、max_point_amountの値がポイント付与値となり、越えていない場合はその値がポイント付与値となります。
|
|
4282
|
+
|
|
4283
|
+
---
|
|
4284
|
+
`max_total_point_amount`
|
|
4285
|
+
```json
|
|
4286
|
+
{
|
|
4287
|
+
"type": "integer",
|
|
4288
|
+
"minimum": 1
|
|
4289
|
+
}
|
|
4290
|
+
```
|
|
4291
|
+
キャンペーンによって付与される1人当たりの累計ポイント数の上限を指定します。デフォルトは未指定です。
|
|
4292
|
+
|
|
4293
|
+
このパラメータが指定されている場合、各ユーザに対してそのキャンペーンによって過去付与されたポイントの累積値が記録されるようになります。
|
|
4294
|
+
累積ポイント数がmax_total_point_amountを超えない限りにおいてキャンペーンで算出されたポイントが付与されます。
|
|
4295
|
+
|
|
3648
4296
|
---
|
|
3649
4297
|
`dest_private_money_id`
|
|
3650
4298
|
```json
|
|
@@ -3663,6 +4311,37 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
3663
4311
|
|
|
3664
4312
|
別マネーに対するポイント付与は別のtransactionとなります。 RefundTransaction で元のイベントをキャンセルしたときはポイント付与のtransactionもキャンセルされ、逆にポイント付与のtransactionをキャンセルしたときは連動して元のイベントがキャンセルされます。
|
|
3665
4313
|
|
|
4314
|
+
---
|
|
4315
|
+
`applicable_account_metadata`
|
|
4316
|
+
```json
|
|
4317
|
+
{ "type": "object" }
|
|
4318
|
+
```
|
|
4319
|
+
ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
|
4320
|
+
メタデータの属性名 key とメタデータの値 value の組をオブジェクトとして指定します。
|
|
4321
|
+
ウォレットのメタデータはCreateUserAccountやUpdateCustomerAccountで登録できます。
|
|
4322
|
+
|
|
4323
|
+
オプショナルパラメータtestによって比較方法を指定することができます。
|
|
4324
|
+
デフォルトは equal で、その他に not-equalを指定可能です。
|
|
4325
|
+
|
|
4326
|
+
例1: 取引が行なわれたウォレットのメタデータに住所として東京が指定されているときのみ発火
|
|
4327
|
+
|
|
4328
|
+
```javascript
|
|
4329
|
+
{
|
|
4330
|
+
"key": "prefecture",
|
|
4331
|
+
"value": "tokyo"
|
|
4332
|
+
}
|
|
4333
|
+
```
|
|
4334
|
+
|
|
4335
|
+
例2: 取引が行なわれたウォレットのメタデータに住所として東京以外が指定されているときのみ発火
|
|
4336
|
+
|
|
4337
|
+
```javascript
|
|
4338
|
+
{
|
|
4339
|
+
"key": "prefecture",
|
|
4340
|
+
"value": "tokyo",
|
|
4341
|
+
"test": "not-equal"
|
|
4342
|
+
}
|
|
4343
|
+
```
|
|
4344
|
+
|
|
3666
4345
|
---
|
|
3667
4346
|
成功したときは[Campaign](#campaign)オブジェクトを返します
|
|
3668
4347
|
<a name="list-campaigns"></a>
|
|
@@ -3673,7 +4352,7 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
3673
4352
|
```ruby
|
|
3674
4353
|
response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
3675
4354
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3676
|
-
is_ongoing:
|
|
4355
|
+
is_ongoing: false, # 現在適用可能なキャンペーンかどうか
|
|
3677
4356
|
page: 1, # ページ番号
|
|
3678
4357
|
per_page: 50 # 1ページ分の取得数
|
|
3679
4358
|
))
|
|
@@ -3754,15 +4433,15 @@ response = $client.send(Pokepay::Request::GetCampaign.new(
|
|
|
3754
4433
|
```ruby
|
|
3755
4434
|
response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
3756
4435
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # campaign_id: キャンペーンID
|
|
3757
|
-
name: "
|
|
3758
|
-
starts_at: "
|
|
3759
|
-
ends_at: "
|
|
3760
|
-
priority:
|
|
3761
|
-
event: "
|
|
3762
|
-
description: "
|
|
4436
|
+
name: "SNTCm30yK3y8WItCe9VYgMydEalG76qE4T1vOrKA4IwgS5AgijWRyxneekV8cIDT0hnm8h8evW68NKpdkq0PMSo6iR11TAHpgNTXOxFwqhkpZVaDhpFPp5bfKVt9DPYJAVzV6", # キャンペーン名
|
|
4437
|
+
starts_at: "2016-12-14T08:46:35.000000+09:00", # キャンペーン開始日時
|
|
4438
|
+
ends_at: "2024-01-23T12:45:50.000000+09:00", # キャンペーン終了日時
|
|
4439
|
+
priority: 6473, # キャンペーンの適用優先度
|
|
4440
|
+
event: "external-transaction", # イベント種別
|
|
4441
|
+
description: "6ywfpyKilj5zg8pn57kF0DYbPLXjuwrpeD0A9I", # キャンペーンの説明文
|
|
3763
4442
|
status: "enabled", # キャンペーン作成時の状態
|
|
3764
|
-
point_expires_at: "
|
|
3765
|
-
point_expires_in_days:
|
|
4443
|
+
point_expires_at: "2022-09-02T08:10:56.000000+09:00", # ポイント有効期限(絶対日時指定)
|
|
4444
|
+
point_expires_in_days: 8245, # ポイント有効期限(相対日数指定)
|
|
3766
4445
|
is_exclusive: false, # キャンペーンの重複設定
|
|
3767
4446
|
subject: "money", # ポイント付与の対象金額の種別
|
|
3768
4447
|
amount_based_point_rules: [{
|
|
@@ -3775,11 +4454,6 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
|
3775
4454
|
"point_amount_unit": "percent",
|
|
3776
4455
|
"subject_more_than_or_equal": 1000,
|
|
3777
4456
|
"subject_less_than": 5000
|
|
3778
|
-
}, {
|
|
3779
|
-
"point_amount": 5,
|
|
3780
|
-
"point_amount_unit": "percent",
|
|
3781
|
-
"subject_more_than_or_equal": 1000,
|
|
3782
|
-
"subject_less_than": 5000
|
|
3783
4457
|
}], # 取引金額ベースのポイント付与ルール
|
|
3784
4458
|
product_based_point_rules: [{
|
|
3785
4459
|
"point_amount": 5,
|
|
@@ -3794,16 +4468,20 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
|
3794
4468
|
"is_multiply_by_count": true,
|
|
3795
4469
|
"required_count": 2
|
|
3796
4470
|
}], # 商品情報ベースのポイント付与ルール
|
|
3797
|
-
applicable_days_of_week: [
|
|
4471
|
+
applicable_days_of_week: [6, 6], # キャンペーンを適用する曜日 (複数指定)
|
|
3798
4472
|
applicable_time_ranges: [{
|
|
3799
4473
|
"from": "12:00",
|
|
3800
4474
|
"to": "23:59"
|
|
3801
|
-
}, {
|
|
3802
|
-
"from": "12:00",
|
|
3803
|
-
"to": "23:59"
|
|
3804
4475
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
|
3805
4476
|
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3806
|
-
minimum_number_for_combination_purchase:
|
|
4477
|
+
minimum_number_for_combination_purchase: 3098, # 複数種類の商品を同時購入するときの商品種別数の下限
|
|
4478
|
+
exist_in_each_product_groups: false, # 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
|
|
4479
|
+
max_point_amount: 3684, # キャンペーンによって付与されるポイントの上限
|
|
4480
|
+
max_total_point_amount: 1594, # キャンペーンによって付与されるの1人当たりの累計ポイントの上限
|
|
4481
|
+
applicable_account_metadata: {
|
|
4482
|
+
"key": "sex",
|
|
4483
|
+
"value": "male"
|
|
4484
|
+
} # ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
|
3807
4485
|
))
|
|
3808
4486
|
```
|
|
3809
4487
|
|
|
@@ -4128,6 +4806,147 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4128
4806
|
}
|
|
4129
4807
|
```
|
|
4130
4808
|
|
|
4809
|
+
---
|
|
4810
|
+
`exist_in_each_product_groups`
|
|
4811
|
+
```json
|
|
4812
|
+
{ "type": "boolean" }
|
|
4813
|
+
```
|
|
4814
|
+
複数の商品グループの各グループにつき1種類以上の商品が購入されることによって発火するキャンペーンであるときに真を指定します。デフォルトは偽です。
|
|
4815
|
+
|
|
4816
|
+
このパラメータを指定するときは product_based_point_rules で商品毎のルールが指定され、さらにその中でgroup_idが指定されている必要があります。group_idは正の整数です。
|
|
4817
|
+
exist_in_each_product_groupsが指定されているにも関わらず商品毎のルールでgroup_idが指定されていないものが含まれている場合はinvalid_parametersエラー(missing group_id, エラーコード400)が返ります。
|
|
4818
|
+
|
|
4819
|
+
例えば、商品グループA(商品コードa1, a2)、商品グループB(商品コードb1, b2)の2つの商品グループがあるとします。
|
|
4820
|
+
このとき、各商品グループからそれぞれ少なくとも1種類以上の商品が購入されることにより発火するキャンペーンに対するリクエストパラメータは以下のようなものになります。
|
|
4821
|
+
|
|
4822
|
+
```javascript
|
|
4823
|
+
{
|
|
4824
|
+
exist_in_each_product_groups: true,
|
|
4825
|
+
product_based_point_rules: [
|
|
4826
|
+
{
|
|
4827
|
+
"point_amount": 100,
|
|
4828
|
+
"point_amount_unit": "absolute",
|
|
4829
|
+
"product_code": "a1",
|
|
4830
|
+
"group_id": 1
|
|
4831
|
+
},
|
|
4832
|
+
{
|
|
4833
|
+
"point_amount": 100,
|
|
4834
|
+
"point_amount_unit": "absolute",
|
|
4835
|
+
"product_code": "a2",
|
|
4836
|
+
"group_id": 1
|
|
4837
|
+
},
|
|
4838
|
+
{
|
|
4839
|
+
"point_amount": 200,
|
|
4840
|
+
"point_amount_unit": "absolute",
|
|
4841
|
+
"product_code": "b1",
|
|
4842
|
+
"group_id": 2
|
|
4843
|
+
},
|
|
4844
|
+
{
|
|
4845
|
+
"point_amount": 200,
|
|
4846
|
+
"point_amount_unit": "absolute",
|
|
4847
|
+
"product_code": "b2",
|
|
4848
|
+
"group_id": 2
|
|
4849
|
+
}
|
|
4850
|
+
]
|
|
4851
|
+
}
|
|
4852
|
+
```
|
|
4853
|
+
|
|
4854
|
+
このキャンペーンが設定された状態で、商品a1、b1が同時に購入された場合、各商品に対する個別のルールが適用された上での総和がポイント付与値になります。つまり100 + 200=300がポイント付与値になります。商品a1、a2、 b1、b2が同時に購入された場合は100 + 100 + 200 + 200=600がポイント付与値になります。 商品a1、a2が同時に購入された場合は全商品グループから1種以上購入されるという条件を満たしていないためポイントは付与されません。
|
|
4855
|
+
|
|
4856
|
+
ポイント付与値を各商品毎のルールの総和ではなく固定値にしたい場合には、max_point_amountを指定します。
|
|
4857
|
+
例えば以下のようなリクエストパラメータ指定の場合を考えます。
|
|
4858
|
+
|
|
4859
|
+
```javascript
|
|
4860
|
+
{
|
|
4861
|
+
max_point_amount: 100,
|
|
4862
|
+
exist_in_each_product_groups: true,
|
|
4863
|
+
product_based_point_rules: [
|
|
4864
|
+
{
|
|
4865
|
+
"point_amount": 100,
|
|
4866
|
+
"point_amount_unit": "absolute",
|
|
4867
|
+
"product_code": "a1",
|
|
4868
|
+
"group_id": 1
|
|
4869
|
+
},
|
|
4870
|
+
{
|
|
4871
|
+
"point_amount": 100,
|
|
4872
|
+
"point_amount_unit": "absolute",
|
|
4873
|
+
"product_code": "a2",
|
|
4874
|
+
"group_id": 1
|
|
4875
|
+
},
|
|
4876
|
+
{
|
|
4877
|
+
"point_amount": 100,
|
|
4878
|
+
"point_amount_unit": "absolute",
|
|
4879
|
+
"product_code": "b1",
|
|
4880
|
+
"group_id": 2
|
|
4881
|
+
},
|
|
4882
|
+
{
|
|
4883
|
+
"point_amount": 100,
|
|
4884
|
+
"point_amount_unit": "absolute",
|
|
4885
|
+
"product_code": "b2",
|
|
4886
|
+
"group_id": 2
|
|
4887
|
+
}
|
|
4888
|
+
]
|
|
4889
|
+
}
|
|
4890
|
+
```
|
|
4891
|
+
|
|
4892
|
+
このキャンペーンが設定された状態で、商品a1、b1が同時に購入された場合、各商品に対する個別のルールが適用された上での総和がポイント付与値になりますが、付与値の上限が100ポイントになります。つまり100 + 200=300と計算されますが上限額の100ポイントが実際の付与値になります。商品a1、a2、 b1、b2が同時に購入された場合は100 + 100 + 200 + 200=600ですが上限額の100がポイント付与値になります。 商品a1、a2が同時に購入された場合は全商品グループから1種以上購入されるという条件を満たしていないためポイントは付与されません。
|
|
4893
|
+
|
|
4894
|
+
---
|
|
4895
|
+
`max_point_amount`
|
|
4896
|
+
```json
|
|
4897
|
+
{
|
|
4898
|
+
"type": "integer",
|
|
4899
|
+
"minimum": 1
|
|
4900
|
+
}
|
|
4901
|
+
```
|
|
4902
|
+
キャンペーンによって付与される1取引当たりのポイント数の上限を指定します。デフォルトは未指定です。
|
|
4903
|
+
|
|
4904
|
+
このパラメータが指定されている場合、amount_based_point_rules や product_based_point_rules によって計算されるポイント付与値がmax_point_amountを越えている場合、max_point_amountの値がポイント付与値となり、越えていない場合はその値がポイント付与値となります。
|
|
4905
|
+
|
|
4906
|
+
---
|
|
4907
|
+
`max_total_point_amount`
|
|
4908
|
+
```json
|
|
4909
|
+
{
|
|
4910
|
+
"type": "integer",
|
|
4911
|
+
"minimum": 1
|
|
4912
|
+
}
|
|
4913
|
+
```
|
|
4914
|
+
キャンペーンによって付与される1人当たりの累計ポイント数の上限を指定します。デフォルトは未指定です。
|
|
4915
|
+
|
|
4916
|
+
このパラメータが指定されている場合、各ユーザに対してそのキャンペーンによって過去付与されたポイントの累積値が記録されるようになります。
|
|
4917
|
+
累積ポイント数がmax_total_point_amountを超えない限りにおいてキャンペーンで算出されたポイントが付与されます。
|
|
4918
|
+
|
|
4919
|
+
---
|
|
4920
|
+
`applicable_account_metadata`
|
|
4921
|
+
```json
|
|
4922
|
+
{ "type": "object" }
|
|
4923
|
+
```
|
|
4924
|
+
ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
|
|
4925
|
+
メタデータの属性名 key とメタデータの値 value の組をオブジェクトとして指定します。
|
|
4926
|
+
ウォレットのメタデータはCreateUserAccountやUpdateCustomerAccountで登録できます。
|
|
4927
|
+
|
|
4928
|
+
オプショナルパラメータtestによって比較方法を指定することができます。
|
|
4929
|
+
デフォルトは equal で、その他に not-equalを指定可能です。
|
|
4930
|
+
|
|
4931
|
+
例1: 取引が行なわれたウォレットのメタデータに住所として東京が指定されているときのみ発火
|
|
4932
|
+
|
|
4933
|
+
```javascript
|
|
4934
|
+
{
|
|
4935
|
+
"key": "prefecture",
|
|
4936
|
+
"value": "tokyo"
|
|
4937
|
+
}
|
|
4938
|
+
```
|
|
4939
|
+
|
|
4940
|
+
例2: 取引が行なわれたウォレットのメタデータに住所として東京以外が指定されているときのみ発火
|
|
4941
|
+
|
|
4942
|
+
```javascript
|
|
4943
|
+
{
|
|
4944
|
+
"key": "prefecture",
|
|
4945
|
+
"value": "tokyo",
|
|
4946
|
+
"test": "not-equal"
|
|
4947
|
+
}
|
|
4948
|
+
```
|
|
4949
|
+
|
|
4131
4950
|
---
|
|
4132
4951
|
成功したときは[Campaign](#campaign)オブジェクトを返します
|
|
4133
4952
|
## Responses
|
|
@@ -4155,6 +4974,7 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4155
4974
|
* `balance (double)`:
|
|
4156
4975
|
* `money_balance (double)`:
|
|
4157
4976
|
* `point_balance (double)`:
|
|
4977
|
+
* `point_debt (double)`:
|
|
4158
4978
|
* `private_money (PrivateMoney)`:
|
|
4159
4979
|
* `user (User)`:
|
|
4160
4980
|
* `external_id (string)`:
|
|
@@ -4179,6 +4999,29 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4179
4999
|
|
|
4180
5000
|
`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
|
|
4181
5001
|
|
|
5002
|
+
<a name="check"></a>
|
|
5003
|
+
## Check
|
|
5004
|
+
* `id (string)`: チャージQRコードのID
|
|
5005
|
+
* `created_at (string)`: チャージQRコードの作成日時
|
|
5006
|
+
* `amount (double)`: チャージマネー額 (deprecated)
|
|
5007
|
+
* `money_amount (double)`: チャージマネー額
|
|
5008
|
+
* `point_amount (double)`: チャージポイント額
|
|
5009
|
+
* `description (string)`: チャージQRコードの説明文(アプリ上で取引の説明文として表示される)
|
|
5010
|
+
* `user (User)`: 送金元ユーザ情報
|
|
5011
|
+
* `is_onetime (boolean)`: 使用回数が一回限りかどうか
|
|
5012
|
+
* `is_disabled (boolean)`: 無効化されているかどうか
|
|
5013
|
+
* `expires_at (string)`: チャージQRコード自体の失効日時
|
|
5014
|
+
* `private_money (PrivateMoney)`: 対象マネー情報
|
|
5015
|
+
* `usage_limit (integer)`: 一回限りでない場合の最大読み取り回数
|
|
5016
|
+
* `usage_count (double)`: 一回限りでない場合の現在までに読み取られた回数
|
|
5017
|
+
* `point_expires_at (string)`: ポイント有効期限(絶対日数指定)
|
|
5018
|
+
* `point_expires_in_days (integer)`: ポイント有効期限(相対日数指定)
|
|
5019
|
+
* `token (string)`: チャージQRコードを解析したときに出てくるURL
|
|
5020
|
+
|
|
5021
|
+
`user`は [User](#user) オブジェクトを返します。
|
|
5022
|
+
|
|
5023
|
+
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
5024
|
+
|
|
4182
5025
|
<a name="cpm-token"></a>
|
|
4183
5026
|
## CpmToken
|
|
4184
5027
|
* `cpm_token (string)`:
|
|
@@ -4317,6 +5160,17 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4317
5160
|
* `exchange_outflow_amount (double)`:
|
|
4318
5161
|
* `transaction_count (integer)`:
|
|
4319
5162
|
|
|
5163
|
+
<a name="user-stats-operation"></a>
|
|
5164
|
+
## UserStatsOperation
|
|
5165
|
+
* `id (string)`: 集計処理ID
|
|
5166
|
+
* `from (string)`: 集計期間の開始時刻
|
|
5167
|
+
* `to (string)`: 集計期間の終了時刻
|
|
5168
|
+
* `status (string)`: 集計処理の実行ステータス
|
|
5169
|
+
* `error_reason (string)`: エラーとなった理由
|
|
5170
|
+
* `done_at (string)`: 集計処理の完了時刻
|
|
5171
|
+
* `file_url (string)`: 集計結果のCSVのダウンロードURL
|
|
5172
|
+
* `requested_at (string)`: 集計リクエストを行った時刻
|
|
5173
|
+
|
|
4320
5174
|
<a name="paginated-transaction"></a>
|
|
4321
5175
|
## PaginatedTransaction
|
|
4322
5176
|
* `rows (array of Transactions)`:
|
|
@@ -4347,6 +5201,16 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4347
5201
|
|
|
4348
5202
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
4349
5203
|
|
|
5204
|
+
<a name="paginated-transfers-v2"></a>
|
|
5205
|
+
## PaginatedTransfersV2
|
|
5206
|
+
* `rows (array of Transfers)`:
|
|
5207
|
+
* `per_page (integer)`:
|
|
5208
|
+
* `count (integer)`:
|
|
5209
|
+
* `next_page_cursor_id (string)`:
|
|
5210
|
+
* `prev_page_cursor_id (string)`:
|
|
5211
|
+
|
|
5212
|
+
`rows`は [Transfer](#transfer) オブジェクトの配列を返します。
|
|
5213
|
+
|
|
4350
5214
|
<a name="paginated-account-with-users"></a>
|
|
4351
5215
|
## PaginatedAccountWithUsers
|
|
4352
5216
|
* `rows (array of AccountWithUsers)`:
|
|
@@ -4422,6 +5286,7 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4422
5286
|
* `bear_point_shop (User)`: ポイントを負担する店舗
|
|
4423
5287
|
* `private_money (PrivateMoney)`: キャンペーンを適用するマネー
|
|
4424
5288
|
* `dest_private_money (PrivateMoney)`: ポイントを付与するマネー
|
|
5289
|
+
* `max_total_point_amount (integer)`: 一人当たりの累計ポイント上限
|
|
4425
5290
|
* `point_calculation_rule (string)`: ポイント計算ルール (banklisp表記)
|
|
4426
5291
|
* `point_calculation_rule_object (string)`: ポイント計算ルール (JSON文字列による表記)
|
|
4427
5292
|
* `status (string)`: キャンペーンの現在の状態
|
|
@@ -4442,6 +5307,12 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4442
5307
|
|
|
4443
5308
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
4444
5309
|
|
|
5310
|
+
<a name="account-transfer-summary"></a>
|
|
5311
|
+
## AccountTransferSummary
|
|
5312
|
+
* `summaries (array of AccountTransferSummaryElements)`:
|
|
5313
|
+
|
|
5314
|
+
`summaries`は [AccountTransferSummaryElement](#account-transfer-summary-element) オブジェクトの配列を返します。
|
|
5315
|
+
|
|
4445
5316
|
<a name="private-money"></a>
|
|
4446
5317
|
## PrivateMoney
|
|
4447
5318
|
* `id (string)`: マネーID
|
|
@@ -4557,6 +5428,13 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4557
5428
|
* `email (string)`: 店舗のメールアドレス
|
|
4558
5429
|
* `external_id (string)`: 店舗の外部ID
|
|
4559
5430
|
|
|
5431
|
+
<a name="account-transfer-summary-element"></a>
|
|
5432
|
+
## AccountTransferSummaryElement
|
|
5433
|
+
* `transfer_type (string)`:
|
|
5434
|
+
* `money_amount (double)`:
|
|
5435
|
+
* `point_amount (double)`:
|
|
5436
|
+
* `count (double)`:
|
|
5437
|
+
|
|
4560
5438
|
<a name="organization"></a>
|
|
4561
5439
|
## Organization
|
|
4562
5440
|
* `code (string)`: 組織コード
|