pokepay_partner_ruby_sdk 0.1.15.1 → 0.1.17

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.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docs/index.md +321 -117
  4. data/lib/pokepay_partner_ruby_sdk/request/create_external_transaction.rb +18 -0
  5. data/lib/pokepay_partner_ruby_sdk/request/create_user_account.rb +15 -0
  6. data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb +2 -2
  7. data/lib/pokepay_partner_ruby_sdk/request/refund_external_transaction.rb +15 -0
  8. data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
  9. data/lib/pokepay_partner_ruby_sdk.rb +3 -0
  10. data/partner.yaml +242 -0
  11. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: faed3d5fea3e95e4593e617fcac553c4a2562e9110ee14a5dc3209ec12b02f78
4
- data.tar.gz: 68ad70dc763a253d51a153e11cea8c1a5f88b4a1328e2582941022fd5bfdf73b
3
+ metadata.gz: f40209545091500cc40af76b43328bf118f37532392281ec184eb4acab2dc2d1
4
+ data.tar.gz: fe71b9d6e781e61ef1cb7f45f71258923d3e2f21cb315e21cffee597d2c16c70
5
5
  SHA512:
6
- metadata.gz: 96dc299dea8f3db2f0cd7ab4607335eaeee7cc83f378ce70bf41515b61d95e63bcd53a869920ddeeed8c127ab5f6daef445e8d0d4a4f4bb922ec4fc631b112ce
7
- data.tar.gz: 67954f60e9cde1e54b63899575ae2dd2829acba462467af2acaf2783bd0b280b087aa1de3b202a2fc30e097e32fd4a5f6ded108fe499ba94229c8ef9ddb933ae
6
+ metadata.gz: dcbeac75ab5891a4efbd661434e6186f8ad5a22740b2934146659f81af111db9fa5e618a24cb9ab27bbc90babd7a7ebc5d3d3c34d4e2431888fe4e7d5a2e4c7e
7
+ data.tar.gz: 66d131f3377dbcc11952917ccc05d0d6ac281835d3fd915765711bdda70e643ee8ebbc5922659e2031bae6d9fec5741bb37d868a8c0721428bec1f266c3b1b5e
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- pokepay_partner_ruby_sdk (0.1.15.1)
4
+ pokepay_partner_ruby_sdk (0.1.17)
5
5
  inifile (~> 3.0.0)
6
6
  json (~> 2.3.0)
7
7
  openssl (~> 2.1.2)
data/docs/index.md CHANGED
@@ -189,16 +189,19 @@ response.body
189
189
  - [GetShop](#get-shop): 店舗情報を表示する
190
190
  - [UpdateShop](#update-shop): 店舗情報を更新する
191
191
  - [ListUserAccounts](#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
192
+ - [CreateUserAccount](#create-user-account): エンドユーザーのウォレットを作成する
192
193
  - [GetPrivateMoneys](#get-private-moneys): マネー一覧を取得する
193
194
  - [GetPrivateMoneyOrganizationSummaries](#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
194
195
  - [BulkCreateTransaction](#bulk-create-transaction): CSVファイル一括取引
196
+ - [CreateExternalTransaction](#create-external-transaction): ポケペイ外部取引を作成する
197
+ - [RefundExternalTransaction](#refund-external-transaction): ポケペイ外部取引をキャンセルする
195
198
  ### Transaction
196
199
  <a name="get-cpm-token"></a>
197
200
  #### CPMトークンの状態取得
198
201
  CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
199
202
  ```ruby
200
203
  response = $client.send(Pokepay::Request::GetCpmToken.new(
201
- "EKYDjBWPKCwbirzvScUvjs" # cpm_token: CPMトークン
204
+ "6b0IY83jSy9CLjq8yjjxIn" # cpm_token: CPMトークン
202
205
  ))
203
206
  ```
204
207
 
@@ -220,8 +223,8 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
220
223
  取引一覧を返します。
221
224
  ```ruby
222
225
  response = $client.send(Pokepay::Request::ListTransactions.new(
223
- from: "2023-06-11T07:51:21.000000+09:00", # 開始日時
224
- to: "2022-06-22T01:22:59.000000+09:00", # 終了日時
226
+ from: "2017-02-04T15:50:33.000000+09:00", # 開始日時
227
+ to: "2015-11-01T07:49:45.000000+09:00", # 終了日時
225
228
  page: 1, # ページ番号
226
229
  per_page: 50, # 1ページ分の取引数
227
230
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
@@ -428,10 +431,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
428
431
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
429
432
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
430
433
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
431
- money_amount: 4169,
432
- point_amount: 2565,
433
- point_expires_at: "2022-07-08T13:32:38.000000+09:00", # ポイント有効期限
434
- description: "jFPIL9qlVMwg0ANEHCj5eM805Swtsg2NkJBDvuxWoqdLq3QmHRbZpwbPRidVG7B6hajGJrCJBxTKH0YU"
434
+ money_amount: 3266,
435
+ point_amount: 8558,
436
+ point_expires_at: "2022-10-27T22:44:36.000000+09:00", # ポイント有効期限
437
+ description: "5NxHP7"
435
438
  ))
436
439
  ```
437
440
 
@@ -457,9 +460,9 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
457
460
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
458
461
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
459
462
  bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
460
- money_amount: 6743, # マネー額
461
- point_amount: 734, # ポイント額
462
- point_expires_at: "2025-05-30T13:08:03.000000+09:00", # ポイント有効期限
463
+ money_amount: 4291, # マネー額
464
+ point_amount: 9746, # ポイント額
465
+ point_expires_at: "2024-02-13T23:55:13.000000+09:00", # ポイント有効期限
463
466
  description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
464
467
  metadata: "{\"key\":\"value\"}", # 取引メタデータ
465
468
  request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
@@ -599,7 +602,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
599
602
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
600
603
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
601
604
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
602
- 2221, # amount: 支払い額
605
+ 1057, # amount: 支払い額
603
606
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
604
607
  metadata: "{\"key\":\"value\"}", # 取引メタデータ
605
608
  products: [{"jan_code":"abc",
@@ -607,6 +610,11 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
607
610
  "unit_price":100,
608
611
  "price": 100,
609
612
  "is_discounted": false,
613
+ "other":"{}"}, {"jan_code":"abc",
614
+ "name":"name1",
615
+ "unit_price":100,
616
+ "price": 100,
617
+ "is_discounted": false,
610
618
  "other":"{}"}], # 商品情報データ
611
619
  request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
612
620
  ))
@@ -725,9 +733,9 @@ CPMトークンに設定されたスコープの取引を作ることができ
725
733
 
726
734
  ```ruby
727
735
  response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
728
- "iwJJuJPCjlaztijN3vebjT", # cpm_token: CPMトークン
736
+ "tOQ2qp6BlopujNmJIuVKWv", # cpm_token: CPMトークン
729
737
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
730
- 9912, # amount: 取引金額
738
+ 1770, # amount: 取引金額
731
739
  description: "たい焼き(小倉)", # 取引説明文
732
740
  metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
733
741
  products: [{"jan_code":"abc",
@@ -735,16 +743,6 @@ response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
735
743
  "unit_price":100,
736
744
  "price": 100,
737
745
  "is_discounted": false,
738
- "other":"{}"}, {"jan_code":"abc",
739
- "name":"name1",
740
- "unit_price":100,
741
- "price": 100,
742
- "is_discounted": false,
743
- "other":"{}"}, {"jan_code":"abc",
744
- "name":"name1",
745
- "unit_price":100,
746
- "price": 100,
747
- "is_discounted": false,
748
746
  "other":"{}"}], # 商品情報データ
749
747
  request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
750
748
  ))
@@ -852,7 +850,7 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
852
850
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
853
851
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
854
852
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
855
- 1306, # amount: 送金額
853
+ 1693, # amount: 送金額
856
854
  metadata: "{\"key\":\"value\"}", # 取引メタデータ
857
855
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
858
856
  request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
@@ -954,8 +952,8 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
954
952
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
955
953
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
956
954
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
957
- 9015,
958
- description: "9RjYRPCqvnZ1YzdrhG",
955
+ 4287,
956
+ description: "jC0u3f2Lo9NqlV6uXM4yE9kd7lV6QKkz6REzoI7cZYW4c0GyNh6EpQVqX4KE4B5KRDxSSppVORQLy6PO73cHGKqjz0v27dHE8reh9b3v7zqeYS2n0EGsPPbvQvYkAPBJ7wmgCWNKDP",
959
957
  request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
960
958
  ))
961
959
  ```
@@ -1019,19 +1017,19 @@ response = $client.send(Pokepay::Request::RefundTransaction.new(
1019
1017
  ####
1020
1018
  ```ruby
1021
1019
  response = $client.send(Pokepay::Request::ListTransfers.new(
1022
- from: "2023-02-09T00:49:53.000000+09:00",
1023
- to: "2017-04-28T12:45:45.000000+09:00",
1024
- page: 6607,
1025
- per_page: 6000,
1020
+ from: "2020-08-10T17:58:57.000000+09:00",
1021
+ to: "2016-03-07T12:54:00.000000+09:00",
1022
+ page: 7808,
1023
+ per_page: 1254,
1026
1024
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
1027
- shop_name: "GDpqqjYUa42NN7jWbTA8sT9CjYdhYyR9ZtWhMAKSZHQ2Tja",
1025
+ shop_name: "xAKZBD2FhNoFZKIbAgSoRCKxxDEWQZO9yz4Mc4BWxPS7UaVHpVi4pZYZOGKLSewvJuaN97ObUNQZ0A0Rwk2Z2omGatDjCcJfOMaGd4kHySUJYrKI48UyLazcdaqg9M9b56VUQzIG7Yr7fsBnFuG56tOVY8vi9Z9lrbTGfh4QbdPS2DfLew9jsvLcXjFRqAsdyU0EjzFGdoCEVoN09yrlyTlHcxkp2hdiJWs83eoAqvgg01z",
1028
1026
  customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
1029
- customer_name: "hc0hASAcEibjku1fdQetgL0O7DlAFrkXVihIdQWu7J4NYirXryPP6taqbm6hsnA9hELkacVB4dzDqQ1LbTyVIgVP7fIz1xemnrDx9P7HPwLX5lwWZKuWWf4n5wNPq2rjN28QfQLnQ9Qr2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCp",
1027
+ customer_name: "W75gRDgWRTNwobRsB1baR1aePdc9fGHLcwyelAg5Jr7zEeO7nUDqxXj74j643AIOVakyq8QHWKNric3MBQYWsKtvnxo",
1030
1028
  transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
1031
1029
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
1032
1030
  is_modified: true,
1033
- transaction_types: ["transfer"],
1034
- transfer_types: ["coupon"], # 取引明細の種類でフィルターします。
1031
+ transaction_types: ["exchange", "transfer", "payment", "topup"],
1032
+ transfer_types: ["campaign"], # 取引明細の種類でフィルターします。
1035
1033
  description: "店頭QRコードによる支払い" # 取引詳細説明文
1036
1034
  ))
1037
1035
  ```
@@ -1139,19 +1137,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
1139
1137
  支払いQRコード一覧を表示します。
1140
1138
  ```ruby
1141
1139
  response = $client.send(Pokepay::Request::ListBills.new(
1142
- page: 2359, # ページ番号
1143
- per_page: 9119, # 1ページの表示数
1144
- bill_id: "WIbd8", # 支払いQRコードのID
1140
+ page: 2029, # ページ番号
1141
+ per_page: 644, # 1ページの表示数
1142
+ bill_id: "oM94TQVFch", # 支払いQRコードのID
1145
1143
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
1146
- organization_code: "U5j-HH14BbFT54v-4FDv-si", # 組織コード
1144
+ organization_code: "---3w2-T--oGA-xm9", # 組織コード
1147
1145
  description: "test bill", # 取引説明文
1148
- created_from: "2023-07-11T01:18:59.000000+09:00", # 作成日時(起点)
1149
- created_to: "2018-10-19T23:38:10.000000+09:00", # 作成日時(終点)
1146
+ created_from: "2022-10-27T03:00:12.000000+09:00", # 作成日時(起点)
1147
+ created_to: "2022-12-17T21:32:53.000000+09:00", # 作成日時(終点)
1150
1148
  shop_name: "bill test shop1", # 店舗名
1151
1149
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
1152
- lower_limit_amount: 5189, # 金額の範囲によるフィルタ(下限)
1153
- upper_limit_amount: 1460, # 金額の範囲によるフィルタ(上限)
1154
- is_disabled: true # 支払いQRコードが無効化されているかどうか
1150
+ lower_limit_amount: 6788, # 金額の範囲によるフィルタ(下限)
1151
+ upper_limit_amount: 722, # 金額の範囲によるフィルタ(上限)
1152
+ is_disabled: false # 支払いQRコードが無効化されているかどうか
1155
1153
  ))
1156
1154
  ```
1157
1155
 
@@ -1295,7 +1293,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
1295
1293
  response = $client.send(Pokepay::Request::CreateBill.new(
1296
1294
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
1297
1295
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
1298
- amount: 7969, # 支払い額
1296
+ amount: 6948, # 支払い額
1299
1297
  description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
1300
1298
  ))
1301
1299
  ```
@@ -1319,9 +1317,9 @@ response = $client.send(Pokepay::Request::CreateBill.new(
1319
1317
  ```ruby
1320
1318
  response = $client.send(Pokepay::Request::UpdateBill.new(
1321
1319
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
1322
- amount: 9387, # 支払い額
1320
+ amount: 4364, # 支払い額
1323
1321
  description: "test bill", # 説明文
1324
- is_disabled: true # 無効化されているかどうか
1322
+ is_disabled: false # 無効化されているかどうか
1325
1323
  ))
1326
1324
  ```
1327
1325
 
@@ -1384,9 +1382,9 @@ Cashtrayを作成します。
1384
1382
  response = $client.send(Pokepay::Request::CreateCashtray.new(
1385
1383
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1386
1384
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
1387
- 4206, # amount: 金額
1385
+ 6176, # amount: 金額
1388
1386
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
1389
- expires_in: 2971 # 失効時間(秒)
1387
+ expires_in: 2660 # 失効時間(秒)
1390
1388
  ))
1391
1389
  ```
1392
1390
 
@@ -1547,9 +1545,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
1547
1545
  ```ruby
1548
1546
  response = $client.send(Pokepay::Request::UpdateCashtray.new(
1549
1547
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
1550
- amount: 4180, # 金額
1548
+ amount: 366, # 金額
1551
1549
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
1552
- expires_in: 5017 # 失効時間(秒)
1550
+ expires_in: 1968 # 失効時間(秒)
1553
1551
  ))
1554
1552
  ```
1555
1553
 
@@ -1655,11 +1653,11 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
1655
1653
  ```ruby
1656
1654
  response = $client.send(Pokepay::Request::ListAccountBalances.new(
1657
1655
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
1658
- page: 1398, # ページ番号
1659
- per_page: 295, # 1ページ分の取引数
1660
- expires_at_from: "2018-11-24T12:24:46.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1661
- expires_at_to: "2021-02-20T21:10:32.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
1662
- direction: "asc" # 有効期限によるソート順序
1656
+ page: 6477, # ページ番号
1657
+ per_page: 9184, # 1ページ分の取引数
1658
+ expires_at_from: "2017-04-24T14:26:14.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1659
+ expires_at_to: "2024-04-06T21:34:06.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
1660
+ direction: "desc" # 有効期限によるソート順序
1663
1661
  ))
1664
1662
  ```
1665
1663
 
@@ -1733,10 +1731,10 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
1733
1731
  ```ruby
1734
1732
  response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
1735
1733
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
1736
- page: 3542, # ページ番号
1737
- per_page: 59, # 1ページ分の取引数
1738
- expires_at_from: "2025-03-03T19:58:32.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1739
- expires_at_to: "2022-07-08T21:11:40.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
1734
+ page: 6364, # ページ番号
1735
+ per_page: 3320, # 1ページ分の取引数
1736
+ expires_at_from: "2019-01-03T04:33:36.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1737
+ expires_at_to: "2025-03-06T14:10:05.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
1740
1738
  direction: "asc" # 有効期限によるソート順序
1741
1739
  ))
1742
1740
  ```
@@ -1811,14 +1809,14 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
1811
1809
  ```ruby
1812
1810
  response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
1813
1811
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1814
- page: 1636, # ページ番号
1815
- per_page: 2198, # 1ページ分のウォレット数
1816
- created_at_from: "2020-07-10T06:47:52.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1817
- created_at_to: "2023-01-18T13:26:30.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1812
+ page: 6663, # ページ番号
1813
+ per_page: 6699, # 1ページ分のウォレット数
1814
+ created_at_from: "2023-01-21T06:56:24.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1815
+ created_at_to: "2018-04-22T09:42:28.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1818
1816
  is_suspended: false, # ウォレットが凍結状態かどうかでフィルターする
1819
- external_id: "Izv8TjKb1dIcQKtgPEpt9Ynsu0LI4", # 外部ID
1820
- tel: "01172-559", # エンドユーザーの電話番号
1821
- email: "3YpOK96EoF@GxVJ.com" # エンドユーザーのメールアドレス
1817
+ external_id: "wbFSZ2qU3L9frpqlrETgz3O9wlyQ0TWfR4Gx21zM7WIQGDsP", # 外部ID
1818
+ tel: "0463-532236", # エンドユーザーの電話番号
1819
+ email: "JPjtVj6RA5@8jW2.com" # エンドユーザーのメールアドレス
1822
1820
  ))
1823
1821
  ```
1824
1822
 
@@ -1921,7 +1919,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
1921
1919
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1922
1920
  user_name: "ポケペイ太郎", # ユーザー名
1923
1921
  account_name: "ポケペイ太郎のアカウント", # アカウント名
1924
- external_id: "NTeRlFM4Xw2YneFRtau24yc1kusN7qW2yhhPFbHNPhRgn" # 外部ID
1922
+ external_id: "8noWbhryHKQAP2bBeZkmIh2UeN7Z047tEp9MnaMKkPT" # 外部ID
1925
1923
  ))
1926
1924
  ```
1927
1925
 
@@ -1975,11 +1973,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
1975
1973
  ```ruby
1976
1974
  response = $client.send(Pokepay::Request::GetShopAccounts.new(
1977
1975
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1978
- page: 8690, # ページ番号
1979
- per_page: 3606, # 1ページ分のウォレット数
1980
- created_at_from: "2018-01-27T06:32:33.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1981
- created_at_to: "2023-06-23T05:06:56.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1982
- is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
1976
+ page: 1954, # ページ番号
1977
+ per_page: 1616, # 1ページ分のウォレット数
1978
+ created_at_from: "2023-12-27T10:50:24.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1979
+ created_at_to: "2015-10-22T21:26:52.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1980
+ is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
1983
1981
  ))
1984
1982
  ```
1985
1983
 
@@ -2052,10 +2050,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
2052
2050
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
2053
2051
  sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
2054
2052
  receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
2055
- type: "JbOrM", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
2056
- is_modified: true, # キャンセル済みかどうか
2057
- from: "2017-01-07T03:09:17.000000+09:00", # 開始日時
2058
- to: "2021-09-27T18:17:33.000000+09:00", # 終了日時
2053
+ type: "XKgtixs", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
2054
+ is_modified: false, # キャンセル済みかどうか
2055
+ from: "2025-03-12T21:36:40.000000+09:00", # 開始日時
2056
+ to: "2021-03-13T21:54:48.000000+09:00", # 終了日時
2059
2057
  page: 1, # ページ番号
2060
2058
  per_page: 50 # 1ページ分の取引数
2061
2059
  ))
@@ -2180,11 +2178,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
2180
2178
  organization_code: "pocketchange", # 組織コード
2181
2179
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
2182
2180
  name: "oxスーパー三田店", # 店舗名
2183
- postal_code: "6729142", # 店舗の郵便番号
2181
+ postal_code: "4920338", # 店舗の郵便番号
2184
2182
  address: "東京都港区芝...", # 店舗の住所
2185
- tel: "05-7934492", # 店舗の電話番号
2186
- email: "jt9M12BOno@1Acj.com", # 店舗のメールアドレス
2187
- external_id: "M96oftC7mHhiSDgXKvVy5paxKD2XcOfyMo2", # 店舗の外部ID
2183
+ tel: "01106454-536", # 店舗の電話番号
2184
+ email: "uhUCHWp85q@yAYW.com", # 店舗のメールアドレス
2185
+ external_id: "UJWst1yIlHOt0XiM6Qkur8SbZd3wcu", # 店舗の外部ID
2188
2186
  page: 1, # ページ番号
2189
2187
  per_page: 50 # 1ページ分の取引数
2190
2188
  ))
@@ -2309,11 +2307,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
2309
2307
  ```ruby
2310
2308
  response = $client.send(Pokepay::Request::CreateShop.new(
2311
2309
  "oxスーパー三田店", # shop_name: 店舗名
2312
- shop_postal_code: "2691189", # 店舗の郵便番号
2310
+ shop_postal_code: "375-3088", # 店舗の郵便番号
2313
2311
  shop_address: "東京都港区芝...", # 店舗の住所
2314
- shop_tel: "0643430858", # 店舗の電話番号
2315
- shop_email: "x6Ov6eGwjQ@Cqxd.com", # 店舗のメールアドレス
2316
- shop_external_id: "tQnDY", # 店舗の外部ID
2312
+ shop_tel: "0247-609-190", # 店舗の電話番号
2313
+ shop_email: "lQvL5t780R@8L5V.com", # 店舗のメールアドレス
2314
+ shop_external_id: "xzRQlVu0ZdkmH", # 店舗の外部ID
2317
2315
  organization_code: "ox-supermarket" # 組織コード
2318
2316
  ))
2319
2317
  ```
@@ -2323,14 +2321,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
2323
2321
  ```ruby
2324
2322
  response = $client.send(Pokepay::Request::CreateShopV2.new(
2325
2323
  "oxスーパー三田店", # name: 店舗名
2326
- postal_code: "4391483", # 店舗の郵便番号
2324
+ postal_code: "1770589", # 店舗の郵便番号
2327
2325
  address: "東京都港区芝...", # 店舗の住所
2328
- tel: "088152-979", # 店舗の電話番号
2329
- email: "CsXRcUZY47@cpIh.com", # 店舗のメールアドレス
2330
- external_id: "03BvqB7CzLjYHoO28zEE65UlKtMCe12", # 店舗の外部ID
2326
+ tel: "06415506", # 店舗の電話番号
2327
+ email: "cQVtlOjSB3@1Mxq.com", # 店舗のメールアドレス
2328
+ external_id: "8SXpxSHJRZi52y7KvoeklIR5ig74", # 店舗の外部ID
2331
2329
  organization_code: "ox-supermarket", # 組織コード
2332
- private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2333
- can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
2330
+ private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2331
+ can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
2334
2332
  ))
2335
2333
  ```
2336
2334
 
@@ -2401,11 +2399,11 @@ response = $client.send(Pokepay::Request::GetShop.new(
2401
2399
  response = $client.send(Pokepay::Request::UpdateShop.new(
2402
2400
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
2403
2401
  name: "oxスーパー三田店", # 店舗名
2404
- postal_code: "891-6024", # 店舗の郵便番号
2402
+ postal_code: "662-5422", # 店舗の郵便番号
2405
2403
  address: "東京都港区芝...", # 店舗の住所
2406
- tel: "0224-585", # 店舗の電話番号
2407
- email: "WnFZLX87qt@edPz.com", # 店舗のメールアドレス
2408
- external_id: "8NdiYCurcmVOPZzwMWHgQ0V", # 店舗の外部ID
2404
+ tel: "020-21-2482", # 店舗の電話番号
2405
+ email: "Q8WxGHxi6f@0cuW.com", # 店舗のメールアドレス
2406
+ external_id: "hxLtCHCm7yUfJm7Fg98YgjSKRGL", # 店舗の外部ID
2409
2407
  private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2410
2408
  can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
2411
2409
  ))
@@ -2507,7 +2505,9 @@ response = $client.send(Pokepay::Request::UpdateShop.new(
2507
2505
  ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
2508
2506
  ```ruby
2509
2507
  response = $client.send(Pokepay::Request::ListUserAccounts.new(
2510
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # user_id: ユーザーID
2508
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
2509
+ page: 7281, # ページ番号
2510
+ per_page: 7375 # 1ページ分の取引数
2511
2511
  ))
2512
2512
  ```
2513
2513
 
@@ -2523,8 +2523,63 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
2523
2523
 
2524
2524
  指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
2525
2525
 
2526
+ ---
2527
+ `page`
2528
+ ```json
2529
+ {
2530
+ "type": "integer",
2531
+ "minimum": 1
2532
+ }
2533
+ ```
2534
+ 取得したいページ番号です。デフォルト値は1です。
2535
+
2536
+ ---
2537
+ `per_page`
2538
+ ```json
2539
+ {
2540
+ "type": "integer",
2541
+ "minimum": 1
2542
+ }
2543
+ ```
2544
+ 1ページ当たりのウォレット数です。デフォルト値は50です。
2545
+
2526
2546
  ---
2527
2547
  成功したときは[PaginatedAccountDetails](#paginated-account-details)オブジェクトを返します
2548
+ <a name="create-user-account"></a>
2549
+ #### エンドユーザーのウォレットを作成する
2550
+ ```ruby
2551
+ response = $client.send(Pokepay::Request::CreateUserAccount.new(
2552
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
2553
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
2554
+ name: "x8ciNrKweGJtnGqdSp90ci6D0iGddOVzLT6tirwJLurByrAGwszVwlQAuTXTWtKg2YB5YxVquVYsbDyysRisRQ9ectqoj4yKOsEPCrpQPvSjUDltH57ysDpO4lTbJ9dqwKn5NSHIJ7mbc5qbOnYC", # ウォレット名
2555
+ external_id: "xA4AjI47p6qtIsaCpt80GzH1FR" # 外部ID
2556
+ ))
2557
+ ```
2558
+
2559
+ ---
2560
+ `user_id`
2561
+ ```json
2562
+ {
2563
+ "type": "string",
2564
+ "format": "uuid"
2565
+ }
2566
+ ```
2567
+ ユーザーIDです。
2568
+
2569
+ ---
2570
+ `private_money_id`
2571
+ ```json
2572
+ {
2573
+ "type": "string",
2574
+ "format": "uuid"
2575
+ }
2576
+ ```
2577
+ マネーIDです。
2578
+
2579
+ 作成するウォレットのマネーを指定します。このパラメータは必須です。
2580
+
2581
+ ---
2582
+ 成功したときは[AccountDetail](#account-detail)オブジェクトを返します
2528
2583
  ### Private Money
2529
2584
  <a name="get-private-moneys"></a>
2530
2585
  #### マネー一覧を取得する
@@ -2557,8 +2612,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
2557
2612
  ```ruby
2558
2613
  response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
2559
2614
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
2560
- from: "2024-01-30T11:08:00.000000+09:00", # 開始日時(toと同時に指定する必要有)
2561
- to: "2023-12-25T17:27:23.000000+09:00", # 終了日時(fromと同時に指定する必要有)
2615
+ from: "2017-09-13T23:45:00.000000+09:00", # 開始日時(toと同時に指定する必要有)
2616
+ to: "2024-11-16T14:58:53.000000+09:00", # 終了日時(fromと同時に指定する必要有)
2562
2617
  page: 1, # ページ番号
2563
2618
  per_page: 50 # 1ページ分の取引数
2564
2619
  ))
@@ -2572,10 +2627,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
2572
2627
  CSVファイルから一括取引をします。
2573
2628
  ```ruby
2574
2629
  response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2575
- "pW9b9NBdcz", # name: 一括取引タスク名
2576
- "T", # content: 取引する情報のCSV
2577
- "SynCfTiWLEN2pEbq7ZeB8PVJkE9NzaeTptZ5", # request_id: リクエストID
2578
- description: "kX9rLpagdWQnEnTlLyubwibc5uG9Y4cn6ApRZ5NX6g" # 一括取引の説明
2630
+ "LcwMHaeJGFXqwAY75stQD6SAh41", # name: 一括取引タスク名
2631
+ "Zii84vy", # content: 取引する情報のCSV
2632
+ "bd1Jsf0jR3rzbwtxyn2FAh1zUedGEpNztrZH", # request_id: リクエストID
2633
+ description: "4AytTHxVvHVgjPvTnTRbAGxJFBzSBdN9rH7Ml90EeuZgaP20pyyEjfyZnRCBH" # 一括取引の説明
2579
2634
  ))
2580
2635
  ```
2581
2636
 
@@ -2640,6 +2695,155 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2640
2695
 
2641
2696
  ---
2642
2697
  成功したときは[BulkTransaction](#bulk-transaction)オブジェクトを返します
2698
+ ### Event
2699
+ <a name="create-external-transaction"></a>
2700
+ #### ポケペイ外部取引を作成する
2701
+ ポケペイ外部取引を作成します。
2702
+
2703
+ ポケペイ外の現金決済やクレジットカード決済に対してポケペイのポイントを付けたいというときに使用します。
2704
+
2705
+ ```ruby
2706
+ response = $client.send(Pokepay::Request::CreateExternalTransaction.new(
2707
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
2708
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
2709
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
2710
+ 1937, # amount: 取引額
2711
+ description: "たい焼き(小倉)", # 取引説明文
2712
+ metadata: "pzVqBZ", # ポケペイ外部取引メタデータ
2713
+ products: [{"jan_code":"abc",
2714
+ "name":"name1",
2715
+ "unit_price":100,
2716
+ "price": 100,
2717
+ "is_discounted": false,
2718
+ "other":"{}"}, {"jan_code":"abc",
2719
+ "name":"name1",
2720
+ "unit_price":100,
2721
+ "price": 100,
2722
+ "is_discounted": false,
2723
+ "other":"{}"}], # 商品情報データ
2724
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
2725
+ ))
2726
+ ```
2727
+
2728
+ ---
2729
+ `shop_id`
2730
+ ```json
2731
+ {
2732
+ "type": "string",
2733
+ "format": "uuid"
2734
+ }
2735
+ ```
2736
+ 店舗IDです。
2737
+
2738
+ ポケペイ外部取引が行なう店舗を指定します。
2739
+
2740
+ ---
2741
+ `customer_id`
2742
+ ```json
2743
+ {
2744
+ "type": "string",
2745
+ "format": "uuid"
2746
+ }
2747
+ ```
2748
+ エンドユーザーIDです。
2749
+
2750
+ エンドユーザーを指定します。
2751
+
2752
+ ---
2753
+ `private_money_id`
2754
+ ```json
2755
+ {
2756
+ "type": "string",
2757
+ "format": "uuid"
2758
+ }
2759
+ ```
2760
+ マネーIDです。
2761
+
2762
+ マネーを指定します。
2763
+
2764
+ ---
2765
+ `amount`
2766
+ ```json
2767
+ {
2768
+ "type": "number",
2769
+ "minimum": 0
2770
+ }
2771
+ ```
2772
+ 取引金額です。
2773
+
2774
+ ---
2775
+ `description`
2776
+ ```json
2777
+ {
2778
+ "type": "string",
2779
+ "maxLength": 200
2780
+ }
2781
+ ```
2782
+ 取引説明文です。
2783
+
2784
+ 任意入力で、取引履歴に表示される説明文です。
2785
+
2786
+ ---
2787
+ `metadata`
2788
+ ```json
2789
+ {
2790
+ "type": "string",
2791
+ "format": "json"
2792
+ }
2793
+ ```
2794
+ ポケペイ外部取引作成時に指定され、取引と紐付けられるメタデータです。
2795
+
2796
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSONで指定します。
2797
+
2798
+ ---
2799
+ `products`
2800
+ ```json
2801
+ {
2802
+ "type": "array",
2803
+ "items": { "type": "object" }
2804
+ }
2805
+ ```
2806
+ 一つの取引に含まれる商品情報データです。
2807
+ 以下の内容からなるJSONオブジェクトの配列で指定します。
2808
+
2809
+ - `jan_code`: JANコード。64字以下の文字列
2810
+ - `name`: 商品名。256字以下の文字列
2811
+ - `unit_price`: 商品単価。0以上の数値
2812
+ - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
2813
+ - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
2814
+ - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
2815
+
2816
+ ---
2817
+ `request_id`
2818
+ ```json
2819
+ {
2820
+ "type": "string",
2821
+ "format": "uuid"
2822
+ }
2823
+ ```
2824
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
2825
+
2826
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
2827
+
2828
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
2829
+
2830
+ ---
2831
+ 成功したときは[ExternalTransaction](#external-transaction)オブジェクトを返します
2832
+ <a name="refund-external-transaction"></a>
2833
+ #### ポケペイ外部取引をキャンセルする
2834
+ 取引IDを指定して取引をキャンセルします。
2835
+
2836
+ 発行体の管理者は自組織の直営店、または発行しているマネーの決済加盟店組織での取引をキャンセルできます。
2837
+ キャンセル対象のポケペイ外部取引に付随するポイント還元キャンペーンも取り消されます。
2838
+
2839
+ 取引をキャンセルできるのは1回きりです。既にキャンセルされた取引を重ねてキャンセルしようとすると `transaction_already_refunded (422)` エラーが返ります。
2840
+ ```ruby
2841
+ response = $client.send(Pokepay::Request::RefundExternalTransaction.new(
2842
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
2843
+ description: "返品対応のため" # 取引履歴に表示する返金事由
2844
+ ))
2845
+ ```
2846
+ 成功したときは[ExternalTransaction](#external-transaction)オブジェクトを返します
2643
2847
  ## Responses
2644
2848
 
2645
2849
 
@@ -2780,6 +2984,22 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2780
2984
  * `submitted_at (string)`: バルク取引が登録された日時
2781
2985
  * `updated_at (string)`: バルク取引が更新された日時
2782
2986
 
2987
+ <a name="external-transaction"></a>
2988
+ ## ExternalTransaction
2989
+ * `id (string)`: ポケペイ外部取引ID
2990
+ * `is_modified (boolean)`: 返金された取引かどうか
2991
+ * `sender (User)`: 送金者情報
2992
+ * `sender_account (Account)`: 送金ウォレット情報
2993
+ * `receiver (User)`: 受取者情報
2994
+ * `receiver_account (Account)`: 受取ウォレット情報
2995
+ * `amount (double)`: 決済額
2996
+ * `done_at (string)`: 取引日時
2997
+ * `description (string)`: 取引説明文
2998
+
2999
+ `receiver`と`sender`は [User](#user) オブジェクトを返します。
3000
+
3001
+ `receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
3002
+
2783
3003
  <a name="paginated-private-money-organization-summaries"></a>
2784
3004
  ## PaginatedPrivateMoneyOrganizationSummaries
2785
3005
  * `rows (array of PrivateMoneyOrganizationSummaries)`:
@@ -2887,22 +3107,6 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2887
3107
 
2888
3108
  `organization`は [Organization](#organization) オブジェクトを返します。
2889
3109
 
2890
- <a name="external-transaction"></a>
2891
- ## ExternalTransaction
2892
- * `id (string)`: ポケペイ外部取引ID
2893
- * `is_modified (boolean)`: 返金された取引かどうか
2894
- * `sender (User)`: 送金者情報
2895
- * `sender_account (Account)`: 送金ウォレット情報
2896
- * `receiver (User)`: 受取者情報
2897
- * `receiver_account (Account)`: 受取ウォレット情報
2898
- * `amount (double)`: 決済額
2899
- * `done_at (string)`: 取引日時
2900
- * `description (string)`: 取引説明文
2901
-
2902
- `receiver`と`sender`は [User](#user) オブジェクトを返します。
2903
-
2904
- `receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
2905
-
2906
3110
  <a name="cashtray-attempt"></a>
2907
3111
  ## CashtrayAttempt
2908
3112
  * `account (AccountWithUser)`: エンドユーザーのウォレット
data/lib/pokepay_partner_ruby_sdk/request/create_external_transaction.rb ADDED
@@ -0,0 +1,18 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/external_transaction"
4
+
5
+ module Pokepay::Request
6
+ class CreateExternalTransaction < Request
7
+ def initialize(shop_id, customer_id, private_money_id, amount, rest_args = {})
8
+ @path = "/external-transactions"
9
+ @method = "POST"
10
+ @body_params = { "shop_id" => shop_id,
11
+ "customer_id" => customer_id,
12
+ "private_money_id" => private_money_id,
13
+ "amount" => amount }.merge(rest_args)
14
+ @response_class = Pokepay::Response::ExternalTransaction
15
+ end
16
+ attr_reader :response_class
17
+ end
18
+ end
data/lib/pokepay_partner_ruby_sdk/request/create_user_account.rb ADDED
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/account_detail"
4
+
5
+ module Pokepay::Request
6
+ class CreateUserAccount < Request
7
+ def initialize(user_id, private_money_id, rest_args = {})
8
+ @path = "/users" + "/" + user_id + "/accounts"
9
+ @method = "POST"
10
+ @body_params = { "private_money_id" => private_money_id }.merge(rest_args)
11
+ @response_class = Pokepay::Response::AccountDetail
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb CHANGED
@@ -4,10 +4,10 @@ require "pokepay_partner_ruby_sdk/response/paginated_account_details"
4
4
 
5
5
  module Pokepay::Request
6
6
  class ListUserAccounts < Request
7
- def initialize(user_id)
7
+ def initialize(user_id, rest_args = {})
8
8
  @path = "/users" + "/" + user_id + "/accounts"
9
9
  @method = "GET"
10
- @body_params = { }
10
+ @body_params = { }.merge(rest_args)
11
11
  @response_class = Pokepay::Response::PaginatedAccountDetails
12
12
  end
13
13
  attr_reader :response_class
data/lib/pokepay_partner_ruby_sdk/request/refund_external_transaction.rb ADDED
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/external_transaction"
4
+
5
+ module Pokepay::Request
6
+ class RefundExternalTransaction < Request
7
+ def initialize(transaction_id, rest_args = {})
8
+ @path = "/external-transactions" + "/" + transaction_id + "/refund"
9
+ @method = "POST"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::ExternalTransaction
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
data/lib/pokepay_partner_ruby_sdk/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Pokepay
2
- VERSION = "0.1.15.1"
2
+ VERSION = "0.1.17"
3
3
  end
data/lib/pokepay_partner_ruby_sdk.rb CHANGED
@@ -9,6 +9,7 @@ require "pokepay_partner_ruby_sdk/request/get_ping"
9
9
  require "pokepay_partner_ruby_sdk/request/send_echo"
10
10
  require "pokepay_partner_ruby_sdk/request/get_user"
11
11
  require "pokepay_partner_ruby_sdk/request/list_user_accounts"
12
+ require "pokepay_partner_ruby_sdk/request/create_user_account"
12
13
  require "pokepay_partner_ruby_sdk/request/get_account"
13
14
  require "pokepay_partner_ruby_sdk/request/update_account"
14
15
  require "pokepay_partner_ruby_sdk/request/list_account_balances"
@@ -32,6 +33,8 @@ require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
32
33
  require "pokepay_partner_ruby_sdk/request/bulk_create_transaction"
33
34
  require "pokepay_partner_ruby_sdk/request/get_transaction"
34
35
  require "pokepay_partner_ruby_sdk/request/refund_transaction"
36
+ require "pokepay_partner_ruby_sdk/request/create_external_transaction"
37
+ require "pokepay_partner_ruby_sdk/request/refund_external_transaction"
35
38
  require "pokepay_partner_ruby_sdk/request/list_transfers"
36
39
  require "pokepay_partner_ruby_sdk/request/create_organization"
37
40
  require "pokepay_partner_ruby_sdk/request/list_shops"
data/partner.yaml CHANGED
@@ -36,6 +36,7 @@ tags:
36
36
  - name: Account
37
37
  - name: Private Money
38
38
  - name: Bulk
39
+ - name: Event
39
40
 
40
41
  components:
41
42
  schemas:
@@ -1128,6 +1129,22 @@ paths:
1128
1129
  ユーザーIDです。
1129
1130
 
1130
1131
  指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
1132
+ requestBody:
1133
+ required: true
1134
+ content:
1135
+ application/json:
1136
+ schema:
1137
+ properties:
1138
+ page:
1139
+ type: integer
1140
+ minimum: 1
1141
+ title: 'ページ番号'
1142
+ description: 取得したいページ番号です。デフォルト値は1です。
1143
+ per_page:
1144
+ type: integer
1145
+ minimum: 1
1146
+ title: '1ページ分の取引数'
1147
+ description: 1ページ当たりのウォレット数です。デフォルト値は50です。
1131
1148
  responses:
1132
1149
  '200':
1133
1150
  description: OK
@@ -1141,6 +1158,54 @@ paths:
1141
1158
  $ref: '#/components/responses/Forbidden'
1142
1159
  '404':
1143
1160
  $ref: '#/components/responses/NotFound'
1161
+ post:
1162
+ tags:
1163
+ - Account
1164
+ summary: 'エンドユーザーのウォレットを作成する'
1165
+ x-pokepay-operator-name: "CreateUserAccount"
1166
+ x-pokepay-allow-server-side: true
1167
+ parameters:
1168
+ - in: path
1169
+ name: user_id
1170
+ required: true
1171
+ schema:
1172
+ type: string
1173
+ format: uuid
1174
+ title: 'ユーザーID'
1175
+ description: |-
1176
+ ユーザーIDです。
1177
+ requestBody:
1178
+ required: true
1179
+ content:
1180
+ application/json:
1181
+ schema:
1182
+ required: ["private_money_id"]
1183
+ properties:
1184
+ private_money_id:
1185
+ title: 'マネーID'
1186
+ description: |-
1187
+ マネーIDです。
1188
+
1189
+ 作成するウォレットのマネーを指定します。このパラメータは必須です。
1190
+ type: string
1191
+ format: uuid
1192
+ name:
1193
+ title: 'ウォレット名'
1194
+ type: string
1195
+ maxLength: 256
1196
+ external_id:
1197
+ title: '外部ID'
1198
+ type: string
1199
+ maxLength: 50
1200
+ responses:
1201
+ '200':
1202
+ description: OK
1203
+ content:
1204
+ application/json:
1205
+ schema:
1206
+ $ref: '#/components/schemas/AccountDetail'
1207
+ '422':
1208
+ $ref: '#/components/responses/UnprocessableEntity'
1144
1209
  /accounts/{account_id}:
1145
1210
  get:
1146
1211
  tags:
@@ -2813,6 +2878,183 @@ paths:
2813
2878
  $ref: '#/components/responses/Forbidden'
2814
2879
  '422':
2815
2880
  $ref: '#/components/responses/UnprocessableEntity'
2881
+ /external-transactions:
2882
+ post:
2883
+ tags:
2884
+ - Event
2885
+ summary: 'ポケペイ外部取引を作成する'
2886
+ description: |
2887
+ ポケペイ外部取引を作成します。
2888
+
2889
+ ポケペイ外の現金決済やクレジットカード決済に対してポケペイのポイントを付けたいというときに使用します。
2890
+ x-pokepay-operator-name: "CreateExternalTransaction"
2891
+ x-pokepay-allow-server-side: true
2892
+ requestBody:
2893
+ required: true
2894
+ content:
2895
+ application/json:
2896
+ schema:
2897
+ required:
2898
+ - private_money_id
2899
+ - shop_id
2900
+ - customer_id
2901
+ - amount
2902
+ properties:
2903
+ shop_id:
2904
+ type: string
2905
+ format: uuid
2906
+ title: 店舗ID
2907
+ description: |-
2908
+ 店舗IDです。
2909
+
2910
+ ポケペイ外部取引が行なう店舗を指定します。
2911
+ customer_id:
2912
+ type: string
2913
+ format: uuid
2914
+ title: エンドユーザーID
2915
+ description: |-
2916
+ エンドユーザーIDです。
2917
+
2918
+ エンドユーザーを指定します。
2919
+ private_money_id:
2920
+ type: string
2921
+ format: uuid
2922
+ title: マネーID
2923
+ description: |-
2924
+ マネーIDです。
2925
+
2926
+ マネーを指定します。
2927
+ amount:
2928
+ type: number
2929
+ minimum: 0
2930
+ title: 取引額
2931
+ description: |-
2932
+ 取引金額です。
2933
+ description:
2934
+ type: string
2935
+ maxLength: 200
2936
+ title: 取引説明文
2937
+ description: |-
2938
+ 取引説明文です。
2939
+
2940
+ 任意入力で、取引履歴に表示される説明文です。
2941
+ example: たい焼き(小倉)
2942
+ metadata:
2943
+ type: string
2944
+ format: json
2945
+ title: ポケペイ外部取引メタデータ
2946
+ description: |-
2947
+ ポケペイ外部取引作成時に指定され、取引と紐付けられるメタデータです。
2948
+
2949
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSONで指定します。
2950
+ products:
2951
+ type: array
2952
+ items:
2953
+ type: object
2954
+ properties:
2955
+ jan_code:
2956
+ type: string
2957
+ maxLength: 64
2958
+ name:
2959
+ type: string
2960
+ maxLength: 256
2961
+ unit_price:
2962
+ type: number
2963
+ minimum: 0
2964
+ price:
2965
+ type: number
2966
+ minimum: 0
2967
+ is_discounted:
2968
+ type: boolean
2969
+ other:
2970
+ type: string
2971
+ format: json
2972
+ example: |-
2973
+ {"jan_code":"abc",
2974
+ "name":"name1",
2975
+ "unit_price":100,
2976
+ "price": 100,
2977
+ "is_discounted": false,
2978
+ "other":"{}"}
2979
+ title: '商品情報データ'
2980
+ description: |-
2981
+ 一つの取引に含まれる商品情報データです。
2982
+ 以下の内容からなるJSONオブジェクトの配列で指定します。
2983
+
2984
+ - `jan_code`: JANコード。64字以下の文字列
2985
+ - `name`: 商品名。256字以下の文字列
2986
+ - `unit_price`: 商品単価。0以上の数値
2987
+ - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
2988
+ - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
2989
+ - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
2990
+ request_id:
2991
+ type: string
2992
+ format: uuid
2993
+ title: リクエストID
2994
+ description: |-
2995
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
2996
+
2997
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
2998
+
2999
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
3000
+ example: 9dbfd997-b948-40d3-a3bf-6bc1a01368d2
3001
+ responses:
3002
+ '200':
3003
+ description: OK
3004
+ content:
3005
+ application/json:
3006
+ schema:
3007
+ $ref: '#/components/schemas/ExternalTransaction'
3008
+ '400':
3009
+ $ref: '#/components/responses/BadRequest'
3010
+ '403':
3011
+ $ref: '#/components/responses/Forbidden'
3012
+ '422':
3013
+ $ref: '#/components/responses/UnprocessableEntity'
3014
+ /external-transaction/{event_id}/refund:
3015
+ post:
3016
+ tags:
3017
+ - Event
3018
+ summary: 'ポケペイ外部取引をキャンセルする'
3019
+ description: |-
3020
+ 取引IDを指定して取引をキャンセルします。
3021
+
3022
+ 発行体の管理者は自組織の直営店、または発行しているマネーの決済加盟店組織での取引をキャンセルできます。
3023
+ キャンセル対象のポケペイ外部取引に付随するポイント還元キャンペーンも取り消されます。
3024
+
3025
+ 取引をキャンセルできるのは1回きりです。既にキャンセルされた取引を重ねてキャンセルしようとすると `transaction_already_refunded (422)` エラーが返ります。
3026
+ x-pokepay-operator-name: RefundExternalTransaction
3027
+ x-pokepay-allow-server-side: true
3028
+ parameters:
3029
+ - in: path
3030
+ name: transaction_id
3031
+ required: true
3032
+ schema:
3033
+ type: string
3034
+ format: uuid
3035
+ title: '取引ID'
3036
+ requestBody:
3037
+ required: true
3038
+ content:
3039
+ application/json:
3040
+ schema:
3041
+ properties:
3042
+ description:
3043
+ type: string
3044
+ maxLength: 200
3045
+ title: '取引履歴に表示する返金事由'
3046
+ example: '返品対応のため'
3047
+ responses:
3048
+ '200':
3049
+ description: OK
3050
+ content:
3051
+ application/json:
3052
+ schema:
3053
+ $ref: '#/components/schemas/ExternalTransaction'
3054
+ '403':
3055
+ $ref: '#/components/responses/Forbidden'
3056
+ '422':
3057
+ $ref: '#/components/responses/UnprocessableEntity'
2816
3058
  /transfers:
2817
3059
  get:
2818
3060
  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.15.1
4
+ version: 0.1.17
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-10-20 00:00:00.000000000 Z
11
+ date: 2021-11-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -124,6 +124,7 @@ files:
124
124
  - lib/pokepay_partner_ruby_sdk/request/create_cpm_transaction.rb
125
125
  - lib/pokepay_partner_ruby_sdk/request/create_customer_account.rb
126
126
  - lib/pokepay_partner_ruby_sdk/request/create_exchange_transaction.rb
127
+ - lib/pokepay_partner_ruby_sdk/request/create_external_transaction.rb
127
128
  - lib/pokepay_partner_ruby_sdk/request/create_organization.rb
128
129
  - lib/pokepay_partner_ruby_sdk/request/create_payment_transaction.rb
129
130
  - lib/pokepay_partner_ruby_sdk/request/create_shop.rb
@@ -132,6 +133,7 @@ files:
132
133
  - lib/pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check.rb
133
134
  - lib/pokepay_partner_ruby_sdk/request/create_transaction.rb
134
135
  - lib/pokepay_partner_ruby_sdk/request/create_transfer_transaction.rb
136
+ - lib/pokepay_partner_ruby_sdk/request/create_user_account.rb
135
137
  - lib/pokepay_partner_ruby_sdk/request/get_account.rb
136
138
  - lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb
137
139
  - lib/pokepay_partner_ruby_sdk/request/get_cashtray.rb
@@ -152,6 +154,7 @@ files:
152
154
  - lib/pokepay_partner_ruby_sdk/request/list_transactions.rb
153
155
  - lib/pokepay_partner_ruby_sdk/request/list_transfers.rb
154
156
  - lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb
157
+ - lib/pokepay_partner_ruby_sdk/request/refund_external_transaction.rb
155
158
  - lib/pokepay_partner_ruby_sdk/request/refund_transaction.rb
156
159
  - lib/pokepay_partner_ruby_sdk/request/request.rb
157
160
  - lib/pokepay_partner_ruby_sdk/request/send_echo.rb