pokepay_partner_ruby_sdk 0.1.19 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/index.md +245 -271
- data/lib/pokepay_partner_ruby_sdk/request/get_private_money_summary.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_transaction_by_request_id.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_transactions_v2.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/response/account.rb +1 -2
- data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb +1 -2
- data/lib/pokepay_partner_ruby_sdk/response/account_with_user.rb +1 -2
- data/lib/pokepay_partner_ruby_sdk/response/account_without_private_money_detail.rb +1 -2
- data/lib/pokepay_partner_ruby_sdk/response/private_money_summary.rb +27 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +3 -1
- data/partner.yaml +150 -30
- metadata +5 -3
- data/lib/pokepay_partner_ruby_sdk/response/account_status.rb +0 -11
data/docs/index.md
CHANGED
|
@@ -157,8 +157,8 @@ response.body
|
|
|
157
157
|
## API Operations
|
|
158
158
|
|
|
159
159
|
- [GetCpmToken](#get-cpm-token): CPMトークンの状態取得
|
|
160
|
-
- [ListTransactions](#list-transactions):
|
|
161
|
-
- [CreateTransaction](#create-transaction):
|
|
160
|
+
- [ListTransactions](#list-transactions): 【廃止】取引履歴を取得する
|
|
161
|
+
- [CreateTransaction](#create-transaction): 【廃止】チャージする
|
|
162
162
|
- [ListTransactionsV2](#list-transactions-v2): 取引履歴を取得する
|
|
163
163
|
- [CreateTopupTransaction](#create-topup-transaction): チャージする
|
|
164
164
|
- [CreatePaymentTransaction](#create-payment-transaction): 支払いする
|
|
@@ -167,8 +167,8 @@ response.body
|
|
|
167
167
|
- [CreateExchangeTransaction](#create-exchange-transaction):
|
|
168
168
|
- [GetTransaction](#get-transaction): 取引情報を取得する
|
|
169
169
|
- [RefundTransaction](#refund-transaction): 取引をキャンセルする
|
|
170
|
+
- [GetTransactionByRequestId](#get-transaction-by-request-id): リクエストIDから取引情報を取得する
|
|
170
171
|
- [ListTransfers](#list-transfers):
|
|
171
|
-
- [CreateCheck](#create-check): チャージQRコードの発行
|
|
172
172
|
- [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
|
|
173
173
|
- [ListBills](#list-bills): 支払いQRコード一覧を表示する
|
|
174
174
|
- [CreateBill](#create-bill): 支払いQRコードの発行
|
|
@@ -188,7 +188,7 @@ response.body
|
|
|
188
188
|
- [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
|
|
189
189
|
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
|
190
190
|
- [ListShops](#list-shops): 店舗一覧を取得する
|
|
191
|
-
- [CreateShop](#create-shop):
|
|
191
|
+
- [CreateShop](#create-shop): 【廃止】新規店舗を追加する
|
|
192
192
|
- [CreateShopV2](#create-shop-v2): 新規店舗を追加する
|
|
193
193
|
- [GetShop](#get-shop): 店舗情報を表示する
|
|
194
194
|
- [UpdateShop](#update-shop): 店舗情報を更新する
|
|
@@ -196,6 +196,7 @@ response.body
|
|
|
196
196
|
- [CreateUserAccount](#create-user-account): エンドユーザーのウォレットを作成する
|
|
197
197
|
- [GetPrivateMoneys](#get-private-moneys): マネー一覧を取得する
|
|
198
198
|
- [GetPrivateMoneyOrganizationSummaries](#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
|
|
199
|
+
- [GetPrivateMoneySummary](#get-private-money-summary): 取引サマリを取得する
|
|
199
200
|
- [BulkCreateTransaction](#bulk-create-transaction): CSVファイル一括取引
|
|
200
201
|
- [CreateExternalTransaction](#create-external-transaction): ポケペイ外部取引を作成する
|
|
201
202
|
- [RefundExternalTransaction](#refund-external-transaction): ポケペイ外部取引をキャンセルする
|
|
@@ -209,7 +210,7 @@ response.body
|
|
|
209
210
|
CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
|
|
210
211
|
```ruby
|
|
211
212
|
response = $client.send(Pokepay::Request::GetCpmToken.new(
|
|
212
|
-
"
|
|
213
|
+
"Jy0xSUaUZ3KYipGveNp11W" # cpm_token: CPMトークン
|
|
213
214
|
))
|
|
214
215
|
```
|
|
215
216
|
|
|
@@ -227,19 +228,19 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
|
|
|
227
228
|
---
|
|
228
229
|
成功したときは[CpmToken](#cpm-token)オブジェクトを返します
|
|
229
230
|
<a name="list-transactions"></a>
|
|
230
|
-
####
|
|
231
|
+
#### 【廃止】取引履歴を取得する
|
|
231
232
|
取引一覧を返します。
|
|
232
233
|
```ruby
|
|
233
234
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
234
|
-
from: "
|
|
235
|
-
to: "
|
|
235
|
+
from: "2017-05-13T01:06:09.000000+09:00", # 開始日時
|
|
236
|
+
to: "2022-02-07T15:19:13.000000+09:00", # 終了日時
|
|
236
237
|
page: 1, # ページ番号
|
|
237
238
|
per_page: 50, # 1ページ分の取引数
|
|
238
239
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
239
240
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
240
241
|
customer_name: "太郎", # エンドユーザー名
|
|
241
242
|
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
|
242
|
-
transaction_id: "
|
|
243
|
+
transaction_id: "r08u", # 取引ID
|
|
243
244
|
organization_code: "pocketchange", # 組織コード
|
|
244
245
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
245
246
|
is_modified: true, # キャンセルフラグ
|
|
@@ -343,14 +344,11 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
|
343
344
|
---
|
|
344
345
|
`transaction_id`
|
|
345
346
|
```json
|
|
346
|
-
{
|
|
347
|
-
"type": "string",
|
|
348
|
-
"format": "uuid"
|
|
349
|
-
}
|
|
347
|
+
{ "type": "string" }
|
|
350
348
|
```
|
|
351
349
|
取引IDです。
|
|
352
350
|
|
|
353
|
-
|
|
351
|
+
フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
|
|
354
352
|
|
|
355
353
|
---
|
|
356
354
|
`organization_code`
|
|
@@ -439,17 +437,17 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
|
439
437
|
---
|
|
440
438
|
成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
|
|
441
439
|
<a name="create-transaction"></a>
|
|
442
|
-
####
|
|
440
|
+
#### 【廃止】チャージする
|
|
443
441
|
チャージ取引を作成します。このAPIは廃止予定です。以降は `CreateTopupTransaction` を使用してください。
|
|
444
442
|
```ruby
|
|
445
443
|
response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
446
444
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
447
445
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
448
446
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
449
|
-
money_amount:
|
|
450
|
-
point_amount:
|
|
451
|
-
point_expires_at: "
|
|
452
|
-
description: "
|
|
447
|
+
money_amount: 7747,
|
|
448
|
+
point_amount: 3749,
|
|
449
|
+
point_expires_at: "2023-06-29T15:24:38.000000+09:00", # ポイント有効期限
|
|
450
|
+
description: "0JSt7hZNL6cvcqBnhGnyRs1ZbgEX46DL0EY9Dfg2K2KSBJ32yceHkpeJS53rQYrIERvl0KriuNlhP5RwfRsdmSnnsKFojcLOuuurZaaP5zVuitJAWBnMTQrqQLb4F279GcsdDtM3uSEYbuaOy1AtJbZFvX4DTrnYj6rE9HuWGm5xmBEPErYjV24xKSbfZiVFE"
|
|
453
451
|
))
|
|
454
452
|
```
|
|
455
453
|
|
|
@@ -471,20 +469,20 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
|
471
469
|
取引一覧を返します。
|
|
472
470
|
```ruby
|
|
473
471
|
response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
474
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
472
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
475
473
|
organization_code: "pocketchange", # 組織コード
|
|
476
474
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
477
475
|
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
|
478
476
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
479
477
|
customer_name: "太郎", # エンドユーザー名
|
|
480
478
|
description: "店頭QRコードによる支払い", # 取引説明文
|
|
481
|
-
transaction_id: "
|
|
482
|
-
is_modified:
|
|
479
|
+
transaction_id: "1mx2", # 取引ID
|
|
480
|
+
is_modified: true, # キャンセルフラグ
|
|
483
481
|
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
484
|
-
from: "
|
|
485
|
-
to: "
|
|
486
|
-
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", #
|
|
487
|
-
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", #
|
|
482
|
+
from: "2021-11-17T15:47:39.000000+09:00", # 開始日時
|
|
483
|
+
to: "2016-09-29T03:05:46.000000+09:00", # 終了日時
|
|
484
|
+
next_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 次ページへ遷移する際に起点となるtransactionのID
|
|
485
|
+
prev_page_cursor_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 前ページへ遷移する際に起点となるtransactionのID
|
|
488
486
|
per_page: 50 # 1ページ分の取引数
|
|
489
487
|
))
|
|
490
488
|
```
|
|
@@ -512,7 +510,7 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
512
510
|
```
|
|
513
511
|
組織コードです。
|
|
514
512
|
|
|
515
|
-
|
|
513
|
+
フィルターとして使われ、指定された組織の店舗での取引のみ一覧に表示されます。
|
|
516
514
|
|
|
517
515
|
---
|
|
518
516
|
`shop_id`
|
|
@@ -548,7 +546,7 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
548
546
|
```
|
|
549
547
|
エンドユーザーIDです。
|
|
550
548
|
|
|
551
|
-
|
|
549
|
+
フィルターとして使われ、指定されたエンドユーザーの取引のみ一覧に表示されます。
|
|
552
550
|
|
|
553
551
|
---
|
|
554
552
|
`customer_name`
|
|
@@ -577,14 +575,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
577
575
|
---
|
|
578
576
|
`transaction_id`
|
|
579
577
|
```json
|
|
580
|
-
{
|
|
581
|
-
"type": "string",
|
|
582
|
-
"format": "uuid"
|
|
583
|
-
}
|
|
578
|
+
{ "type": "string" }
|
|
584
579
|
```
|
|
585
580
|
取引IDです。
|
|
586
581
|
|
|
587
|
-
|
|
582
|
+
フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
|
|
588
583
|
|
|
589
584
|
---
|
|
590
585
|
`is_modified`
|
|
@@ -603,7 +598,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
603
598
|
"type": "array",
|
|
604
599
|
"items": {
|
|
605
600
|
"type": "string",
|
|
606
|
-
"enum":
|
|
601
|
+
"enum": {
|
|
602
|
+
"topup": "payment",
|
|
603
|
+
"exchange_outflow": "exchange_inflow",
|
|
604
|
+
"cashback": "expire"
|
|
605
|
+
}
|
|
607
606
|
}
|
|
608
607
|
}
|
|
609
608
|
```
|
|
@@ -619,13 +618,20 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
619
618
|
|
|
620
619
|
3. exchange-outflow
|
|
621
620
|
他マネーへの流出
|
|
621
|
+
private_money_idが指定されたとき、そのマネーから見て流出方向の交換取引が抽出されます。
|
|
622
|
+
private_money_idを省略した場合は表示されません。
|
|
622
623
|
|
|
623
624
|
4. exchange-inflow
|
|
624
625
|
他マネーからの流入
|
|
626
|
+
private_money_idが指定されたとき、そのマネーから見て流入方向の交換取引が抽出されます。
|
|
627
|
+
private_money_idを省略した場合は表示されません。
|
|
625
628
|
|
|
626
629
|
5. cashback
|
|
627
630
|
退会時返金取引
|
|
628
631
|
|
|
632
|
+
6. expire
|
|
633
|
+
退会時失効取引
|
|
634
|
+
|
|
629
635
|
---
|
|
630
636
|
`from`
|
|
631
637
|
```json
|
|
@@ -658,9 +664,11 @@ response = $client.send(Pokepay::Request::ListTransactionsV2.new(
|
|
|
658
664
|
"format": "uuid"
|
|
659
665
|
}
|
|
660
666
|
```
|
|
661
|
-
|
|
667
|
+
次ページへ遷移する際に起点となるtransactionのID(前ページの末尾要素のID)です。
|
|
668
|
+
本APIのレスポンスにもnext_page_cursor_idが含まれており、これがnull値の場合は最後のページであることを意味します。
|
|
669
|
+
UUIDである場合は次のページが存在することを意味し、このnext_page_cursor_idをリクエストパラメータに含めることで次ページに遷移します。
|
|
662
670
|
|
|
663
|
-
|
|
671
|
+
next_page_cursor_idのtransaction自体は次のページには含まれません。
|
|
664
672
|
|
|
665
673
|
---
|
|
666
674
|
`prev_page_cursor_id`
|
|
@@ -670,9 +678,12 @@ prev_page_cursor_idのtransaction自体は次のページには含まれない
|
|
|
670
678
|
"format": "uuid"
|
|
671
679
|
}
|
|
672
680
|
```
|
|
673
|
-
|
|
681
|
+
前ページへ遷移する際に起点となるtransactionのID(次ページの先頭要素のID)です。
|
|
674
682
|
|
|
675
|
-
|
|
683
|
+
本APIのレスポンスにもprev_page_cursor_idが含まれており、これがnull値の場合は先頭のページであることを意味します。
|
|
684
|
+
UUIDである場合は前のページが存在することを意味し、このprev_page_cursor_idをリクエストパラメータに含めることで前ページに遷移します。
|
|
685
|
+
|
|
686
|
+
prev_page_cursor_idのtransaction自体は前のページには含まれません。
|
|
676
687
|
|
|
677
688
|
---
|
|
678
689
|
`per_page`
|
|
@@ -680,7 +691,7 @@ next_page_cursor_idのtransaction自体は前のページには含まれない
|
|
|
680
691
|
{
|
|
681
692
|
"type": "integer",
|
|
682
693
|
"minimum": 1,
|
|
683
|
-
"maximum":
|
|
694
|
+
"maximum": 1000
|
|
684
695
|
}
|
|
685
696
|
```
|
|
686
697
|
1ページ分の取引数です。
|
|
@@ -698,9 +709,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
698
709
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
699
710
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
700
711
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
701
|
-
money_amount:
|
|
702
|
-
point_amount:
|
|
703
|
-
point_expires_at: "
|
|
712
|
+
money_amount: 2683, # マネー額
|
|
713
|
+
point_amount: 3676, # ポイント額
|
|
714
|
+
point_expires_at: "2022-01-06T17:19:53.000000+09:00", # ポイント有効期限
|
|
704
715
|
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
|
705
716
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
706
717
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
@@ -842,7 +853,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
842
853
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
843
854
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
844
855
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
845
|
-
|
|
856
|
+
8712, # amount: 支払い額
|
|
846
857
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
847
858
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
848
859
|
products: [{"jan_code":"abc",
|
|
@@ -850,16 +861,6 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
850
861
|
"unit_price":100,
|
|
851
862
|
"price": 100,
|
|
852
863
|
"is_discounted": false,
|
|
853
|
-
"other":"{}"}, {"jan_code":"abc",
|
|
854
|
-
"name":"name1",
|
|
855
|
-
"unit_price":100,
|
|
856
|
-
"price": 100,
|
|
857
|
-
"is_discounted": false,
|
|
858
|
-
"other":"{}"}, {"jan_code":"abc",
|
|
859
|
-
"name":"name1",
|
|
860
|
-
"unit_price":100,
|
|
861
|
-
"price": 100,
|
|
862
|
-
"is_discounted": false,
|
|
863
864
|
"other":"{}"}], # 商品情報データ
|
|
864
865
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
865
866
|
))
|
|
@@ -978,9 +979,9 @@ CPMトークンに設定されたスコープの取引を作ることができ
|
|
|
978
979
|
|
|
979
980
|
```ruby
|
|
980
981
|
response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
|
|
981
|
-
"
|
|
982
|
+
"fUftI30JyBIPqdCDvWnTRv", # cpm_token: CPMトークン
|
|
982
983
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
983
|
-
|
|
984
|
+
3211.0, # amount: 取引金額
|
|
984
985
|
description: "たい焼き(小倉)", # 取引説明文
|
|
985
986
|
metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
|
|
986
987
|
products: [{"jan_code":"abc",
|
|
@@ -1100,7 +1101,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
1100
1101
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
1101
1102
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
1102
1103
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1103
|
-
|
|
1104
|
+
3518.0, # amount: 送金額
|
|
1104
1105
|
metadata: "{\"key\":\"value\"}", # 取引メタデータ
|
|
1105
1106
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1106
1107
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
@@ -1202,8 +1203,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
|
1202
1203
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1203
1204
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1204
1205
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1205
|
-
|
|
1206
|
-
description: "
|
|
1206
|
+
2721.0,
|
|
1207
|
+
description: "MqT8Y2wPxWWXEUoqg0zXsuvc8LF4mbP1hyPDbNVjct5yQNjVn35rDh040vhQYw5VlT5PtGoiFuhhxPNxJedAo6IB1JwI4HtHPlHFEuPGo3GkdygOOVSyzQqeTxBrSdGB4t2pP3KohbOZsA8epkaCTJpPbbkDn1ZrOBafU",
|
|
1207
1208
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
1208
1209
|
))
|
|
1209
1210
|
```
|
|
@@ -1263,23 +1264,46 @@ response = $client.send(Pokepay::Request::RefundTransaction.new(
|
|
|
1263
1264
|
))
|
|
1264
1265
|
```
|
|
1265
1266
|
成功したときは[TransactionDetail](#transaction-detail)オブジェクトを返します
|
|
1267
|
+
<a name="get-transaction-by-request-id"></a>
|
|
1268
|
+
#### リクエストIDから取引情報を取得する
|
|
1269
|
+
取引を取得します。
|
|
1270
|
+
```ruby
|
|
1271
|
+
response = $client.send(Pokepay::Request::GetTransactionByRequestId.new(
|
|
1272
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # request_id: リクエストID
|
|
1273
|
+
))
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
---
|
|
1277
|
+
`request_id`
|
|
1278
|
+
```json
|
|
1279
|
+
{
|
|
1280
|
+
"type": "string",
|
|
1281
|
+
"format": "uuid"
|
|
1282
|
+
}
|
|
1283
|
+
```
|
|
1284
|
+
取引作成時にクライアントが生成し指定するリクエストIDです。
|
|
1285
|
+
|
|
1286
|
+
リクエストIDに対応する取引が存在すればその取引を返し、無ければNotFound(404)を返します。
|
|
1287
|
+
|
|
1288
|
+
---
|
|
1289
|
+
成功したときは[TransactionDetail](#transaction-detail)オブジェクトを返します
|
|
1266
1290
|
<a name="list-transfers"></a>
|
|
1267
1291
|
####
|
|
1268
1292
|
```ruby
|
|
1269
1293
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
1270
|
-
from: "
|
|
1271
|
-
to: "
|
|
1272
|
-
page:
|
|
1273
|
-
per_page:
|
|
1294
|
+
from: "2025-04-09T21:45:38.000000+09:00",
|
|
1295
|
+
to: "2025-05-08T03:30:36.000000+09:00",
|
|
1296
|
+
page: 8594,
|
|
1297
|
+
per_page: 7358,
|
|
1274
1298
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1275
|
-
shop_name: "
|
|
1299
|
+
shop_name: "XIV1wGp1Rn3U4KQsAmdVQrUihNu2f4606Zw3XOfvqGLqQiqaG2p9irVNMOOMEypf2sbMz5sG1GgyrO7oaIPGJ7JGBC1o5Rc96wfmVrWrKd8ZckndPnp3nLoMele3ppOb8vOALeCa",
|
|
1276
1300
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1277
|
-
customer_name: "
|
|
1301
|
+
customer_name: "VZzJ21Wkjwh096vY0YkfqArkVOxtHaQbqrekxj6KVFbsIqYgBl99xXSIGv3Ovn3SH7ljqEdpqCcPOpWjivoOnvdw0Yvld3IeJyhTlRgTT2NxSiphZRlLoLjMmLSHQhe4tHPdlvKxC8QojNKN0zqICt7BPEIs",
|
|
1278
1302
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1279
1303
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
1280
|
-
is_modified:
|
|
1281
|
-
transaction_types: ["
|
|
1282
|
-
transfer_types: ["
|
|
1304
|
+
is_modified: false,
|
|
1305
|
+
transaction_types: ["topup", "payment"],
|
|
1306
|
+
transfer_types: ["expire", "campaign", "cashback", "coupon", "payment", "transfer"], # 取引明細の種類でフィルターします。
|
|
1283
1307
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
1284
1308
|
))
|
|
1285
1309
|
```
|
|
@@ -1348,46 +1372,6 @@ response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
|
1348
1372
|
|
|
1349
1373
|
QRコードを読み取る方法以外にも、このURLリンクを直接スマートフォン(iOS/Android)上で開くことによりアプリが起動して取引が行われます。(注意: 上記URLはsandbox環境であるため、アプリもsandbox環境のものである必要があります) 上記URL中の `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージQRコードのIDです。
|
|
1350
1374
|
|
|
1351
|
-
<a name="create-check"></a>
|
|
1352
|
-
#### チャージQRコードの発行
|
|
1353
|
-
```ruby
|
|
1354
|
-
response = $client.send(Pokepay::Request::CreateCheck.new(
|
|
1355
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
|
|
1356
|
-
money_amount: 2773, # 付与マネー額
|
|
1357
|
-
point_amount: 1358, # 付与ポイント額
|
|
1358
|
-
description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
|
|
1359
|
-
is_onetime: true, # ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
|
|
1360
|
-
usage_limit: 8593, # ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
|
|
1361
|
-
expires_at: "2019-11-10T13:55:23.000000+09:00", # チャージQR自体の失効日時
|
|
1362
|
-
point_expires_at: "2024-02-07T20:52:41.000000+09:00", # チャージQRによって付与されるポイントの失効日時
|
|
1363
|
-
point_expires_in_days: 60, # チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
|
|
1364
|
-
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗アカウントのID
|
|
1365
|
-
))
|
|
1366
|
-
```
|
|
1367
|
-
`money_amount`と`point_amount`の少なくとも一方は指定する必要があります。
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
---
|
|
1371
|
-
`is_onetime`
|
|
1372
|
-
```json
|
|
1373
|
-
{ "type": "boolean" }
|
|
1374
|
-
```
|
|
1375
|
-
チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
|
|
1376
|
-
`false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
---
|
|
1380
|
-
`usage_limit`
|
|
1381
|
-
```json
|
|
1382
|
-
{ "type": "integer" }
|
|
1383
|
-
```
|
|
1384
|
-
複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
|
|
1385
|
-
省略すると無制限に読み取り可能なチャージQRコードになります。
|
|
1386
|
-
チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
---
|
|
1390
|
-
成功したときは[Check](#check)オブジェクトを返します
|
|
1391
1375
|
<a name="create-topup-transaction-with-check"></a>
|
|
1392
1376
|
#### チャージQRコードを読み取ることでチャージする
|
|
1393
1377
|
通常チャージQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
|
|
@@ -1434,18 +1418,18 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
1434
1418
|
支払いQRコード一覧を表示します。
|
|
1435
1419
|
```ruby
|
|
1436
1420
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
1437
|
-
page:
|
|
1438
|
-
per_page:
|
|
1439
|
-
bill_id: "
|
|
1421
|
+
page: 3721, # ページ番号
|
|
1422
|
+
per_page: 1673, # 1ページの表示数
|
|
1423
|
+
bill_id: "aPzoaDv6U", # 支払いQRコードのID
|
|
1440
1424
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1441
|
-
organization_code: "-
|
|
1425
|
+
organization_code: "E6j-k--y-tIpZw7XXFE--llNah699s4", # 組織コード
|
|
1442
1426
|
description: "test bill", # 取引説明文
|
|
1443
|
-
created_from: "
|
|
1444
|
-
created_to: "
|
|
1427
|
+
created_from: "2025-04-02T22:05:55.000000+09:00", # 作成日時(起点)
|
|
1428
|
+
created_to: "2019-09-01T07:20:32.000000+09:00", # 作成日時(終点)
|
|
1445
1429
|
shop_name: "bill test shop1", # 店舗名
|
|
1446
1430
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
1447
|
-
lower_limit_amount:
|
|
1448
|
-
upper_limit_amount:
|
|
1431
|
+
lower_limit_amount: 397, # 金額の範囲によるフィルタ(下限)
|
|
1432
|
+
upper_limit_amount: 6489, # 金額の範囲によるフィルタ(上限)
|
|
1449
1433
|
is_disabled: true # 支払いQRコードが無効化されているかどうか
|
|
1450
1434
|
))
|
|
1451
1435
|
```
|
|
@@ -1590,7 +1574,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
|
1590
1574
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
1591
1575
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
1592
1576
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
1593
|
-
amount:
|
|
1577
|
+
amount: 9427.0, # 支払い額
|
|
1594
1578
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
1595
1579
|
))
|
|
1596
1580
|
```
|
|
@@ -1614,9 +1598,9 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
|
1614
1598
|
```ruby
|
|
1615
1599
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
1616
1600
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
1617
|
-
amount:
|
|
1601
|
+
amount: 8693.0, # 支払い額
|
|
1618
1602
|
description: "test bill", # 説明文
|
|
1619
|
-
is_disabled:
|
|
1603
|
+
is_disabled: true # 無効化されているかどうか
|
|
1620
1604
|
))
|
|
1621
1605
|
```
|
|
1622
1606
|
|
|
@@ -1679,9 +1663,9 @@ Cashtrayを作成します。
|
|
|
1679
1663
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
1680
1664
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1681
1665
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1682
|
-
|
|
1666
|
+
5702.0, # amount: 金額
|
|
1683
1667
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1684
|
-
expires_in:
|
|
1668
|
+
expires_in: 1126 # 失効時間(秒)
|
|
1685
1669
|
))
|
|
1686
1670
|
```
|
|
1687
1671
|
|
|
@@ -1842,9 +1826,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
|
1842
1826
|
```ruby
|
|
1843
1827
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
1844
1828
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
1845
|
-
amount:
|
|
1829
|
+
amount: 5121.0, # 金額
|
|
1846
1830
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1847
|
-
expires_in:
|
|
1831
|
+
expires_in: 7304 # 失効時間(秒)
|
|
1848
1832
|
))
|
|
1849
1833
|
```
|
|
1850
1834
|
|
|
@@ -1920,7 +1904,7 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
|
1920
1904
|
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
1921
1905
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1922
1906
|
is_suspended: false, # ウォレットが凍結されているかどうか
|
|
1923
|
-
status: "
|
|
1907
|
+
status: "active", # ウォレット状態
|
|
1924
1908
|
can_transfer_topup: true # チャージ可能かどうか
|
|
1925
1909
|
))
|
|
1926
1910
|
```
|
|
@@ -1969,7 +1953,7 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
|
1969
1953
|
```ruby
|
|
1970
1954
|
response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
1971
1955
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1972
|
-
cashback:
|
|
1956
|
+
cashback: false # 返金有無
|
|
1973
1957
|
))
|
|
1974
1958
|
```
|
|
1975
1959
|
|
|
@@ -2000,10 +1984,10 @@ response = $client.send(Pokepay::Request::DeleteAccount.new(
|
|
|
2000
1984
|
```ruby
|
|
2001
1985
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
2002
1986
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2003
|
-
page:
|
|
2004
|
-
per_page:
|
|
2005
|
-
expires_at_from: "
|
|
2006
|
-
expires_at_to: "
|
|
1987
|
+
page: 44, # ページ番号
|
|
1988
|
+
per_page: 6157, # 1ページ分の取引数
|
|
1989
|
+
expires_at_from: "2016-10-30T20:32:25.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1990
|
+
expires_at_to: "2025-02-23T20:11:09.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
2007
1991
|
direction: "desc" # 有効期限によるソート順序
|
|
2008
1992
|
))
|
|
2009
1993
|
```
|
|
@@ -2078,11 +2062,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
|
2078
2062
|
```ruby
|
|
2079
2063
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
2080
2064
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2081
|
-
page:
|
|
2082
|
-
per_page:
|
|
2083
|
-
expires_at_from: "
|
|
2084
|
-
expires_at_to: "2016-
|
|
2085
|
-
direction: "
|
|
2065
|
+
page: 4079, # ページ番号
|
|
2066
|
+
per_page: 8964, # 1ページ分の取引数
|
|
2067
|
+
expires_at_from: "2019-05-12T09:41:36.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
2068
|
+
expires_at_to: "2016-06-19T12:48:33.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
2069
|
+
direction: "asc" # 有効期限によるソート順序
|
|
2086
2070
|
))
|
|
2087
2071
|
```
|
|
2088
2072
|
|
|
@@ -2157,8 +2141,8 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
2157
2141
|
response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
2158
2142
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
2159
2143
|
status: "pre-closed", # ウォレット状態
|
|
2160
|
-
account_name: "
|
|
2161
|
-
external_id: "
|
|
2144
|
+
account_name: "H7hF0T8Nh7eoO6asjOox0RRzWzgJ8qllmxnkMgshIHzbucfDhID3qemlo7JMNmGUe8JtqofMq1TyFcW0Uuc5ug2SpDoeGryI5OQQ9GoRehaS9O2M3fskqX8WbkxbWTp66iGj1lR", # アカウント名
|
|
2145
|
+
external_id: "9XuMVcs2zeQQbQwb51z" # 外部ID
|
|
2162
2146
|
))
|
|
2163
2147
|
```
|
|
2164
2148
|
|
|
@@ -2212,15 +2196,15 @@ response = $client.send(Pokepay::Request::UpdateCustomerAccount.new(
|
|
|
2212
2196
|
```ruby
|
|
2213
2197
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
2214
2198
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2215
|
-
page:
|
|
2216
|
-
per_page:
|
|
2217
|
-
created_at_from: "
|
|
2218
|
-
created_at_to: "
|
|
2199
|
+
page: 4438, # ページ番号
|
|
2200
|
+
per_page: 1349, # 1ページ分のウォレット数
|
|
2201
|
+
created_at_from: "2019-12-01T12:48:30.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
2202
|
+
created_at_to: "2019-12-07T15:15:46.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
2219
2203
|
is_suspended: false, # ウォレットが凍結状態かどうかでフィルターする
|
|
2220
|
-
status: "
|
|
2221
|
-
external_id: "
|
|
2222
|
-
tel: "
|
|
2223
|
-
email: "
|
|
2204
|
+
status: "pre-closed", # ウォレット状態
|
|
2205
|
+
external_id: "pNkIiUDv", # 外部ID
|
|
2206
|
+
tel: "0450-923-9622", # エンドユーザーの電話番号
|
|
2207
|
+
email: "Edt6GGJ1GX@o5UP.com" # エンドユーザーのメールアドレス
|
|
2224
2208
|
))
|
|
2225
2209
|
```
|
|
2226
2210
|
|
|
@@ -2333,7 +2317,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
|
2333
2317
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2334
2318
|
user_name: "ポケペイ太郎", # ユーザー名
|
|
2335
2319
|
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
|
2336
|
-
external_id: "
|
|
2320
|
+
external_id: "iFJuS" # 外部ID
|
|
2337
2321
|
))
|
|
2338
2322
|
```
|
|
2339
2323
|
|
|
@@ -2387,11 +2371,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
|
|
|
2387
2371
|
```ruby
|
|
2388
2372
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
2389
2373
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2390
|
-
page:
|
|
2391
|
-
per_page:
|
|
2392
|
-
created_at_from: "
|
|
2393
|
-
created_at_to: "
|
|
2394
|
-
is_suspended:
|
|
2374
|
+
page: 8563, # ページ番号
|
|
2375
|
+
per_page: 8518, # 1ページ分のウォレット数
|
|
2376
|
+
created_at_from: "2016-10-23T12:48:37.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
2377
|
+
created_at_to: "2025-06-16T18:34:57.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
2378
|
+
is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
|
|
2395
2379
|
))
|
|
2396
2380
|
```
|
|
2397
2381
|
|
|
@@ -2464,10 +2448,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
2464
2448
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2465
2449
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
2466
2450
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
2467
|
-
type: "
|
|
2451
|
+
type: "transfer", # 取引種別
|
|
2468
2452
|
is_modified: true, # キャンセル済みかどうか
|
|
2469
|
-
from: "
|
|
2470
|
-
to: "
|
|
2453
|
+
from: "2019-05-26T04:57:49.000000+09:00", # 開始日時
|
|
2454
|
+
to: "2023-05-22T08:26:17.000000+09:00", # 終了日時
|
|
2471
2455
|
page: 1, # ページ番号
|
|
2472
2456
|
per_page: 50 # 1ページ分の取引数
|
|
2473
2457
|
))
|
|
@@ -2603,11 +2587,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
2603
2587
|
organization_code: "pocketchange", # 組織コード
|
|
2604
2588
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
2605
2589
|
name: "oxスーパー三田店", # 店舗名
|
|
2606
|
-
postal_code: "
|
|
2590
|
+
postal_code: "481-3133", # 店舗の郵便番号
|
|
2607
2591
|
address: "東京都港区芝...", # 店舗の住所
|
|
2608
|
-
tel: "
|
|
2609
|
-
email: "
|
|
2610
|
-
external_id: "
|
|
2592
|
+
tel: "03-596-0932", # 店舗の電話番号
|
|
2593
|
+
email: "gYanQbVQM9@Z6RG.com", # 店舗のメールアドレス
|
|
2594
|
+
external_id: "CsPdzwEr5mXGzuLW", # 店舗の外部ID
|
|
2611
2595
|
page: 1, # ページ番号
|
|
2612
2596
|
per_page: 50 # 1ページ分の取引数
|
|
2613
2597
|
))
|
|
@@ -2727,16 +2711,16 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
2727
2711
|
---
|
|
2728
2712
|
成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
|
|
2729
2713
|
<a name="create-shop"></a>
|
|
2730
|
-
####
|
|
2714
|
+
#### 【廃止】新規店舗を追加する
|
|
2731
2715
|
新規店舗を追加します。このAPIは廃止予定です。以降は `CreateShopV2` を使用してください。
|
|
2732
2716
|
```ruby
|
|
2733
2717
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
2734
2718
|
"oxスーパー三田店", # shop_name: 店舗名
|
|
2735
|
-
shop_postal_code: "
|
|
2719
|
+
shop_postal_code: "367-9989", # 店舗の郵便番号
|
|
2736
2720
|
shop_address: "東京都港区芝...", # 店舗の住所
|
|
2737
|
-
shop_tel: "
|
|
2738
|
-
shop_email: "
|
|
2739
|
-
shop_external_id: "
|
|
2721
|
+
shop_tel: "0610-63182", # 店舗の電話番号
|
|
2722
|
+
shop_email: "VJNN81LI44@xL3m.com", # 店舗のメールアドレス
|
|
2723
|
+
shop_external_id: "frFPuEOVKpPzDCyUBg3VaVg5lQKirhrBQImB", # 店舗の外部ID
|
|
2740
2724
|
organization_code: "ox-supermarket" # 組織コード
|
|
2741
2725
|
))
|
|
2742
2726
|
```
|
|
@@ -2746,14 +2730,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
|
2746
2730
|
```ruby
|
|
2747
2731
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
2748
2732
|
"oxスーパー三田店", # name: 店舗名
|
|
2749
|
-
postal_code: "
|
|
2733
|
+
postal_code: "216-9643", # 店舗の郵便番号
|
|
2750
2734
|
address: "東京都港区芝...", # 店舗の住所
|
|
2751
|
-
tel: "
|
|
2752
|
-
email: "
|
|
2753
|
-
external_id: "
|
|
2735
|
+
tel: "00-2461201", # 店舗の電話番号
|
|
2736
|
+
email: "V1KmKqNhpu@D1AS.com", # 店舗のメールアドレス
|
|
2737
|
+
external_id: "IxvpFPGaTF6gXtd3n", # 店舗の外部ID
|
|
2754
2738
|
organization_code: "ox-supermarket", # 組織コード
|
|
2755
2739
|
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2756
|
-
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
2740
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
2757
2741
|
))
|
|
2758
2742
|
```
|
|
2759
2743
|
|
|
@@ -2824,11 +2808,11 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
|
2824
2808
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
2825
2809
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
2826
2810
|
name: "oxスーパー三田店", # 店舗名
|
|
2827
|
-
postal_code: "
|
|
2811
|
+
postal_code: "9905741", # 店舗の郵便番号
|
|
2828
2812
|
address: "東京都港区芝...", # 店舗の住所
|
|
2829
|
-
tel: "
|
|
2830
|
-
email: "
|
|
2831
|
-
external_id: "
|
|
2813
|
+
tel: "0580025664", # 店舗の電話番号
|
|
2814
|
+
email: "DokudzPS7P@J09w.com", # 店舗のメールアドレス
|
|
2815
|
+
external_id: "lF6CVlMKFHkTHEGRWUB", # 店舗の外部ID
|
|
2832
2816
|
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2833
2817
|
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
2834
2818
|
))
|
|
@@ -2931,8 +2915,8 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
|
2931
2915
|
```ruby
|
|
2932
2916
|
response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
2933
2917
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
|
2934
|
-
page:
|
|
2935
|
-
per_page:
|
|
2918
|
+
page: 1494, # ページ番号
|
|
2919
|
+
per_page: 8667 # 1ページ分の取引数
|
|
2936
2920
|
))
|
|
2937
2921
|
```
|
|
2938
2922
|
|
|
@@ -2976,8 +2960,8 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
|
2976
2960
|
response = $client.send(Pokepay::Request::CreateUserAccount.new(
|
|
2977
2961
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
|
|
2978
2962
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2979
|
-
name: "
|
|
2980
|
-
external_id: "
|
|
2963
|
+
name: "a1rmAxzFUF6ihvlI4uoOEnKraNjpsN9SjDxtxrgs7e0dkiAAa8jwX6FLCB1XlvzBazSCE1hEG2EkkP2VIPy7HW7Ee7skB9BB1YNClE0n87A30l6vspNWH9u8x4Yq2mxjIub5W9d4fa79SnOHSfjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZa", # ウォレット名
|
|
2964
|
+
external_id: "SpjoQ6ffYAe6kpXiCTiSBUI" # 外部ID
|
|
2981
2965
|
))
|
|
2982
2966
|
```
|
|
2983
2967
|
|
|
@@ -3037,8 +3021,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
|
3037
3021
|
```ruby
|
|
3038
3022
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
3039
3023
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3040
|
-
from: "
|
|
3041
|
-
to: "
|
|
3024
|
+
from: "2018-10-07T20:22:59.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
3025
|
+
to: "2016-09-27T06:40:27.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
3042
3026
|
page: 1, # ページ番号
|
|
3043
3027
|
per_page: 50 # 1ページ分の取引数
|
|
3044
3028
|
))
|
|
@@ -3046,16 +3030,26 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
3046
3030
|
`from`と`to`は同時に指定する必要があります。
|
|
3047
3031
|
|
|
3048
3032
|
成功したときは[PaginatedPrivateMoneyOrganizationSummaries](#paginated-private-money-organization-summaries)オブジェクトを返します
|
|
3033
|
+
<a name="get-private-money-summary"></a>
|
|
3034
|
+
#### 取引サマリを取得する
|
|
3035
|
+
```ruby
|
|
3036
|
+
response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
|
|
3037
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3038
|
+
from: "2016-02-10T22:50:21.000000+09:00", # 開始日時
|
|
3039
|
+
to: "2020-10-29T04:47:13.000000+09:00" # 終了日時
|
|
3040
|
+
))
|
|
3041
|
+
```
|
|
3042
|
+
成功したときは[PrivateMoneySummary](#private-money-summary)オブジェクトを返します
|
|
3049
3043
|
### Bulk
|
|
3050
3044
|
<a name="bulk-create-transaction"></a>
|
|
3051
3045
|
#### CSVファイル一括取引
|
|
3052
3046
|
CSVファイルから一括取引をします。
|
|
3053
3047
|
```ruby
|
|
3054
3048
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
3055
|
-
"
|
|
3056
|
-
"
|
|
3057
|
-
"
|
|
3058
|
-
description: "
|
|
3049
|
+
"MOcjyqBKlSFGLuqDn2oMYRFh8cq", # name: 一括取引タスク名
|
|
3050
|
+
"2spFoKb", # content: 取引する情報のCSV
|
|
3051
|
+
"7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QP", # request_id: リクエストID
|
|
3052
|
+
description: "C60HT399N8hkxoSQFYDUU0HuG332kYdREQC39nZBUv4F8J7UzyDYEv7bctcmIqdmvTV8" # 一括取引の説明
|
|
3059
3053
|
))
|
|
3060
3054
|
```
|
|
3061
3055
|
|
|
@@ -3132,7 +3126,7 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
|
3132
3126
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
3133
3127
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
3134
3128
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3135
|
-
|
|
3129
|
+
2462, # amount: 取引額
|
|
3136
3130
|
description: "たい焼き(小倉)", # 取引説明文
|
|
3137
3131
|
metadata: "{\"key\":\"value\"}", # ポケペイ外部取引メタデータ
|
|
3138
3132
|
products: [{"jan_code":"abc",
|
|
@@ -3140,6 +3134,16 @@ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
|
|
|
3140
3134
|
"unit_price":100,
|
|
3141
3135
|
"price": 100,
|
|
3142
3136
|
"is_discounted": false,
|
|
3137
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
3138
|
+
"name":"name1",
|
|
3139
|
+
"unit_price":100,
|
|
3140
|
+
"price": 100,
|
|
3141
|
+
"is_discounted": false,
|
|
3142
|
+
"other":"{}"}, {"jan_code":"abc",
|
|
3143
|
+
"name":"name1",
|
|
3144
|
+
"unit_price":100,
|
|
3145
|
+
"price": 100,
|
|
3146
|
+
"is_discounted": false,
|
|
3143
3147
|
"other":"{}"}], # 商品情報データ
|
|
3144
3148
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
3145
3149
|
))
|
|
@@ -3271,34 +3275,24 @@ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
|
|
|
3271
3275
|
|
|
3272
3276
|
```ruby
|
|
3273
3277
|
response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
3274
|
-
"
|
|
3278
|
+
"zp0gixsKZWoUeORL98QDv9TW3tonru5DxxR1kiR4daTST401zYU9O5bmxo5R8HDeIrg", # name: キャンペーン名
|
|
3275
3279
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3276
|
-
"
|
|
3277
|
-
"
|
|
3278
|
-
|
|
3279
|
-
"
|
|
3280
|
+
"2023-02-04T11:25:47.000000+09:00", # starts_at: キャンペーン開始日時
|
|
3281
|
+
"2022-09-21T23:26:59.000000+09:00", # ends_at: キャンペーン終了日時
|
|
3282
|
+
2089, # priority: キャンペーンの適用優先度
|
|
3283
|
+
"payment", # event: イベント種別
|
|
3280
3284
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント負担先店舗ID
|
|
3281
|
-
description: "
|
|
3282
|
-
status: "
|
|
3283
|
-
point_expires_at: "
|
|
3284
|
-
point_expires_in_days:
|
|
3285
|
-
is_exclusive:
|
|
3285
|
+
description: "DixRQOsOxJyiut30oRsSLi4FAWjvNFlMGhO7MjoFiHLtN9Yqy7R5Sel4rqjqD6mB2gz0FIdNSbIrXOBo1I3rdkLB5vuUQlHHWHdfJKJGJOe4o3A7Ast7GZKKewMQ", # キャンペーンの説明文
|
|
3286
|
+
status: "enabled", # キャンペーン作成時の状態
|
|
3287
|
+
point_expires_at: "2023-09-27T18:56:38.000000+09:00", # ポイント有効期限(絶対日時指定)
|
|
3288
|
+
point_expires_in_days: 2308, # ポイント有効期限(相対日数指定)
|
|
3289
|
+
is_exclusive: true, # キャンペーンの重複設定
|
|
3286
3290
|
subject: "all", # ポイント付与の対象金額の種別
|
|
3287
3291
|
amount_based_point_rules: [{
|
|
3288
3292
|
"point_amount": 5,
|
|
3289
3293
|
"point_amount_unit": "percent",
|
|
3290
3294
|
"subject_more_than_or_equal": 1000,
|
|
3291
3295
|
"subject_less_than": 5000
|
|
3292
|
-
}, {
|
|
3293
|
-
"point_amount": 5,
|
|
3294
|
-
"point_amount_unit": "percent",
|
|
3295
|
-
"subject_more_than_or_equal": 1000,
|
|
3296
|
-
"subject_less_than": 5000
|
|
3297
|
-
}, {
|
|
3298
|
-
"point_amount": 5,
|
|
3299
|
-
"point_amount_unit": "percent",
|
|
3300
|
-
"subject_more_than_or_equal": 1000,
|
|
3301
|
-
"subject_less_than": 5000
|
|
3302
3296
|
}], # 取引金額ベースのポイント付与ルール
|
|
3303
3297
|
product_based_point_rules: [{
|
|
3304
3298
|
"point_amount": 5,
|
|
@@ -3306,20 +3300,8 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
|
3306
3300
|
"product_code": "4912345678904",
|
|
3307
3301
|
"is_multiply_by_count": true,
|
|
3308
3302
|
"required_count": 2
|
|
3309
|
-
}, {
|
|
3310
|
-
"point_amount": 5,
|
|
3311
|
-
"point_amount_unit": "percent",
|
|
3312
|
-
"product_code": "4912345678904",
|
|
3313
|
-
"is_multiply_by_count": true,
|
|
3314
|
-
"required_count": 2
|
|
3315
|
-
}, {
|
|
3316
|
-
"point_amount": 5,
|
|
3317
|
-
"point_amount_unit": "percent",
|
|
3318
|
-
"product_code": "4912345678904",
|
|
3319
|
-
"is_multiply_by_count": true,
|
|
3320
|
-
"required_count": 2
|
|
3321
3303
|
}], # 商品情報ベースのポイント付与ルール
|
|
3322
|
-
applicable_days_of_week: [
|
|
3304
|
+
applicable_days_of_week: [0, 3, 5], # キャンペーンを適用する曜日 (複数指定)
|
|
3323
3305
|
applicable_time_ranges: [{
|
|
3324
3306
|
"from": "12:00",
|
|
3325
3307
|
"to": "23:59"
|
|
@@ -3327,8 +3309,8 @@ response = $client.send(Pokepay::Request::CreateCampaign.new(
|
|
|
3327
3309
|
"from": "12:00",
|
|
3328
3310
|
"to": "23:59"
|
|
3329
3311
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
|
3330
|
-
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3331
|
-
minimum_number_for_combination_purchase:
|
|
3312
|
+
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3313
|
+
minimum_number_for_combination_purchase: 3815, # 複数種類の商品を同時購入するときの商品種別数の下限
|
|
3332
3314
|
dest_private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント付与先となるマネーID
|
|
3333
3315
|
))
|
|
3334
3316
|
```
|
|
@@ -3691,6 +3673,7 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
3691
3673
|
```ruby
|
|
3692
3674
|
response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
3693
3675
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
3676
|
+
is_ongoing: true, # 現在適用可能なキャンペーンかどうか
|
|
3694
3677
|
page: 1, # ページ番号
|
|
3695
3678
|
per_page: 50 # 1ページ分の取得数
|
|
3696
3679
|
))
|
|
@@ -3708,6 +3691,15 @@ response = $client.send(Pokepay::Request::ListCampaigns.new(
|
|
|
3708
3691
|
|
|
3709
3692
|
フィルターとして使われ、指定したマネーでのキャンペーンのみ一覧に表示されます。
|
|
3710
3693
|
|
|
3694
|
+
---
|
|
3695
|
+
`is_ongoing`
|
|
3696
|
+
```json
|
|
3697
|
+
{ "type": "boolean" }
|
|
3698
|
+
```
|
|
3699
|
+
有効化されており、現在キャンペーン期間内にあるキャンペーンをフィルターするために使われます。
|
|
3700
|
+
真であれば適用可能なもののみを抽出し、偽であれば適用不可なもののみを抽出します。
|
|
3701
|
+
デフォルトでは未指定(フィルターなし)です。
|
|
3702
|
+
|
|
3711
3703
|
---
|
|
3712
3704
|
`page`
|
|
3713
3705
|
```json
|
|
@@ -3762,32 +3754,36 @@ response = $client.send(Pokepay::Request::GetCampaign.new(
|
|
|
3762
3754
|
```ruby
|
|
3763
3755
|
response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
3764
3756
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # campaign_id: キャンペーンID
|
|
3765
|
-
name: "
|
|
3766
|
-
starts_at: "
|
|
3767
|
-
ends_at: "
|
|
3768
|
-
priority:
|
|
3769
|
-
event: "
|
|
3770
|
-
description: "
|
|
3771
|
-
status: "
|
|
3772
|
-
point_expires_at: "2019-
|
|
3773
|
-
point_expires_in_days:
|
|
3757
|
+
name: "2NcGpd9kTg7fbzWuGj28bjzoMkUfQZyG6ql9kvIc3ugQfVcwKEOAlMUYblAnOJUw5uYgLUj2LWIHcZ5Kh7Upt9fM2ThdFR4ZGmC3lYSdkRdIHlBo7iMGslQeLzTg9FCP6boJkANEWZ0xko5rtXdkjCZ6KXkiMx1kHTVbpRx79qoFTViWGk7rsKgu2ihoMxDsfU3TC1A8fV5nkzyaMo6HNFjN16Mt1NNT0LSnWyLCIia", # キャンペーン名
|
|
3758
|
+
starts_at: "2022-12-22T14:28:16.000000+09:00", # キャンペーン開始日時
|
|
3759
|
+
ends_at: "2017-10-29T14:29:59.000000+09:00", # キャンペーン終了日時
|
|
3760
|
+
priority: 7705, # キャンペーンの適用優先度
|
|
3761
|
+
event: "payment", # イベント種別
|
|
3762
|
+
description: "byCFBUZkKwMvzRhZdC9PIbxRIokrSMcAe6DLpfhwjho9qAj035em2B0e1zQxL4LWrEkUrKUADYaUMS4V1xY0z6q9RliuqOBINm", # キャンペーンの説明文
|
|
3763
|
+
status: "enabled", # キャンペーン作成時の状態
|
|
3764
|
+
point_expires_at: "2019-09-17T09:50:09.000000+09:00", # ポイント有効期限(絶対日時指定)
|
|
3765
|
+
point_expires_in_days: 7516, # ポイント有効期限(相対日数指定)
|
|
3774
3766
|
is_exclusive: false, # キャンペーンの重複設定
|
|
3775
|
-
subject: "
|
|
3767
|
+
subject: "money", # ポイント付与の対象金額の種別
|
|
3776
3768
|
amount_based_point_rules: [{
|
|
3777
3769
|
"point_amount": 5,
|
|
3778
3770
|
"point_amount_unit": "percent",
|
|
3779
3771
|
"subject_more_than_or_equal": 1000,
|
|
3780
3772
|
"subject_less_than": 5000
|
|
3781
|
-
}
|
|
3782
|
-
product_based_point_rules: [{
|
|
3773
|
+
}, {
|
|
3783
3774
|
"point_amount": 5,
|
|
3784
3775
|
"point_amount_unit": "percent",
|
|
3785
|
-
"
|
|
3786
|
-
"
|
|
3787
|
-
"required_count": 2
|
|
3776
|
+
"subject_more_than_or_equal": 1000,
|
|
3777
|
+
"subject_less_than": 5000
|
|
3788
3778
|
}, {
|
|
3789
3779
|
"point_amount": 5,
|
|
3790
3780
|
"point_amount_unit": "percent",
|
|
3781
|
+
"subject_more_than_or_equal": 1000,
|
|
3782
|
+
"subject_less_than": 5000
|
|
3783
|
+
}], # 取引金額ベースのポイント付与ルール
|
|
3784
|
+
product_based_point_rules: [{
|
|
3785
|
+
"point_amount": 5,
|
|
3786
|
+
"point_amount_unit": "percent",
|
|
3791
3787
|
"product_code": "4912345678904",
|
|
3792
3788
|
"is_multiply_by_count": true,
|
|
3793
3789
|
"required_count": 2
|
|
@@ -3798,19 +3794,16 @@ response = $client.send(Pokepay::Request::UpdateCampaign.new(
|
|
|
3798
3794
|
"is_multiply_by_count": true,
|
|
3799
3795
|
"required_count": 2
|
|
3800
3796
|
}], # 商品情報ベースのポイント付与ルール
|
|
3801
|
-
applicable_days_of_week: [
|
|
3797
|
+
applicable_days_of_week: [1], # キャンペーンを適用する曜日 (複数指定)
|
|
3802
3798
|
applicable_time_ranges: [{
|
|
3803
3799
|
"from": "12:00",
|
|
3804
3800
|
"to": "23:59"
|
|
3805
3801
|
}, {
|
|
3806
3802
|
"from": "12:00",
|
|
3807
3803
|
"to": "23:59"
|
|
3808
|
-
}, {
|
|
3809
|
-
"from": "12:00",
|
|
3810
|
-
"to": "23:59"
|
|
3811
3804
|
}], # キャンペーンを適用する時間帯 (複数指定)
|
|
3812
3805
|
applicable_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # キャンペーン適用対象となる店舗IDのリスト
|
|
3813
|
-
minimum_number_for_combination_purchase:
|
|
3806
|
+
minimum_number_for_combination_purchase: 4732 # 複数種類の商品を同時購入するときの商品種別数の下限
|
|
3814
3807
|
))
|
|
3815
3808
|
```
|
|
3816
3809
|
|
|
@@ -4145,12 +4138,10 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4145
4138
|
* `id (string)`:
|
|
4146
4139
|
* `name (string)`:
|
|
4147
4140
|
* `is_suspended (boolean)`:
|
|
4148
|
-
* `status (
|
|
4141
|
+
* `status (string)`:
|
|
4149
4142
|
* `private_money (PrivateMoney)`:
|
|
4150
4143
|
* `user (User)`:
|
|
4151
4144
|
|
|
4152
|
-
`status`は [AccountStatus](#account-status) オブジェクトを返します。
|
|
4153
|
-
|
|
4154
4145
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
4155
4146
|
|
|
4156
4147
|
`user`は [User](#user) オブジェクトを返します。
|
|
@@ -4160,7 +4151,7 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4160
4151
|
* `id (string)`:
|
|
4161
4152
|
* `name (string)`:
|
|
4162
4153
|
* `is_suspended (boolean)`:
|
|
4163
|
-
* `status (
|
|
4154
|
+
* `status (string)`:
|
|
4164
4155
|
* `balance (double)`:
|
|
4165
4156
|
* `money_balance (double)`:
|
|
4166
4157
|
* `point_balance (double)`:
|
|
@@ -4168,8 +4159,6 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4168
4159
|
* `user (User)`:
|
|
4169
4160
|
* `external_id (string)`:
|
|
4170
4161
|
|
|
4171
|
-
`status`は [AccountStatus](#account-status) オブジェクトを返します。
|
|
4172
|
-
|
|
4173
4162
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
4174
4163
|
|
|
4175
4164
|
`user`は [User](#user) オブジェクトを返します。
|
|
@@ -4190,26 +4179,6 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4190
4179
|
|
|
4191
4180
|
`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
|
|
4192
4181
|
|
|
4193
|
-
<a name="check"></a>
|
|
4194
|
-
## Check
|
|
4195
|
-
* `id (string)`: チャージQRコードのID
|
|
4196
|
-
* `amount (double)`: チャージマネー額 (deprecated)
|
|
4197
|
-
* `money_amount (double)`: チャージマネー額
|
|
4198
|
-
* `point_amount (double)`: チャージポイント額
|
|
4199
|
-
* `description (string)`: チャージQRコードの説明文(アプリ上で取引の説明文として表示される)
|
|
4200
|
-
* `user (User)`: 送金元ユーザ情報
|
|
4201
|
-
* `is_onetime (boolean)`: 使用回数が一回限りかどうか
|
|
4202
|
-
* `is_disabled (boolean)`: 無効化されているかどうか
|
|
4203
|
-
* `expires_at (string)`: チャージQRコード自体の失効日時
|
|
4204
|
-
* `private_money (PrivateMoney)`: 対象マネー情報
|
|
4205
|
-
* `usage_limit (integer)`: 一回限りでない場合の最大読み取り回数
|
|
4206
|
-
* `usage_count (double)`: 一回限りでない場合の現在までに読み取られた回数
|
|
4207
|
-
* `token (string)`: チャージQRコードを解析したときに出てくるURL
|
|
4208
|
-
|
|
4209
|
-
`user`は [User](#user) オブジェクトを返します。
|
|
4210
|
-
|
|
4211
|
-
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
4212
|
-
|
|
4213
4182
|
<a name="cpm-token"></a>
|
|
4214
4183
|
## CpmToken
|
|
4215
4184
|
* `cpm_token (string)`:
|
|
@@ -4336,6 +4305,18 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4336
4305
|
|
|
4337
4306
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
4338
4307
|
|
|
4308
|
+
<a name="private-money-summary"></a>
|
|
4309
|
+
## PrivateMoneySummary
|
|
4310
|
+
* `topup_amount (double)`:
|
|
4311
|
+
* `refunded_topup_amount (double)`:
|
|
4312
|
+
* `payment_amount (double)`:
|
|
4313
|
+
* `refunded_payment_amount (double)`:
|
|
4314
|
+
* `added_point_amount (double)`:
|
|
4315
|
+
* `refunded_added_point_amount (double)`:
|
|
4316
|
+
* `exchange_inflow_amount (double)`:
|
|
4317
|
+
* `exchange_outflow_amount (double)`:
|
|
4318
|
+
* `transaction_count (integer)`:
|
|
4319
|
+
|
|
4339
4320
|
<a name="paginated-transaction"></a>
|
|
4340
4321
|
## PaginatedTransaction
|
|
4341
4322
|
* `rows (array of Transactions)`:
|
|
@@ -4461,9 +4442,6 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4461
4442
|
|
|
4462
4443
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
4463
4444
|
|
|
4464
|
-
<a name="account-status"></a>
|
|
4465
|
-
## AccountStatus
|
|
4466
|
-
|
|
4467
4445
|
<a name="private-money"></a>
|
|
4468
4446
|
## PrivateMoney
|
|
4469
4447
|
* `id (string)`: マネーID
|
|
@@ -4516,11 +4494,9 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4516
4494
|
* `id (string)`: ウォレットID
|
|
4517
4495
|
* `name (string)`: ウォレット名
|
|
4518
4496
|
* `is_suspended (boolean)`: ウォレットが凍結されているかどうか
|
|
4519
|
-
* `status (
|
|
4497
|
+
* `status (string)`:
|
|
4520
4498
|
* `private_money (PrivateMoney)`: 設定マネー情報
|
|
4521
4499
|
|
|
4522
|
-
`status`は [AccountStatus](#account-status) オブジェクトを返します。
|
|
4523
|
-
|
|
4524
4500
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
4525
4501
|
|
|
4526
4502
|
<a name="transfer"></a>
|
|
@@ -4591,12 +4567,10 @@ event が payment か external-transaction の時のみ有効です。
|
|
|
4591
4567
|
* `id (string)`:
|
|
4592
4568
|
* `name (string)`:
|
|
4593
4569
|
* `is_suspended (boolean)`:
|
|
4594
|
-
* `status (
|
|
4570
|
+
* `status (string)`:
|
|
4595
4571
|
* `private_money_id (string)`:
|
|
4596
4572
|
* `user (User)`:
|
|
4597
4573
|
|
|
4598
|
-
`status`は [AccountStatus](#account-status) オブジェクトを返します。
|
|
4599
|
-
|
|
4600
4574
|
`user`は [User](#user) オブジェクトを返します。
|
|
4601
4575
|
|
|
4602
4576
|
<a name="organization-summary"></a>
|