pokepay_partner_ruby_sdk 0.1.10 → 0.1.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -1
- data/docs/index.md +267 -77
- data/lib/pokepay_partner_ruby_sdk.rb +3 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_customer_accounts.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_shop_accounts.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/partner.yaml +149 -0
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0df7b536381fe94cea6bae221c87207b84efcbde62a2a8dcab3d52d75afcf753
|
|
4
|
+
data.tar.gz: cc91f0a961f1833231ad906070d695b4aace35364efc670f3675e5d8db9c2940
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 78a1d7c51afa48c63decb05c583fad6b43ed846cb22d3c8c86c62c3244b4a166079588da3cfb553808426f459949b6f552ecdb2ab84b80e7e42c8c7ca6542cd0
|
|
7
|
+
data.tar.gz: 35b7973c40848c9ec93a10d63d19f2144fd2f2d136cc40cebe7c4325808aec4affd718a8cf5df225bb648994279a804588c259586ae2042663a9eaf0c0d4eb44
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
pokepay_partner_ruby_sdk (0.1.
|
|
4
|
+
pokepay_partner_ruby_sdk (0.1.11)
|
|
5
5
|
inifile (~> 3.0.0)
|
|
6
6
|
json (~> 2.3.0)
|
|
7
7
|
openssl (~> 2.1.2)
|
|
@@ -10,9 +10,11 @@ GEM
|
|
|
10
10
|
remote: https://rubygems.org/
|
|
11
11
|
specs:
|
|
12
12
|
inifile (3.0.0)
|
|
13
|
+
ipaddr (1.2.2)
|
|
13
14
|
json (2.3.1)
|
|
14
15
|
minitest (5.14.4)
|
|
15
16
|
openssl (2.1.2)
|
|
17
|
+
ipaddr
|
|
16
18
|
rake (13.0.1)
|
|
17
19
|
|
|
18
20
|
PLATFORMS
|
data/docs/index.md
CHANGED
|
@@ -162,7 +162,9 @@ response.body
|
|
|
162
162
|
- [UpdateAccount](#update-account): ウォレット情報を更新する
|
|
163
163
|
- [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
|
|
164
164
|
- [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
|
|
165
|
+
- [GetCustomerAccounts](#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
|
|
165
166
|
- [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーウォレットを追加する
|
|
167
|
+
- [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
|
|
166
168
|
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
|
167
169
|
- [ListShops](#list-shops): 店舗一覧を取得する
|
|
168
170
|
- [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
|
|
@@ -179,8 +181,8 @@ response.body
|
|
|
179
181
|
取引一覧を返します。
|
|
180
182
|
```ruby
|
|
181
183
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
182
|
-
from: "
|
|
183
|
-
to: "
|
|
184
|
+
from: "2018-03-23T13:18:22.000000+09:00", # 開始日時
|
|
185
|
+
to: "2021-07-09T00:39:57.000000+09:00", # 終了日時
|
|
184
186
|
page: 1, # ページ番号
|
|
185
187
|
per_page: 50, # 1ページ分の取引数
|
|
186
188
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
@@ -191,7 +193,8 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
|
191
193
|
organization_code: "pocketchange", # 組織コード
|
|
192
194
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
193
195
|
is_modified: true, # キャンセルフラグ
|
|
194
|
-
types: ["topup", "payment"]
|
|
196
|
+
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
197
|
+
description: "店頭QRコードによる支払い" # 取引説明文
|
|
195
198
|
))
|
|
196
199
|
```
|
|
197
200
|
|
|
@@ -364,6 +367,18 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
|
364
367
|
4. exchange-inflow
|
|
365
368
|
他マネーからの流入
|
|
366
369
|
|
|
370
|
+
---
|
|
371
|
+
`description`
|
|
372
|
+
```json
|
|
373
|
+
{
|
|
374
|
+
"type": "string",
|
|
375
|
+
"maxLength": 200
|
|
376
|
+
}
|
|
377
|
+
```
|
|
378
|
+
取引を指定の取引説明文でフィルターします。
|
|
379
|
+
|
|
380
|
+
取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
|
|
381
|
+
|
|
367
382
|
---
|
|
368
383
|
成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
|
|
369
384
|
<a name="create-transaction"></a>
|
|
@@ -374,10 +389,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
|
374
389
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
375
390
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
376
391
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
377
|
-
money_amount:
|
|
378
|
-
point_amount:
|
|
379
|
-
point_expires_at: "
|
|
380
|
-
description: "
|
|
392
|
+
money_amount: 7618,
|
|
393
|
+
point_amount: 7525,
|
|
394
|
+
point_expires_at: "2023-08-25T23:56:49.000000+09:00", # ポイント有効期限
|
|
395
|
+
description: "Y4wthFo0glXBErIUB1p7aPMzXnAdDrY96Gn0OAQ9xSN0zfKx7ivixiVqjgvBNcsQLQxAtJmVTcXWtKUzkNd35gyuBKlwozbM8BIp6WWFtoNM3mKKWyblmmAHRS"
|
|
381
396
|
))
|
|
382
397
|
```
|
|
383
398
|
|
|
@@ -403,9 +418,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
403
418
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
404
419
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
405
420
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
406
|
-
money_amount:
|
|
407
|
-
point_amount:
|
|
408
|
-
point_expires_at: "
|
|
421
|
+
money_amount: 4950, # マネー額
|
|
422
|
+
point_amount: 8112, # ポイント額
|
|
423
|
+
point_expires_at: "2021-01-08T04:46:28.000000+09:00", # ポイント有効期限
|
|
409
424
|
description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
|
|
410
425
|
))
|
|
411
426
|
```
|
|
@@ -517,7 +532,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
517
532
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
518
533
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
519
534
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
520
|
-
|
|
535
|
+
4421, # amount: 支払い額
|
|
521
536
|
description: "たい焼き(小倉)" # 取引履歴に表示する説明文
|
|
522
537
|
))
|
|
523
538
|
```
|
|
@@ -594,7 +609,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
594
609
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
595
610
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
596
611
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
597
|
-
|
|
612
|
+
5572, # amount: 送金額
|
|
598
613
|
description: "たい焼き(小倉)" # 取引履歴に表示する説明文
|
|
599
614
|
))
|
|
600
615
|
```
|
|
@@ -668,8 +683,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
|
668
683
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
669
684
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
670
685
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
671
|
-
|
|
672
|
-
description: "
|
|
686
|
+
2336,
|
|
687
|
+
description: "w10SY48ZoA8oj9alrEKYDjBWPKCwbirzvScUvjsqVkcSInvOjFPIL9qlVMwg0ANEHCj5eM805Swtsg2NkJBDvuxWoqdLq3QmHRbZpwbPRidVG7B6hajGJrCJBxTKH0YUW8iwJJuJPCjlaztijN3vebjT86"
|
|
673
688
|
))
|
|
674
689
|
```
|
|
675
690
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
@@ -700,21 +715,36 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
|
700
715
|
####
|
|
701
716
|
```ruby
|
|
702
717
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
703
|
-
from: "
|
|
704
|
-
to: "2018-
|
|
705
|
-
page:
|
|
706
|
-
per_page:
|
|
718
|
+
from: "2018-07-06T01:18:47.000000+09:00",
|
|
719
|
+
to: "2018-05-01T15:56:14.000000+09:00",
|
|
720
|
+
page: 7002,
|
|
721
|
+
per_page: 8147,
|
|
707
722
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
708
|
-
shop_name: "
|
|
723
|
+
shop_name: "CqvnZ1YzdrhGH7XKNoGDpqqjYUa42NN7jWbTA8sT9CjYdhYyR9ZtWhMAKSZHQ2Tjahc0hASAcEibjku1f",
|
|
709
724
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
710
|
-
customer_name: "
|
|
725
|
+
customer_name: "QetgL0O7DlAFrkXVihIdQWu7J4NYirXryPP6taqbm6hsnA9hELkacVB4dzDqQ1LbTyVIgVP7fIz1xemnrDx9P7HPwLX5lwWZKuWWf4n5wNPq2rjN28QfQLnQ9Qr2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCpNJGZG6LzTWIbd8ZNVrafdiivNn4NbNLXIdoiqtrelImUNmLeKEfXUc2dQExu22E4bXnTsrAu",
|
|
711
726
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
712
727
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
713
|
-
is_modified:
|
|
714
|
-
transaction_types: ["exchange", "
|
|
715
|
-
transfer_types: ["topup", "transfer",
|
|
728
|
+
is_modified: true,
|
|
729
|
+
transaction_types: ["exchange", "payment", "transfer", "topup"],
|
|
730
|
+
transfer_types: ["topup", "transfer"],
|
|
731
|
+
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
716
732
|
))
|
|
717
733
|
```
|
|
734
|
+
|
|
735
|
+
---
|
|
736
|
+
`description`
|
|
737
|
+
```json
|
|
738
|
+
{
|
|
739
|
+
"type": "string",
|
|
740
|
+
"maxLength": 200
|
|
741
|
+
}
|
|
742
|
+
```
|
|
743
|
+
取引詳細を指定の取引詳細説明文でフィルターします。
|
|
744
|
+
|
|
745
|
+
取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
|
|
746
|
+
|
|
747
|
+
---
|
|
718
748
|
成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
|
|
719
749
|
### Check
|
|
720
750
|
店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
|
|
@@ -771,19 +801,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
771
801
|
支払いQRコード一覧を表示します。
|
|
772
802
|
```ruby
|
|
773
803
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
774
|
-
page:
|
|
775
|
-
per_page:
|
|
776
|
-
bill_id: "
|
|
804
|
+
page: 59, # ページ番号
|
|
805
|
+
per_page: 5729, # 1ページの表示数
|
|
806
|
+
bill_id: "cjpDc", # 支払いQRコードのID
|
|
777
807
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
778
|
-
organization_code: "
|
|
808
|
+
organization_code: "lZ4-35-cw-jqbxQoX9vZ-pMg8z5-", # 組織コード
|
|
779
809
|
description: "test bill", # 取引説明文
|
|
780
|
-
created_from: "2022-
|
|
781
|
-
created_to: "
|
|
810
|
+
created_from: "2022-08-24T20:55:10.000000+09:00", # 作成日時(起点)
|
|
811
|
+
created_to: "2017-10-17T12:55:14.000000+09:00", # 作成日時(終点)
|
|
782
812
|
shop_name: "bill test shop1", # 店舗名
|
|
783
813
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
784
|
-
lower_limit_amount:
|
|
785
|
-
upper_limit_amount:
|
|
786
|
-
is_disabled:
|
|
814
|
+
lower_limit_amount: 1024, # 金額の範囲によるフィルタ(下限)
|
|
815
|
+
upper_limit_amount: 3342, # 金額の範囲によるフィルタ(上限)
|
|
816
|
+
is_disabled: false # 支払いQRコードが無効化されているかどうか
|
|
787
817
|
))
|
|
788
818
|
```
|
|
789
819
|
|
|
@@ -927,7 +957,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
|
927
957
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
928
958
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
929
959
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
930
|
-
amount:
|
|
960
|
+
amount: 7131, # 支払い額
|
|
931
961
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
932
962
|
))
|
|
933
963
|
```
|
|
@@ -951,7 +981,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
|
951
981
|
```ruby
|
|
952
982
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
953
983
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
954
|
-
amount:
|
|
984
|
+
amount: 6026, # 支払い額
|
|
955
985
|
description: "test bill", # 説明文
|
|
956
986
|
is_disabled: true # 無効化されているかどうか
|
|
957
987
|
))
|
|
@@ -1016,9 +1046,9 @@ Cashtrayを作成します。
|
|
|
1016
1046
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
1017
1047
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1018
1048
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1019
|
-
|
|
1049
|
+
2980, # amount: 金額
|
|
1020
1050
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1021
|
-
expires_in:
|
|
1051
|
+
expires_in: 673 # 失効時間(秒)
|
|
1022
1052
|
))
|
|
1023
1053
|
```
|
|
1024
1054
|
|
|
@@ -1179,9 +1209,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
|
1179
1209
|
```ruby
|
|
1180
1210
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
1181
1211
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
1182
|
-
amount:
|
|
1212
|
+
amount: 7982, # 金額
|
|
1183
1213
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1184
|
-
expires_in:
|
|
1214
|
+
expires_in: 6739 # 失効時間(秒)
|
|
1185
1215
|
))
|
|
1186
1216
|
```
|
|
1187
1217
|
|
|
@@ -1256,7 +1286,7 @@ response = $client.send(Pokepay::Request::GetAccount.new(
|
|
|
1256
1286
|
```ruby
|
|
1257
1287
|
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
1258
1288
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1259
|
-
is_suspended:
|
|
1289
|
+
is_suspended: true # ウォレットが凍結されているかどうか
|
|
1260
1290
|
))
|
|
1261
1291
|
```
|
|
1262
1292
|
|
|
@@ -1287,11 +1317,11 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
|
1287
1317
|
```ruby
|
|
1288
1318
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
1289
1319
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1290
|
-
page:
|
|
1291
|
-
per_page:
|
|
1292
|
-
expires_at_from: "
|
|
1293
|
-
expires_at_to: "
|
|
1294
|
-
direction: "
|
|
1320
|
+
page: 1825, # ページ番号
|
|
1321
|
+
per_page: 1938, # 1ページ分の取引数
|
|
1322
|
+
expires_at_from: "2024-10-20T12:50:56.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1323
|
+
expires_at_to: "2023-10-13T12:55:10.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1324
|
+
direction: "desc" # 有効期限によるソート順序
|
|
1295
1325
|
))
|
|
1296
1326
|
```
|
|
1297
1327
|
|
|
@@ -1365,10 +1395,10 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
|
1365
1395
|
```ruby
|
|
1366
1396
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
1367
1397
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1368
|
-
page:
|
|
1369
|
-
per_page:
|
|
1370
|
-
expires_at_from: "
|
|
1371
|
-
expires_at_to: "
|
|
1398
|
+
page: 1574, # ページ番号
|
|
1399
|
+
per_page: 565, # 1ページ分の取引数
|
|
1400
|
+
expires_at_from: "2024-07-16T03:15:02.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1401
|
+
expires_at_to: "2020-04-13T18:19:06.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1372
1402
|
direction: "desc" # 有効期限によるソート順序
|
|
1373
1403
|
))
|
|
1374
1404
|
```
|
|
@@ -1437,6 +1467,81 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
1437
1467
|
|
|
1438
1468
|
---
|
|
1439
1469
|
成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
|
|
1470
|
+
<a name="get-customer-accounts"></a>
|
|
1471
|
+
#### エンドユーザーのウォレット一覧を表示する
|
|
1472
|
+
マネーを指定してエンドユーザーのウォレット一覧を取得します。
|
|
1473
|
+
```ruby
|
|
1474
|
+
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
1475
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1476
|
+
page: 7367, # ページ番号
|
|
1477
|
+
per_page: 2729, # 1ページ分のウォレット数
|
|
1478
|
+
created_at_from: "2023-05-31T00:35:38.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1479
|
+
created_at_to: "2020-09-03T19:56:38.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1480
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
|
1481
|
+
))
|
|
1482
|
+
```
|
|
1483
|
+
|
|
1484
|
+
---
|
|
1485
|
+
`private_money_id`
|
|
1486
|
+
```json
|
|
1487
|
+
{
|
|
1488
|
+
"type": "string",
|
|
1489
|
+
"format": "uuid"
|
|
1490
|
+
}
|
|
1491
|
+
```
|
|
1492
|
+
マネーIDです。
|
|
1493
|
+
|
|
1494
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1495
|
+
|
|
1496
|
+
---
|
|
1497
|
+
`page`
|
|
1498
|
+
```json
|
|
1499
|
+
{
|
|
1500
|
+
"type": "integer",
|
|
1501
|
+
"minimum": 1
|
|
1502
|
+
}
|
|
1503
|
+
```
|
|
1504
|
+
取得したいページ番号です。デフォルト値は1です。
|
|
1505
|
+
|
|
1506
|
+
---
|
|
1507
|
+
`per_page`
|
|
1508
|
+
```json
|
|
1509
|
+
{
|
|
1510
|
+
"type": "integer",
|
|
1511
|
+
"minimum": 1
|
|
1512
|
+
}
|
|
1513
|
+
```
|
|
1514
|
+
1ページ分のウォレット数です。デフォルト値は30です。
|
|
1515
|
+
|
|
1516
|
+
---
|
|
1517
|
+
`created_at_from`
|
|
1518
|
+
```json
|
|
1519
|
+
{
|
|
1520
|
+
"type": "string",
|
|
1521
|
+
"format": "date-time"
|
|
1522
|
+
}
|
|
1523
|
+
```
|
|
1524
|
+
ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1525
|
+
|
|
1526
|
+
---
|
|
1527
|
+
`created_at_to`
|
|
1528
|
+
```json
|
|
1529
|
+
{
|
|
1530
|
+
"type": "string",
|
|
1531
|
+
"format": "date-time"
|
|
1532
|
+
}
|
|
1533
|
+
```
|
|
1534
|
+
ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1535
|
+
|
|
1536
|
+
---
|
|
1537
|
+
`is_suspended`
|
|
1538
|
+
```json
|
|
1539
|
+
{ "type": "boolean" }
|
|
1540
|
+
```
|
|
1541
|
+
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1542
|
+
|
|
1543
|
+
---
|
|
1544
|
+
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1440
1545
|
<a name="create-customer-account"></a>
|
|
1441
1546
|
#### 新規エンドユーザーウォレットを追加する
|
|
1442
1547
|
指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
|
|
@@ -1482,6 +1587,81 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
|
1482
1587
|
|
|
1483
1588
|
---
|
|
1484
1589
|
成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
|
|
1590
|
+
<a name="get-shop-accounts"></a>
|
|
1591
|
+
#### 店舗ユーザーのウォレット一覧を表示する
|
|
1592
|
+
マネーを指定して店舗ユーザーのウォレット一覧を取得します。
|
|
1593
|
+
```ruby
|
|
1594
|
+
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
1595
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1596
|
+
page: 9407, # ページ番号
|
|
1597
|
+
per_page: 8985, # 1ページ分のウォレット数
|
|
1598
|
+
created_at_from: "2025-01-28T18:22:53.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1599
|
+
created_at_to: "2019-06-08T22:34:01.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1600
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
|
1601
|
+
))
|
|
1602
|
+
```
|
|
1603
|
+
|
|
1604
|
+
---
|
|
1605
|
+
`private_money_id`
|
|
1606
|
+
```json
|
|
1607
|
+
{
|
|
1608
|
+
"type": "string",
|
|
1609
|
+
"format": "uuid"
|
|
1610
|
+
}
|
|
1611
|
+
```
|
|
1612
|
+
マネーIDです。
|
|
1613
|
+
|
|
1614
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1615
|
+
|
|
1616
|
+
---
|
|
1617
|
+
`page`
|
|
1618
|
+
```json
|
|
1619
|
+
{
|
|
1620
|
+
"type": "integer",
|
|
1621
|
+
"minimum": 1
|
|
1622
|
+
}
|
|
1623
|
+
```
|
|
1624
|
+
取得したいページ番号です。デフォルト値は1です。
|
|
1625
|
+
|
|
1626
|
+
---
|
|
1627
|
+
`per_page`
|
|
1628
|
+
```json
|
|
1629
|
+
{
|
|
1630
|
+
"type": "integer",
|
|
1631
|
+
"minimum": 1
|
|
1632
|
+
}
|
|
1633
|
+
```
|
|
1634
|
+
1ページ分のウォレット数です。デフォルト値は30です。
|
|
1635
|
+
|
|
1636
|
+
---
|
|
1637
|
+
`created_at_from`
|
|
1638
|
+
```json
|
|
1639
|
+
{
|
|
1640
|
+
"type": "string",
|
|
1641
|
+
"format": "date-time"
|
|
1642
|
+
}
|
|
1643
|
+
```
|
|
1644
|
+
ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1645
|
+
|
|
1646
|
+
---
|
|
1647
|
+
`created_at_to`
|
|
1648
|
+
```json
|
|
1649
|
+
{
|
|
1650
|
+
"type": "string",
|
|
1651
|
+
"format": "date-time"
|
|
1652
|
+
}
|
|
1653
|
+
```
|
|
1654
|
+
ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1655
|
+
|
|
1656
|
+
---
|
|
1657
|
+
`is_suspended`
|
|
1658
|
+
```json
|
|
1659
|
+
{ "type": "boolean" }
|
|
1660
|
+
```
|
|
1661
|
+
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1662
|
+
|
|
1663
|
+
---
|
|
1664
|
+
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1485
1665
|
<a name="list-customer-transactions"></a>
|
|
1486
1666
|
#### 取引履歴を取得する
|
|
1487
1667
|
取引一覧を返します。
|
|
@@ -1490,10 +1670,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
1490
1670
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1491
1671
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
1492
1672
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
1493
|
-
type: "
|
|
1673
|
+
type: "4", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
|
|
1494
1674
|
is_modified: false, # キャンセル済みかどうか
|
|
1495
|
-
from: "
|
|
1496
|
-
to: "
|
|
1675
|
+
from: "2018-07-21T00:36:24.000000+09:00", # 開始日時
|
|
1676
|
+
to: "2020-07-01T13:28:22.000000+09:00", # 終了日時
|
|
1497
1677
|
page: 1, # ページ番号
|
|
1498
1678
|
per_page: 50 # 1ページ分の取引数
|
|
1499
1679
|
))
|
|
@@ -1618,11 +1798,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
1618
1798
|
organization_code: "pocketchange", # 組織コード
|
|
1619
1799
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1620
1800
|
name: "oxスーパー三田店", # 店舗名
|
|
1621
|
-
postal_code: "
|
|
1801
|
+
postal_code: "431-5371", # 店舗の郵便番号
|
|
1622
1802
|
address: "東京都港区芝...", # 店舗の住所
|
|
1623
|
-
tel: "
|
|
1624
|
-
email: "
|
|
1625
|
-
external_id: "
|
|
1803
|
+
tel: "079852808", # 店舗の電話番号
|
|
1804
|
+
email: "RgnqYnUlh4@JbOr.com", # 店舗のメールアドレス
|
|
1805
|
+
external_id: "j5jFwrAdcz57ZO", # 店舗の外部ID
|
|
1626
1806
|
page: 1, # ページ番号
|
|
1627
1807
|
per_page: 50 # 1ページ分の取引数
|
|
1628
1808
|
))
|
|
@@ -1747,11 +1927,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
1747
1927
|
```ruby
|
|
1748
1928
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
1749
1929
|
"oxスーパー三田店", # shop_name: 店舗名
|
|
1750
|
-
shop_postal_code: "
|
|
1930
|
+
shop_postal_code: "7934204", # 店舗の郵便番号
|
|
1751
1931
|
shop_address: "東京都港区芝...", # 店舗の住所
|
|
1752
|
-
shop_tel: "
|
|
1753
|
-
shop_email: "
|
|
1754
|
-
shop_external_id: "
|
|
1932
|
+
shop_tel: "024-611-002", # 店舗の電話番号
|
|
1933
|
+
shop_email: "Ono1AcjM96@oftC.com", # 店舗のメールアドレス
|
|
1934
|
+
shop_external_id: "hiSDgXKvV", # 店舗の外部ID
|
|
1755
1935
|
organization_code: "ox-supermarket" # 組織コード
|
|
1756
1936
|
))
|
|
1757
1937
|
```
|
|
@@ -1761,14 +1941,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
|
1761
1941
|
```ruby
|
|
1762
1942
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
1763
1943
|
"oxスーパー三田店", # name: 店舗名
|
|
1764
|
-
postal_code: "
|
|
1944
|
+
postal_code: "950-0366", # 店舗の郵便番号
|
|
1765
1945
|
address: "東京都港区芝...", # 店舗の住所
|
|
1766
|
-
tel: "
|
|
1767
|
-
email: "
|
|
1768
|
-
external_id: "
|
|
1946
|
+
tel: "0443-379", # 店舗の電話番号
|
|
1947
|
+
email: "Mo26iqol80@j1t4.com", # 店舗のメールアドレス
|
|
1948
|
+
external_id: "lpnoezO", # 店舗の外部ID
|
|
1769
1949
|
organization_code: "ox-supermarket", # 組織コード
|
|
1770
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
1771
|
-
can_topup_private_money_ids: [
|
|
1950
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
1951
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
|
1772
1952
|
))
|
|
1773
1953
|
```
|
|
1774
1954
|
|
|
@@ -1839,13 +2019,13 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
|
1839
2019
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
1840
2020
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1841
2021
|
name: "oxスーパー三田店", # 店舗名
|
|
1842
|
-
postal_code: "
|
|
2022
|
+
postal_code: "3489665", # 店舗の郵便番号
|
|
1843
2023
|
address: "東京都港区芝...", # 店舗の住所
|
|
1844
|
-
tel: "
|
|
1845
|
-
email: "
|
|
1846
|
-
external_id: "
|
|
1847
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
1848
|
-
can_topup_private_money_ids: []
|
|
2024
|
+
tel: "01-3271-444", # 店舗の電話番号
|
|
2025
|
+
email: "QnDY4S9N4H@hJ5r.com", # 店舗のメールアドレス
|
|
2026
|
+
external_id: "CsXRcUZY47cpIh03B", # 店舗の外部ID
|
|
2027
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2028
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
1849
2029
|
))
|
|
1850
2030
|
```
|
|
1851
2031
|
|
|
@@ -1995,8 +2175,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
|
1995
2175
|
```ruby
|
|
1996
2176
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
1997
2177
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1998
|
-
from: "
|
|
1999
|
-
to: "
|
|
2178
|
+
from: "2019-05-24T22:23:13.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
2179
|
+
to: "2023-11-28T06:04:04.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
2000
2180
|
page: 1, # ページ番号
|
|
2001
2181
|
per_page: 50 # 1ページ分の取引数
|
|
2002
2182
|
))
|
|
@@ -2010,10 +2190,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
2010
2190
|
CSVファイルから一括取引をします。
|
|
2011
2191
|
```ruby
|
|
2012
2192
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
2013
|
-
"
|
|
2014
|
-
"
|
|
2015
|
-
"
|
|
2016
|
-
description: "
|
|
2193
|
+
"YHoO28zEE65", # name: 一括取引タスク名
|
|
2194
|
+
"UlKt", # content: 取引する情報のCSV
|
|
2195
|
+
"MCe12MUV2dxrA2428zEWnFZLX87qtedPzV8N", # request_id: リクエストID
|
|
2196
|
+
description: "diYCurcmVOPZzwMWHgQ0VESfspW9b9NBdczTSynCfTiWLEN2pEbq7ZeB8PVJkE9NzaeTptZ5kX9rLpagdWQnEnTlLyubwibc5uG9Y4cn6ApRZ5NX6gFb5nuODlmm9r" # 一括取引の説明
|
|
2017
2197
|
))
|
|
2018
2198
|
```
|
|
2019
2199
|
|
|
@@ -2239,6 +2419,16 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
|
2239
2419
|
|
|
2240
2420
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2241
2421
|
|
|
2422
|
+
<a name="paginated-account-with-users"></a>
|
|
2423
|
+
## PaginatedAccountWithUsers
|
|
2424
|
+
* `rows (array of AccountWithUsers)`:
|
|
2425
|
+
* `count (integer)`:
|
|
2426
|
+
* `pagination (Pagination)`:
|
|
2427
|
+
|
|
2428
|
+
`rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
|
|
2429
|
+
|
|
2430
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2431
|
+
|
|
2242
2432
|
<a name="paginated-account-balance"></a>
|
|
2243
2433
|
## PaginatedAccountBalance
|
|
2244
2434
|
* `rows (array of AccountBalances)`:
|
|
@@ -13,7 +13,9 @@ require "pokepay_partner_ruby_sdk/request/get_account"
|
|
|
13
13
|
require "pokepay_partner_ruby_sdk/request/update_account"
|
|
14
14
|
require "pokepay_partner_ruby_sdk/request/list_account_balances"
|
|
15
15
|
require "pokepay_partner_ruby_sdk/request/list_account_expired_balances"
|
|
16
|
+
require "pokepay_partner_ruby_sdk/request/get_customer_accounts"
|
|
16
17
|
require "pokepay_partner_ruby_sdk/request/create_customer_account"
|
|
18
|
+
require "pokepay_partner_ruby_sdk/request/get_shop_accounts"
|
|
17
19
|
require "pokepay_partner_ruby_sdk/request/list_bills"
|
|
18
20
|
require "pokepay_partner_ruby_sdk/request/create_bill"
|
|
19
21
|
require "pokepay_partner_ruby_sdk/request/update_bill"
|
|
@@ -73,6 +75,7 @@ require "pokepay_partner_ruby_sdk/response/paginated_private_money_organization_
|
|
|
73
75
|
require "pokepay_partner_ruby_sdk/response/paginated_transaction"
|
|
74
76
|
require "pokepay_partner_ruby_sdk/response/paginated_transfers"
|
|
75
77
|
require "pokepay_partner_ruby_sdk/response/paginated_accounts"
|
|
78
|
+
require "pokepay_partner_ruby_sdk/response/paginated_account_with_users"
|
|
76
79
|
require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
|
|
77
80
|
require "pokepay_partner_ruby_sdk/response/paginated_shops"
|
|
78
81
|
require "pokepay_partner_ruby_sdk/response/paginated_bills"
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
|
2
|
+
|
|
3
|
+
require "pokepay_partner_ruby_sdk/response/paginated_account_with_users"
|
|
4
|
+
|
|
5
|
+
module Pokepay::Request
|
|
6
|
+
class GetCustomerAccounts < Request
|
|
7
|
+
def initialize(private_money_id, rest_args = {})
|
|
8
|
+
@path = "/accounts" + "/customers"
|
|
9
|
+
@method = "GET"
|
|
10
|
+
@body_params = { "private_money_id" => private_money_id }.merge(rest_args)
|
|
11
|
+
@response_class = Pokepay::Response::PaginatedAccountWithUsers
|
|
12
|
+
end
|
|
13
|
+
attr_reader :response_class
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
|
2
|
+
|
|
3
|
+
require "pokepay_partner_ruby_sdk/response/paginated_account_with_users"
|
|
4
|
+
|
|
5
|
+
module Pokepay::Request
|
|
6
|
+
class GetShopAccounts < Request
|
|
7
|
+
def initialize(private_money_id, rest_args = {})
|
|
8
|
+
@path = "/accounts" + "/shops"
|
|
9
|
+
@method = "GET"
|
|
10
|
+
@body_params = { "private_money_id" => private_money_id }.merge(rest_args)
|
|
11
|
+
@response_class = Pokepay::Response::PaginatedAccountWithUsers
|
|
12
|
+
end
|
|
13
|
+
attr_reader :response_class
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
|
2
|
+
|
|
3
|
+
require "pokepay_partner_ruby_sdk/response/pagination"
|
|
4
|
+
|
|
5
|
+
module Pokepay::Response
|
|
6
|
+
class PaginatedAccountWithUsers
|
|
7
|
+
def initialize(row)
|
|
8
|
+
@rows = row["rows"]
|
|
9
|
+
@count = row["count"]
|
|
10
|
+
@pagination = Pagination.new(row["pagination"])
|
|
11
|
+
end
|
|
12
|
+
attr_reader :rows
|
|
13
|
+
attr_reader :count
|
|
14
|
+
attr_reader :pagination
|
|
15
|
+
end
|
|
16
|
+
end
|
data/partner.yaml
CHANGED
|
@@ -757,6 +757,18 @@ components:
|
|
|
757
757
|
minimum: 0
|
|
758
758
|
pagination:
|
|
759
759
|
$ref: '#/components/schemas/Pagination'
|
|
760
|
+
PaginatedAccountWithUsers:
|
|
761
|
+
x-pokepay-schema-type: "response"
|
|
762
|
+
properties:
|
|
763
|
+
rows:
|
|
764
|
+
type: array
|
|
765
|
+
items:
|
|
766
|
+
$ref: '#/components/schemas/AccountWithUser'
|
|
767
|
+
count:
|
|
768
|
+
type: integer
|
|
769
|
+
minimum: 0
|
|
770
|
+
pagination:
|
|
771
|
+
$ref: '#/components/schemas/Pagination'
|
|
760
772
|
PaginatedAccountBalance:
|
|
761
773
|
x-pokepay-schema-type: "response"
|
|
762
774
|
properties:
|
|
@@ -1219,6 +1231,65 @@ paths:
|
|
|
1219
1231
|
'404':
|
|
1220
1232
|
$ref: '#/components/responses/NotFound'
|
|
1221
1233
|
/accounts/customers:
|
|
1234
|
+
get:
|
|
1235
|
+
tags:
|
|
1236
|
+
- Customer
|
|
1237
|
+
summary: 'エンドユーザーのウォレット一覧を表示する'
|
|
1238
|
+
description: マネーを指定してエンドユーザーのウォレット一覧を取得します。
|
|
1239
|
+
x-pokepay-operator-name: "GetCustomerAccounts"
|
|
1240
|
+
x-pokepay-allow-server-side: true
|
|
1241
|
+
requestBody:
|
|
1242
|
+
required: true
|
|
1243
|
+
content:
|
|
1244
|
+
application/json:
|
|
1245
|
+
schema:
|
|
1246
|
+
required: ["private_money_id"]
|
|
1247
|
+
properties:
|
|
1248
|
+
private_money_id:
|
|
1249
|
+
title: 'マネーID'
|
|
1250
|
+
description: |-
|
|
1251
|
+
マネーIDです。
|
|
1252
|
+
|
|
1253
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1254
|
+
type: string
|
|
1255
|
+
format: uuid
|
|
1256
|
+
page:
|
|
1257
|
+
type: integer
|
|
1258
|
+
minimum: 1
|
|
1259
|
+
title: 'ページ番号'
|
|
1260
|
+
description: 取得したいページ番号です。デフォルト値は1です。
|
|
1261
|
+
per_page:
|
|
1262
|
+
type: integer
|
|
1263
|
+
minimum: 1
|
|
1264
|
+
title: '1ページ分のウォレット数'
|
|
1265
|
+
description: 1ページ分のウォレット数です。デフォルト値は30です。
|
|
1266
|
+
created_at_from:
|
|
1267
|
+
type: string
|
|
1268
|
+
format: date-time
|
|
1269
|
+
title: 'ウォレット作成日によるフィルター(開始時点)'
|
|
1270
|
+
description: ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1271
|
+
created_at_to:
|
|
1272
|
+
type: string
|
|
1273
|
+
format: date-time
|
|
1274
|
+
title: 'ウォレット作成日によるフィルター(終了時点)'
|
|
1275
|
+
description: ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1276
|
+
is_suspended:
|
|
1277
|
+
type: boolean
|
|
1278
|
+
title: 'ウォレットが凍結状態かどうかでフィルターする'
|
|
1279
|
+
description: このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1280
|
+
responses:
|
|
1281
|
+
'200':
|
|
1282
|
+
description: OK
|
|
1283
|
+
content:
|
|
1284
|
+
application/json:
|
|
1285
|
+
schema:
|
|
1286
|
+
$ref: '#/components/schemas/PaginatedAccountWithUsers'
|
|
1287
|
+
'400':
|
|
1288
|
+
$ref: '#/components/responses/BadRequest'
|
|
1289
|
+
'403':
|
|
1290
|
+
$ref: '#/components/responses/Forbidden'
|
|
1291
|
+
'422':
|
|
1292
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
1222
1293
|
post:
|
|
1223
1294
|
tags:
|
|
1224
1295
|
- Customer
|
|
@@ -1269,6 +1340,66 @@ paths:
|
|
|
1269
1340
|
$ref: '#/components/responses/Forbidden'
|
|
1270
1341
|
'422':
|
|
1271
1342
|
$ref: '#/components/responses/UnprocessableEntity'
|
|
1343
|
+
/accounts/shops:
|
|
1344
|
+
get:
|
|
1345
|
+
tags:
|
|
1346
|
+
- Customer
|
|
1347
|
+
summary: '店舗ユーザーのウォレット一覧を表示する'
|
|
1348
|
+
description: マネーを指定して店舗ユーザーのウォレット一覧を取得します。
|
|
1349
|
+
x-pokepay-operator-name: "GetShopAccounts"
|
|
1350
|
+
x-pokepay-allow-server-side: true
|
|
1351
|
+
requestBody:
|
|
1352
|
+
required: true
|
|
1353
|
+
content:
|
|
1354
|
+
application/json:
|
|
1355
|
+
schema:
|
|
1356
|
+
required: ["private_money_id"]
|
|
1357
|
+
properties:
|
|
1358
|
+
private_money_id:
|
|
1359
|
+
title: 'マネーID'
|
|
1360
|
+
description: |-
|
|
1361
|
+
マネーIDです。
|
|
1362
|
+
|
|
1363
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1364
|
+
type: string
|
|
1365
|
+
format: uuid
|
|
1366
|
+
page:
|
|
1367
|
+
type: integer
|
|
1368
|
+
minimum: 1
|
|
1369
|
+
title: 'ページ番号'
|
|
1370
|
+
description: 取得したいページ番号です。デフォルト値は1です。
|
|
1371
|
+
per_page:
|
|
1372
|
+
type: integer
|
|
1373
|
+
minimum: 1
|
|
1374
|
+
title: '1ページ分のウォレット数'
|
|
1375
|
+
description: 1ページ分のウォレット数です。デフォルト値は30です。
|
|
1376
|
+
created_at_from:
|
|
1377
|
+
type: string
|
|
1378
|
+
format: date-time
|
|
1379
|
+
title: 'ウォレット作成日によるフィルター(開始時点)'
|
|
1380
|
+
description: ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1381
|
+
created_at_to:
|
|
1382
|
+
type: string
|
|
1383
|
+
format: date-time
|
|
1384
|
+
title: 'ウォレット作成日によるフィルター(終了時点)'
|
|
1385
|
+
description: ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1386
|
+
is_suspended:
|
|
1387
|
+
type: boolean
|
|
1388
|
+
title: 'ウォレットが凍結状態かどうかでフィルターする'
|
|
1389
|
+
description: このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1390
|
+
responses:
|
|
1391
|
+
'200':
|
|
1392
|
+
description: OK
|
|
1393
|
+
content:
|
|
1394
|
+
application/json:
|
|
1395
|
+
schema:
|
|
1396
|
+
$ref: '#/components/schemas/PaginatedAccountWithUsers'
|
|
1397
|
+
'400':
|
|
1398
|
+
$ref: '#/components/responses/BadRequest'
|
|
1399
|
+
'403':
|
|
1400
|
+
$ref: '#/components/responses/Forbidden'
|
|
1401
|
+
'422':
|
|
1402
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
1272
1403
|
/bills:
|
|
1273
1404
|
get:
|
|
1274
1405
|
tags:
|
|
@@ -1675,6 +1806,15 @@ paths:
|
|
|
1675
1806
|
items:
|
|
1676
1807
|
type: string
|
|
1677
1808
|
enum: [topup, payment, exchange_outflow, exchange_inflow]
|
|
1809
|
+
description:
|
|
1810
|
+
type: string
|
|
1811
|
+
maxLength: 200
|
|
1812
|
+
title: '取引説明文'
|
|
1813
|
+
description: |-
|
|
1814
|
+
取引を指定の取引説明文でフィルターします。
|
|
1815
|
+
|
|
1816
|
+
取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
|
|
1817
|
+
example: 店頭QRコードによる支払い
|
|
1678
1818
|
responses:
|
|
1679
1819
|
'200':
|
|
1680
1820
|
description: OK
|
|
@@ -2259,6 +2399,15 @@ paths:
|
|
|
2259
2399
|
items:
|
|
2260
2400
|
type: string
|
|
2261
2401
|
enum: [topup, payment, exchange, transfer]
|
|
2402
|
+
description:
|
|
2403
|
+
type: string
|
|
2404
|
+
maxLength: 200
|
|
2405
|
+
title: '取引詳細説明文'
|
|
2406
|
+
description: |-
|
|
2407
|
+
取引詳細を指定の取引詳細説明文でフィルターします。
|
|
2408
|
+
|
|
2409
|
+
取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
|
|
2410
|
+
example: 店頭QRコードによる支払い
|
|
2262
2411
|
responses:
|
|
2263
2412
|
'200':
|
|
2264
2413
|
description: OK
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: pokepay_partner_ruby_sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.11
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Pocket Change, Inc.
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-07-
|
|
11
|
+
date: 2021-07-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -134,10 +134,12 @@ files:
|
|
|
134
134
|
- lib/pokepay_partner_ruby_sdk/request/get_account.rb
|
|
135
135
|
- lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb
|
|
136
136
|
- lib/pokepay_partner_ruby_sdk/request/get_cashtray.rb
|
|
137
|
+
- lib/pokepay_partner_ruby_sdk/request/get_customer_accounts.rb
|
|
137
138
|
- lib/pokepay_partner_ruby_sdk/request/get_ping.rb
|
|
138
139
|
- lib/pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries.rb
|
|
139
140
|
- lib/pokepay_partner_ruby_sdk/request/get_private_moneys.rb
|
|
140
141
|
- lib/pokepay_partner_ruby_sdk/request/get_shop.rb
|
|
142
|
+
- lib/pokepay_partner_ruby_sdk/request/get_shop_accounts.rb
|
|
141
143
|
- lib/pokepay_partner_ruby_sdk/request/get_transaction.rb
|
|
142
144
|
- lib/pokepay_partner_ruby_sdk/request/get_user.rb
|
|
143
145
|
- lib/pokepay_partner_ruby_sdk/request/list_account_balances.rb
|
|
@@ -173,6 +175,7 @@ files:
|
|
|
173
175
|
- lib/pokepay_partner_ruby_sdk/response/organization.rb
|
|
174
176
|
- lib/pokepay_partner_ruby_sdk/response/organization_summary.rb
|
|
175
177
|
- lib/pokepay_partner_ruby_sdk/response/paginated_account_balance.rb
|
|
178
|
+
- lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb
|
|
176
179
|
- lib/pokepay_partner_ruby_sdk/response/paginated_accounts.rb
|
|
177
180
|
- lib/pokepay_partner_ruby_sdk/response/paginated_bills.rb
|
|
178
181
|
- lib/pokepay_partner_ruby_sdk/response/paginated_private_money_organization_summaries.rb
|