pokepay_partner_ruby_sdk 0.1.13 → 0.1.14
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/index.md +138 -91
- data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb +3 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_account_details.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +1 -0
- data/partner.yaml +57 -2
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 226310eb7b8bd8941522e0112d09a8b90f1a337367b9b2b61a804c53f03c7c4b
|
|
4
|
+
data.tar.gz: ed25376a91f48ec0cb17e94c2e431c25cf431e1b761ebdea1cf5c952f2914578
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 16e284711c5bcb7289ac94c5b5699f3e727db3f30845ce2cc1e8b669250f553c989f1868c49a53fcabeaf94c2e25b2c6fab23a824e53cb103aa41ac81d6ced59
|
|
7
|
+
data.tar.gz: 6ad3f2b0a430b03e3458805eae27e86e798ec755d422e0e01bb3e33541778b58f887561d600655c1127dae732c42bd457f76d0cbc950f5b7e38048d11a10df5e
|
data/Gemfile.lock
CHANGED
data/docs/index.md
CHANGED
|
@@ -182,8 +182,8 @@ response.body
|
|
|
182
182
|
取引一覧を返します。
|
|
183
183
|
```ruby
|
|
184
184
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
185
|
-
from: "
|
|
186
|
-
to: "
|
|
185
|
+
from: "2017-05-10T09:01:07.000000+09:00", # 開始日時
|
|
186
|
+
to: "2017-02-12T17:02:56.000000+09:00", # 終了日時
|
|
187
187
|
page: 1, # ページ番号
|
|
188
188
|
per_page: 50, # 1ページ分の取引数
|
|
189
189
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
@@ -390,10 +390,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
|
390
390
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
391
391
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
392
392
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
393
|
-
money_amount:
|
|
394
|
-
point_amount:
|
|
395
|
-
point_expires_at: "
|
|
396
|
-
description: "
|
|
393
|
+
money_amount: 5545,
|
|
394
|
+
point_amount: 6708,
|
|
395
|
+
point_expires_at: "2024-02-06T11:02:52.000000+09:00", # ポイント有効期限
|
|
396
|
+
description: "CafuN856J50SdiADG37eydGENMPuSUGCPNHip0"
|
|
397
397
|
))
|
|
398
398
|
```
|
|
399
399
|
|
|
@@ -419,9 +419,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
419
419
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
420
420
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
421
421
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
422
|
-
money_amount:
|
|
423
|
-
point_amount:
|
|
424
|
-
point_expires_at: "
|
|
422
|
+
money_amount: 7001, # マネー額
|
|
423
|
+
point_amount: 650, # ポイント額
|
|
424
|
+
point_expires_at: "2018-05-18T16:46:21.000000+09:00", # ポイント有効期限
|
|
425
425
|
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
|
426
426
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
427
427
|
))
|
|
@@ -548,7 +548,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
548
548
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
549
549
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
550
550
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
551
|
-
|
|
551
|
+
6244, # amount: 支払い額
|
|
552
552
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
553
553
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
554
554
|
))
|
|
@@ -640,7 +640,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
640
640
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
641
641
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
642
642
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
643
|
-
|
|
643
|
+
2754, # amount: 送金額
|
|
644
644
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
645
645
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
646
646
|
))
|
|
@@ -729,8 +729,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
|
729
729
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
730
730
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
731
731
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
732
|
-
|
|
733
|
-
description: "
|
|
732
|
+
7140,
|
|
733
|
+
description: "Xe1sIjLSVztCspdpKcDGU85LATApzQ2dQG1XtK0UfX1fzmKZw4jAX5TdVMZA3FsBWHTaR7q8iHovbTWoPNbCUX3WmvU0lnYW7MWulxJqejEoXiemEzy22TP2wtSY9IoDSrJUA2sSTBsOwjVmr0",
|
|
734
734
|
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
735
735
|
))
|
|
736
736
|
```
|
|
@@ -787,19 +787,19 @@ response = $client.send(Pokepay::Request::RefundTransaction.new(
|
|
|
787
787
|
####
|
|
788
788
|
```ruby
|
|
789
789
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
790
|
-
from: "
|
|
791
|
-
to: "
|
|
792
|
-
page:
|
|
793
|
-
per_page:
|
|
790
|
+
from: "2020-12-08T12:26:18.000000+09:00",
|
|
791
|
+
to: "2017-11-24T07:36:36.000000+09:00",
|
|
792
|
+
page: 4740,
|
|
793
|
+
per_page: 1712,
|
|
794
794
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
795
|
-
shop_name: "
|
|
795
|
+
shop_name: "79fqhITnnz7WaCAiQd9B8sle88sl7rSWKN9oQjHsNX48VkSyiuzE1L2wv36YuE4jwp0IiR44I5KLiOrRKq3qxtTGifN6KrraD5uojwDmQdLNOKHIlDiaOh78QfhNbZ3YfGhlbqaOElvScjtjkG1",
|
|
796
796
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
797
|
-
customer_name: "
|
|
797
|
+
customer_name: "WEjltqaYkhp7caXjUtBcNe9XyY4wthFo0glXBErIUB1p7aPMzXnAdDrY96Gn0OAQ9xSN0zfKx7ivixiVqjgvBNcsQLQxAtJm",
|
|
798
798
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
799
799
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
800
|
-
is_modified:
|
|
801
|
-
transaction_types: ["transfer", "exchange"],
|
|
802
|
-
transfer_types: ["
|
|
800
|
+
is_modified: true,
|
|
801
|
+
transaction_types: ["transfer", "payment", "topup", "exchange"],
|
|
802
|
+
transfer_types: ["exchange", "payment", "campaign", "transfer"], # 取引明細の種類でフィルターします。
|
|
803
803
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
804
804
|
))
|
|
805
805
|
```
|
|
@@ -907,19 +907,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
907
907
|
支払いQRコード一覧を表示します。
|
|
908
908
|
```ruby
|
|
909
909
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
910
|
-
page:
|
|
911
|
-
per_page:
|
|
912
|
-
bill_id: "
|
|
910
|
+
page: 5974, # ページ番号
|
|
911
|
+
per_page: 4994, # 1ページの表示数
|
|
912
|
+
bill_id: "kNd3", # 支払いQRコードのID
|
|
913
913
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
914
|
-
organization_code: "--
|
|
914
|
+
organization_code: "jUp3-N--X92Fbs--D0fn--Hx6Q-zy1", # 組織コード
|
|
915
915
|
description: "test bill", # 取引説明文
|
|
916
|
-
created_from: "2017-
|
|
917
|
-
created_to: "
|
|
916
|
+
created_from: "2017-04-21T18:37:28.000000+09:00", # 作成日時(起点)
|
|
917
|
+
created_to: "2021-05-08T05:36:00.000000+09:00", # 作成日時(終点)
|
|
918
918
|
shop_name: "bill test shop1", # 店舗名
|
|
919
919
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
920
|
-
lower_limit_amount:
|
|
921
|
-
upper_limit_amount:
|
|
922
|
-
is_disabled:
|
|
920
|
+
lower_limit_amount: 6767, # 金額の範囲によるフィルタ(下限)
|
|
921
|
+
upper_limit_amount: 2585, # 金額の範囲によるフィルタ(上限)
|
|
922
|
+
is_disabled: false # 支払いQRコードが無効化されているかどうか
|
|
923
923
|
))
|
|
924
924
|
```
|
|
925
925
|
|
|
@@ -1063,7 +1063,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
|
1063
1063
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
1064
1064
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
1065
1065
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
1066
|
-
amount:
|
|
1066
|
+
amount: 8458, # 支払い額
|
|
1067
1067
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
1068
1068
|
))
|
|
1069
1069
|
```
|
|
@@ -1087,7 +1087,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
|
1087
1087
|
```ruby
|
|
1088
1088
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
1089
1089
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
1090
|
-
amount:
|
|
1090
|
+
amount: 45, # 支払い額
|
|
1091
1091
|
description: "test bill", # 説明文
|
|
1092
1092
|
is_disabled: false # 無効化されているかどうか
|
|
1093
1093
|
))
|
|
@@ -1152,9 +1152,9 @@ Cashtrayを作成します。
|
|
|
1152
1152
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
1153
1153
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1154
1154
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1155
|
-
|
|
1155
|
+
6575, # amount: 金額
|
|
1156
1156
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1157
|
-
expires_in:
|
|
1157
|
+
expires_in: 1228 # 失効時間(秒)
|
|
1158
1158
|
))
|
|
1159
1159
|
```
|
|
1160
1160
|
|
|
@@ -1315,9 +1315,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
|
1315
1315
|
```ruby
|
|
1316
1316
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
1317
1317
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
1318
|
-
amount:
|
|
1318
|
+
amount: 7001, # 金額
|
|
1319
1319
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1320
|
-
expires_in:
|
|
1320
|
+
expires_in: 6822 # 失効時間(秒)
|
|
1321
1321
|
))
|
|
1322
1322
|
```
|
|
1323
1323
|
|
|
@@ -1423,10 +1423,10 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
|
1423
1423
|
```ruby
|
|
1424
1424
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
1425
1425
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1426
|
-
page:
|
|
1427
|
-
per_page:
|
|
1428
|
-
expires_at_from: "
|
|
1429
|
-
expires_at_to: "
|
|
1426
|
+
page: 2373, # ページ番号
|
|
1427
|
+
per_page: 451, # 1ページ分の取引数
|
|
1428
|
+
expires_at_from: "2023-01-18T09:59:31.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1429
|
+
expires_at_to: "2016-09-25T04:41:30.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1430
1430
|
direction: "asc" # 有効期限によるソート順序
|
|
1431
1431
|
))
|
|
1432
1432
|
```
|
|
@@ -1501,11 +1501,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
|
1501
1501
|
```ruby
|
|
1502
1502
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
1503
1503
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1504
|
-
page:
|
|
1505
|
-
per_page:
|
|
1506
|
-
expires_at_from: "
|
|
1507
|
-
expires_at_to: "
|
|
1508
|
-
direction: "
|
|
1504
|
+
page: 1228, # ページ番号
|
|
1505
|
+
per_page: 7032, # 1ページ分の取引数
|
|
1506
|
+
expires_at_from: "2023-02-16T15:27:38.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1507
|
+
expires_at_to: "2025-04-18T14:51:29.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1508
|
+
direction: "asc" # 有効期限によるソート順序
|
|
1509
1509
|
))
|
|
1510
1510
|
```
|
|
1511
1511
|
|
|
@@ -1579,11 +1579,14 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
1579
1579
|
```ruby
|
|
1580
1580
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
1581
1581
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1582
|
-
page:
|
|
1583
|
-
per_page:
|
|
1584
|
-
created_at_from: "
|
|
1585
|
-
created_at_to: "
|
|
1586
|
-
is_suspended:
|
|
1582
|
+
page: 4539, # ページ番号
|
|
1583
|
+
per_page: 2772, # 1ページ分のウォレット数
|
|
1584
|
+
created_at_from: "2023-12-25T19:33:57.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1585
|
+
created_at_to: "2020-11-16T21:21:47.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1586
|
+
is_suspended: true, # ウォレットが凍結状態かどうかでフィルターする
|
|
1587
|
+
external_id: "vjsqVkcSInvOjFPIL9qlVM", # 外部ID
|
|
1588
|
+
tel: "07018335-9579", # エンドユーザーの電話番号
|
|
1589
|
+
email: "805Swtsg2N@kJBD.com" # エンドユーザーのメールアドレス
|
|
1587
1590
|
))
|
|
1588
1591
|
```
|
|
1589
1592
|
|
|
@@ -1646,6 +1649,36 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
|
1646
1649
|
```
|
|
1647
1650
|
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1648
1651
|
|
|
1652
|
+
---
|
|
1653
|
+
`external_id`
|
|
1654
|
+
```json
|
|
1655
|
+
{
|
|
1656
|
+
"type": "string",
|
|
1657
|
+
"maxLength": 50
|
|
1658
|
+
}
|
|
1659
|
+
```
|
|
1660
|
+
外部IDでのフィルタリングです。デフォルトでは未指定です。
|
|
1661
|
+
|
|
1662
|
+
---
|
|
1663
|
+
`tel`
|
|
1664
|
+
```json
|
|
1665
|
+
{
|
|
1666
|
+
"type": "string",
|
|
1667
|
+
"pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
|
|
1668
|
+
}
|
|
1669
|
+
```
|
|
1670
|
+
エンドユーザーの電話番号でのフィルタリングです。デフォルトでは未指定です。
|
|
1671
|
+
|
|
1672
|
+
---
|
|
1673
|
+
`email`
|
|
1674
|
+
```json
|
|
1675
|
+
{
|
|
1676
|
+
"type": "string",
|
|
1677
|
+
"format": "email"
|
|
1678
|
+
}
|
|
1679
|
+
```
|
|
1680
|
+
エンドユーザーのメールアドレスでのフィルタリングです。デフォルトでは未指定です。
|
|
1681
|
+
|
|
1649
1682
|
---
|
|
1650
1683
|
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1651
1684
|
<a name="create-customer-account"></a>
|
|
@@ -1655,7 +1688,8 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
|
1655
1688
|
response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
1656
1689
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1657
1690
|
user_name: "ポケペイ太郎", # ユーザー名
|
|
1658
|
-
account_name: "ポケペイ太郎のアカウント"
|
|
1691
|
+
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
|
1692
|
+
external_id: "WoqdLq3QmHRbZpwbP" # 外部ID
|
|
1659
1693
|
))
|
|
1660
1694
|
```
|
|
1661
1695
|
|
|
@@ -1691,6 +1725,16 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
|
1691
1725
|
```
|
|
1692
1726
|
作成するウォレット名です。省略した場合は空文字となります。
|
|
1693
1727
|
|
|
1728
|
+
---
|
|
1729
|
+
`external_id`
|
|
1730
|
+
```json
|
|
1731
|
+
{
|
|
1732
|
+
"type": "string",
|
|
1733
|
+
"maxLength": 50
|
|
1734
|
+
}
|
|
1735
|
+
```
|
|
1736
|
+
PAPIクライアントシステムから利用するPokepayユーザーのIDです。デフォルトでは未指定です。
|
|
1737
|
+
|
|
1694
1738
|
---
|
|
1695
1739
|
成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
|
|
1696
1740
|
<a name="get-shop-accounts"></a>
|
|
@@ -1699,10 +1743,10 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
|
1699
1743
|
```ruby
|
|
1700
1744
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
1701
1745
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1702
|
-
page:
|
|
1703
|
-
per_page:
|
|
1704
|
-
created_at_from: "2021-
|
|
1705
|
-
created_at_to: "
|
|
1746
|
+
page: 83, # ページ番号
|
|
1747
|
+
per_page: 5866, # 1ページ分のウォレット数
|
|
1748
|
+
created_at_from: "2021-03-18T09:33:18.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1749
|
+
created_at_to: "2019-10-15T23:24:49.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1706
1750
|
is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
|
|
1707
1751
|
))
|
|
1708
1752
|
```
|
|
@@ -1776,10 +1820,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
1776
1820
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1777
1821
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
1778
1822
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
1779
|
-
type: "
|
|
1823
|
+
type: "B6hajGJrCJ", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
|
|
1780
1824
|
is_modified: true, # キャンセル済みかどうか
|
|
1781
|
-
from: "2019-
|
|
1782
|
-
to: "
|
|
1825
|
+
from: "2019-02-13T12:10:46.000000+09:00", # 開始日時
|
|
1826
|
+
to: "2017-02-20T06:05:40.000000+09:00", # 終了日時
|
|
1783
1827
|
page: 1, # ページ番号
|
|
1784
1828
|
per_page: 50 # 1ページ分の取引数
|
|
1785
1829
|
))
|
|
@@ -1904,11 +1948,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
1904
1948
|
organization_code: "pocketchange", # 組織コード
|
|
1905
1949
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1906
1950
|
name: "oxスーパー三田店", # 店舗名
|
|
1907
|
-
postal_code: "
|
|
1951
|
+
postal_code: "800-9576", # 店舗の郵便番号
|
|
1908
1952
|
address: "東京都港区芝...", # 店舗の住所
|
|
1909
|
-
tel: "
|
|
1910
|
-
email: "
|
|
1911
|
-
external_id: "
|
|
1953
|
+
tel: "089682-5023", # 店舗の電話番号
|
|
1954
|
+
email: "jlaztijN3v@ebjT.com", # 店舗のメールアドレス
|
|
1955
|
+
external_id: "69RjYRPCqvnZ1YzdrhGH7XKNoGDpqqjY", # 店舗の外部ID
|
|
1912
1956
|
page: 1, # ページ番号
|
|
1913
1957
|
per_page: 50 # 1ページ分の取引数
|
|
1914
1958
|
))
|
|
@@ -2033,11 +2077,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
2033
2077
|
```ruby
|
|
2034
2078
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
2035
2079
|
"oxスーパー三田店", # shop_name: 店舗名
|
|
2036
|
-
shop_postal_code: "
|
|
2080
|
+
shop_postal_code: "5142087", # 店舗の郵便番号
|
|
2037
2081
|
shop_address: "東京都港区芝...", # 店舗の住所
|
|
2038
|
-
shop_tel: "
|
|
2039
|
-
shop_email: "
|
|
2040
|
-
shop_external_id: "
|
|
2082
|
+
shop_tel: "0074-18354932", # 店舗の電話番号
|
|
2083
|
+
shop_email: "YdhYyR9ZtW@hMAK.com", # 店舗のメールアドレス
|
|
2084
|
+
shop_external_id: "ZHQ2Tjahc0hASAcEibjk", # 店舗の外部ID
|
|
2041
2085
|
organization_code: "ox-supermarket" # 組織コード
|
|
2042
2086
|
))
|
|
2043
2087
|
```
|
|
@@ -2047,13 +2091,13 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
|
2047
2091
|
```ruby
|
|
2048
2092
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
2049
2093
|
"oxスーパー三田店", # name: 店舗名
|
|
2050
|
-
postal_code: "
|
|
2094
|
+
postal_code: "5184159", # 店舗の郵便番号
|
|
2051
2095
|
address: "東京都港区芝...", # 店舗の住所
|
|
2052
|
-
tel: "
|
|
2053
|
-
email: "
|
|
2054
|
-
external_id: "
|
|
2096
|
+
tel: "07-97912", # 店舗の電話番号
|
|
2097
|
+
email: "FrkXVihIdQ@Wu7J.com", # 店舗のメールアドレス
|
|
2098
|
+
external_id: "4NYirXryPP6taqbm6hsnA9hELka", # 店舗の外部ID
|
|
2055
2099
|
organization_code: "ox-supermarket", # 組織コード
|
|
2056
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
2100
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2057
2101
|
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
2058
2102
|
))
|
|
2059
2103
|
```
|
|
@@ -2125,11 +2169,11 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
|
2125
2169
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
2126
2170
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
2127
2171
|
name: "oxスーパー三田店", # 店舗名
|
|
2128
|
-
postal_code: "
|
|
2172
|
+
postal_code: "376-2080", # 店舗の郵便番号
|
|
2129
2173
|
address: "東京都港区芝...", # 店舗の住所
|
|
2130
|
-
tel: "
|
|
2131
|
-
email: "
|
|
2132
|
-
external_id: "
|
|
2174
|
+
tel: "041115489", # 店舗の電話番号
|
|
2175
|
+
email: "VIgVP7fIz1@xemn.com", # 店舗のメールアドレス
|
|
2176
|
+
external_id: "x9P7H", # 店舗の外部ID
|
|
2133
2177
|
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2134
2178
|
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
|
2135
2179
|
))
|
|
@@ -2248,7 +2292,7 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
|
2248
2292
|
指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
|
|
2249
2293
|
|
|
2250
2294
|
---
|
|
2251
|
-
成功したときは[
|
|
2295
|
+
成功したときは[PaginatedAccountDetails](#paginated-account-details)オブジェクトを返します
|
|
2252
2296
|
### Private Money
|
|
2253
2297
|
<a name="get-private-moneys"></a>
|
|
2254
2298
|
#### マネー一覧を取得する
|
|
@@ -2281,8 +2325,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
|
2281
2325
|
```ruby
|
|
2282
2326
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
2283
2327
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2284
|
-
from: "
|
|
2285
|
-
to: "
|
|
2328
|
+
from: "2016-05-21T23:00:33.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
2329
|
+
to: "2021-05-24T13:34:12.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
2286
2330
|
page: 1, # ページ番号
|
|
2287
2331
|
per_page: 50 # 1ページ分の取引数
|
|
2288
2332
|
))
|
|
@@ -2296,10 +2340,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
2296
2340
|
CSVファイルから一括取引をします。
|
|
2297
2341
|
```ruby
|
|
2298
2342
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
2299
|
-
"
|
|
2300
|
-
"
|
|
2301
|
-
"
|
|
2302
|
-
description: "
|
|
2343
|
+
"lwWZKuWWf4n5wNPq2rjN28", # name: 一括取引タスク名
|
|
2344
|
+
"QfQLnQ9Qr", # content: 取引する情報のCSV
|
|
2345
|
+
"2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCpNJ", # request_id: リクエストID
|
|
2346
|
+
description: "ZG6LzTWIbd8ZNVrafdiivNn4NbNLXIdoiqtrelImUNmLeKEfXUc2dQExu22E4bXnTsrAuXzc" # 一括取引の説明
|
|
2303
2347
|
))
|
|
2304
2348
|
```
|
|
2305
2349
|
|
|
@@ -2388,9 +2432,12 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
|
2388
2432
|
* `money_balance (double)`:
|
|
2389
2433
|
* `point_balance (double)`:
|
|
2390
2434
|
* `private_money (PrivateMoney)`:
|
|
2435
|
+
* `user (User)`:
|
|
2391
2436
|
|
|
2392
2437
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
2393
2438
|
|
|
2439
|
+
`user`は [User](#user) オブジェクトを返します。
|
|
2440
|
+
|
|
2394
2441
|
<a name="bill"></a>
|
|
2395
2442
|
## Bill
|
|
2396
2443
|
* `id (string)`: 支払いQRコードのID
|
|
@@ -2515,23 +2562,23 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
|
2515
2562
|
|
|
2516
2563
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2517
2564
|
|
|
2518
|
-
<a name="paginated-
|
|
2519
|
-
##
|
|
2520
|
-
* `rows (array of
|
|
2565
|
+
<a name="paginated-account-with-users"></a>
|
|
2566
|
+
## PaginatedAccountWithUsers
|
|
2567
|
+
* `rows (array of AccountWithUsers)`:
|
|
2521
2568
|
* `count (integer)`:
|
|
2522
2569
|
* `pagination (Pagination)`:
|
|
2523
2570
|
|
|
2524
|
-
`rows`は [
|
|
2571
|
+
`rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
|
|
2525
2572
|
|
|
2526
2573
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2527
2574
|
|
|
2528
|
-
<a name="paginated-account-
|
|
2529
|
-
##
|
|
2530
|
-
* `rows (array of
|
|
2575
|
+
<a name="paginated-account-details"></a>
|
|
2576
|
+
## PaginatedAccountDetails
|
|
2577
|
+
* `rows (array of AccountDetails)`:
|
|
2531
2578
|
* `count (integer)`:
|
|
2532
2579
|
* `pagination (Pagination)`:
|
|
2533
2580
|
|
|
2534
|
-
`rows`は [
|
|
2581
|
+
`rows`は [AccountDetail](#account-detail) オブジェクトの配列を返します。
|
|
2535
2582
|
|
|
2536
2583
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2537
2584
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# DO NOT EDIT: File is generated by code generator.
|
|
2
2
|
|
|
3
|
-
require "pokepay_partner_ruby_sdk/response/
|
|
3
|
+
require "pokepay_partner_ruby_sdk/response/paginated_account_details"
|
|
4
4
|
|
|
5
5
|
module Pokepay::Request
|
|
6
6
|
class ListUserAccounts < Request
|
|
@@ -8,7 +8,7 @@ module Pokepay::Request
|
|
|
8
8
|
@path = "/users" + "/" + user_id + "/accounts"
|
|
9
9
|
@method = "GET"
|
|
10
10
|
@body_params = { }
|
|
11
|
-
@response_class = Pokepay::Response::
|
|
11
|
+
@response_class = Pokepay::Response::PaginatedAccountDetails
|
|
12
12
|
end
|
|
13
13
|
attr_reader :response_class
|
|
14
14
|
end
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# DO NOT EDIT: File is generated by code generator.
|
|
2
2
|
|
|
3
3
|
require "pokepay_partner_ruby_sdk/response/private_money"
|
|
4
|
+
require "pokepay_partner_ruby_sdk/response/user"
|
|
4
5
|
|
|
5
6
|
module Pokepay::Response
|
|
6
7
|
class AccountDetail
|
|
@@ -12,6 +13,7 @@ module Pokepay::Response
|
|
|
12
13
|
@money_balance = row["money_balance"]
|
|
13
14
|
@point_balance = row["point_balance"]
|
|
14
15
|
@private_money = PrivateMoney.new(row["private_money"])
|
|
16
|
+
@user = User.new(row["user"])
|
|
15
17
|
end
|
|
16
18
|
attr_reader :id
|
|
17
19
|
attr_reader :name
|
|
@@ -20,5 +22,6 @@ module Pokepay::Response
|
|
|
20
22
|
attr_reader :money_balance
|
|
21
23
|
attr_reader :point_balance
|
|
22
24
|
attr_reader :private_money
|
|
25
|
+
attr_reader :user
|
|
23
26
|
end
|
|
24
27
|
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 PaginatedAccountDetails
|
|
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
|
|
@@ -76,6 +76,7 @@ require "pokepay_partner_ruby_sdk/response/paginated_transaction"
|
|
|
76
76
|
require "pokepay_partner_ruby_sdk/response/paginated_transfers"
|
|
77
77
|
require "pokepay_partner_ruby_sdk/response/paginated_accounts"
|
|
78
78
|
require "pokepay_partner_ruby_sdk/response/paginated_account_with_users"
|
|
79
|
+
require "pokepay_partner_ruby_sdk/response/paginated_account_details"
|
|
79
80
|
require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
|
|
80
81
|
require "pokepay_partner_ruby_sdk/response/paginated_shops"
|
|
81
82
|
require "pokepay_partner_ruby_sdk/response/paginated_bills"
|
data/partner.yaml
CHANGED
|
@@ -145,6 +145,8 @@ components:
|
|
|
145
145
|
format: decimal
|
|
146
146
|
private_money:
|
|
147
147
|
$ref: '#/components/schemas/PrivateMoney'
|
|
148
|
+
user:
|
|
149
|
+
$ref: '#/components/schemas/User'
|
|
148
150
|
ShopAccount:
|
|
149
151
|
x-pokepay-schema-type: "response"
|
|
150
152
|
properties:
|
|
@@ -769,6 +771,18 @@ components:
|
|
|
769
771
|
minimum: 0
|
|
770
772
|
pagination:
|
|
771
773
|
$ref: '#/components/schemas/Pagination'
|
|
774
|
+
PaginatedAccountDetails:
|
|
775
|
+
x-pokepay-schema-type: "response"
|
|
776
|
+
properties:
|
|
777
|
+
rows:
|
|
778
|
+
type: array
|
|
779
|
+
items:
|
|
780
|
+
$ref: '#/components/schemas/AccountDetail'
|
|
781
|
+
count:
|
|
782
|
+
type: integer
|
|
783
|
+
minimum: 0
|
|
784
|
+
pagination:
|
|
785
|
+
$ref: '#/components/schemas/Pagination'
|
|
772
786
|
PaginatedAccountBalance:
|
|
773
787
|
x-pokepay-schema-type: "response"
|
|
774
788
|
properties:
|
|
@@ -915,6 +929,20 @@ components:
|
|
|
915
929
|
message:
|
|
916
930
|
type: string
|
|
917
931
|
|
|
932
|
+
PrivateMoneyNotAvailable:
|
|
933
|
+
properties:
|
|
934
|
+
type:
|
|
935
|
+
type: string
|
|
936
|
+
pattern: '^unpermitted_private_money$'
|
|
937
|
+
message:
|
|
938
|
+
type: string
|
|
939
|
+
example: 'This money is not available'
|
|
940
|
+
object:
|
|
941
|
+
type: array
|
|
942
|
+
items:
|
|
943
|
+
type: string
|
|
944
|
+
format: uuid
|
|
945
|
+
|
|
918
946
|
responses:
|
|
919
947
|
BadRequest:
|
|
920
948
|
description: Bad Request
|
|
@@ -1020,7 +1048,7 @@ paths:
|
|
|
1020
1048
|
content:
|
|
1021
1049
|
application/json:
|
|
1022
1050
|
schema:
|
|
1023
|
-
$ref: '#/components/schemas/
|
|
1051
|
+
$ref: '#/components/schemas/PaginatedAccountDetails'
|
|
1024
1052
|
'400':
|
|
1025
1053
|
$ref: '#/components/responses/BadRequest'
|
|
1026
1054
|
'403':
|
|
@@ -1277,6 +1305,21 @@ paths:
|
|
|
1277
1305
|
type: boolean
|
|
1278
1306
|
title: 'ウォレットが凍結状態かどうかでフィルターする'
|
|
1279
1307
|
description: このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1308
|
+
external_id:
|
|
1309
|
+
type: string
|
|
1310
|
+
maxLength: 50
|
|
1311
|
+
title: '外部ID'
|
|
1312
|
+
description: 外部IDでのフィルタリングです。デフォルトでは未指定です。
|
|
1313
|
+
tel:
|
|
1314
|
+
type: string
|
|
1315
|
+
pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
|
|
1316
|
+
title: 'エンドユーザーの電話番号'
|
|
1317
|
+
description: エンドユーザーの電話番号でのフィルタリングです。デフォルトでは未指定です。
|
|
1318
|
+
email:
|
|
1319
|
+
type: string
|
|
1320
|
+
format: email
|
|
1321
|
+
title: 'エンドユーザーのメールアドレス'
|
|
1322
|
+
description: エンドユーザーのメールアドレスでのフィルタリングです。デフォルトでは未指定です。
|
|
1280
1323
|
responses:
|
|
1281
1324
|
'200':
|
|
1282
1325
|
description: OK
|
|
@@ -1327,6 +1370,12 @@ paths:
|
|
|
1327
1370
|
type: string
|
|
1328
1371
|
maxLength: 256
|
|
1329
1372
|
example: ポケペイ太郎のアカウント
|
|
1373
|
+
external_id:
|
|
1374
|
+
title: '外部ID'
|
|
1375
|
+
description: |-
|
|
1376
|
+
PAPIクライアントシステムから利用するPokepayユーザーのIDです。デフォルトでは未指定です。
|
|
1377
|
+
type: string
|
|
1378
|
+
maxLength: 50
|
|
1330
1379
|
responses:
|
|
1331
1380
|
'200':
|
|
1332
1381
|
description: OK
|
|
@@ -2815,7 +2864,13 @@ paths:
|
|
|
2815
2864
|
'409':
|
|
2816
2865
|
$ref: '#/components/responses/Conflict'
|
|
2817
2866
|
'422':
|
|
2818
|
-
|
|
2867
|
+
description:
|
|
2868
|
+
content:
|
|
2869
|
+
application/json:
|
|
2870
|
+
schema:
|
|
2871
|
+
oneOf:
|
|
2872
|
+
- $ref: '#/components/schemas/PrivateMoneyNotAvailable'
|
|
2873
|
+
- $ref: '#/components/schemas/UnprocessableEntity'
|
|
2819
2874
|
/shops/{shop_id}:
|
|
2820
2875
|
get:
|
|
2821
2876
|
tags:
|
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.14
|
|
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-
|
|
11
|
+
date: 2021-09-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -175,6 +175,7 @@ files:
|
|
|
175
175
|
- lib/pokepay_partner_ruby_sdk/response/organization.rb
|
|
176
176
|
- lib/pokepay_partner_ruby_sdk/response/organization_summary.rb
|
|
177
177
|
- lib/pokepay_partner_ruby_sdk/response/paginated_account_balance.rb
|
|
178
|
+
- lib/pokepay_partner_ruby_sdk/response/paginated_account_details.rb
|
|
178
179
|
- lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb
|
|
179
180
|
- lib/pokepay_partner_ruby_sdk/response/paginated_accounts.rb
|
|
180
181
|
- lib/pokepay_partner_ruby_sdk/response/paginated_bills.rb
|