pokepay_partner_ruby_sdk 0.1.7 → 0.1.8

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9db39bf7da512ddaf415d0312da429572674806d75d1a5beca492a8e10860f4b
4
- data.tar.gz: 843b0548ce65832615325185665fd702b52dadcc13deadb0f0a3edbd7123d6a5
3
+ metadata.gz: 4820f2638f0bc46dd7d401e8d0d488ee8ebe763f0e1664cc872113ff1a9e45a8
4
+ data.tar.gz: 7fe61418ef2c499d79a261b02209924579d1f16bbf224a2cfd7775d6291ed465
5
5
  SHA512:
6
- metadata.gz: 174b9e30acfcd57947de69f0860fb0def5703b4a35b6d90931760bcf604799bb6c5bd2e6d43428929a53452b88eb2736ed013d0e32646254ca7547f03906ce2e
7
- data.tar.gz: ab2167de48835f66b92a3db675e768288736ad04376a76d2415b291d2146888ad6c24296ce345436a2bfa23f24da15169b7ec94bea7513452302d96122c1d07d
6
+ metadata.gz: b2e5b0bd0c12fd7ab88b51e328cb39a3eff5d3c35c443f336affae2e9591567dc261335f5683f467b8b550b049662d9aa0b8aa7e45185561d138f71258cb8d0b
7
+ data.tar.gz: a66eb0bfe7ffbc70b581d3f10cce063dc67ce594846d4a1ce541e2c367a2f0643fef79cc769831e8a7afe2b69f6645a068a0d2d55c5cfd6331fbf9939034b445
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- pokepay_partner_ruby_sdk (0.1.7)
4
+ pokepay_partner_ruby_sdk (0.1.8)
5
5
  inifile (~> 3.0.0)
6
6
  json (~> 2.3.0)
7
7
  openssl (~> 2.1.2)
@@ -148,7 +148,7 @@ response.body
148
148
  取引を取得します。
149
149
  ```ruby
150
150
  response = $client.send(Pokepay::Request::GetTransaction.new(
151
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // transaction_id: 取引ID
151
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # transaction_id: 取引ID
152
152
  ))
153
153
  ```
154
154
 
@@ -165,13 +165,13 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
165
165
  チャージ取引を作成します。
166
166
  ```ruby
167
167
  response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
168
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // shop_id: 店舗ID
169
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // customer_id: エンドユーザーのID
170
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
171
- bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント支払時の負担店舗ID
172
- money_amount: 8987, // マネー額
173
- point_amount: 750, // ポイント額
174
- description: "初夏のチャージキャンペーン" // 取引履歴に表示する説明文
168
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
169
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
170
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
171
+ bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
172
+ money_amount: 9829, # マネー額
173
+ point_amount: 3839, # ポイント額
174
+ description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
175
175
  ))
176
176
  ```
177
177
 
@@ -226,11 +226,11 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
226
226
 
227
227
  ```ruby
228
228
  response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
229
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // shop_id: 店舗ID
230
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // customer_id: エンドユーザーID
231
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
232
- 8123, // amount: 支払い額
233
- description: "たい焼き(小倉)" // 取引履歴に表示する説明文
229
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
230
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
231
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
232
+ 9578, # amount: 支払い額
233
+ description: "たい焼き(小倉)" # 取引履歴に表示する説明文
234
234
  ))
235
235
  ```
236
236
 
@@ -273,11 +273,11 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
273
273
 
274
274
  ```ruby
275
275
  response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
276
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // sender_id: 送金元ユーザーID
277
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // receiver_id: 受取ユーザーID
278
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
279
- 7070, // amount: 送金額
280
- description: "たい焼き(小倉)" // 取引履歴に表示する説明文
276
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
277
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
278
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
279
+ 2298, # amount: 送金額
280
+ description: "たい焼き(小倉)" # 取引履歴に表示する説明文
281
281
  ))
282
282
  ```
283
283
 
@@ -318,19 +318,19 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
318
318
  取引一覧を返します。
319
319
  ```ruby
320
320
  response = $client.send(Pokepay::Request::ListTransactions.new(
321
- from: "2016-11-19T02:36:58.000000+09:00", // 開始日時
322
- to: "2021-03-05T00:00:07.000000+09:00", // 終了日時
323
- page: 1, // ページ番号
324
- per_page: 50, // 1ページ分の取引数
325
- shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
326
- customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
327
- customer_name: "太郎", // エンドユーザー名
328
- terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 端末ID
329
- transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 取引ID
330
- organization_code: "pocketchange", // 組織コード
331
- private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
332
- is_modified: true, // キャンセルフラグ
333
- types: ["topup", "payment"] // 取引種別 (複数指定可)、チャージ=topup、支払い=payment
321
+ from: "2022-12-14T10:46:43.000000+09:00", # 開始日時
322
+ to: "2024-01-27T16:51:48.000000+09:00", # 終了日時
323
+ page: 1, # ページ番号
324
+ per_page: 50, # 1ページ分の取引数
325
+ shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
326
+ customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
327
+ customer_name: "太郎", # エンドユーザー名
328
+ terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
329
+ transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
330
+ organization_code: "pocketchange", # 組織コード
331
+ private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
332
+ is_modified: true, # キャンセルフラグ
333
+ types: ["topup", "payment"] # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
334
334
  ))
335
335
  ```
336
336
 
@@ -427,8 +427,8 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
427
427
  #### 返金する
428
428
  ```ruby
429
429
  response = $client.send(Pokepay::Request::RefundTransaction.new(
430
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // transaction_id: 取引ID
431
- description: "返品対応のため" // 取引履歴に表示する返金事由
430
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
431
+ description: "返品対応のため" # 取引履歴に表示する返金事由
432
432
  ))
433
433
  ```
434
434
  成功したときは[Transfer](#transfer)オブジェクトを返します
@@ -446,16 +446,16 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
446
446
  #### チャージQRコードの発行
447
447
  ```ruby
448
448
  response = $client.send(Pokepay::Request::CreateCheck.new(
449
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // account_id: 送金元の店舗アカウントID
450
- money_amount: 8455, // 付与マネー額
451
- point_amount: 6119, // 付与ポイント額
452
- description: "test check", // 説明文(アプリ上で取引の説明文として表示される)
453
- is_onetime: true, // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
454
- usage_limit: 4746, // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
455
- expires_at: "2018-04-09T08:22:29.000000+09:00", // チャージQR自体の失効日時
456
- point_expires_at: "2016-10-24T09:19:20.000000+09:00", // チャージQRによって付与されるポイントの失効日時
457
- point_expires_in_days: 60, // チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
458
- bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ポイント額を負担する店舗アカウントのID
449
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: 送金元の店舗アカウントID
450
+ money_amount: 4826, # 付与マネー額
451
+ point_amount: 2394, # 付与ポイント額
452
+ description: "test check", # 説明文(アプリ上で取引の説明文として表示される)
453
+ is_onetime: true, # ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
454
+ usage_limit: 3826, # ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
455
+ expires_at: "2019-02-22T16:57:44.000000+09:00", # チャージQR自体の失効日時
456
+ point_expires_at: "2024-02-13T17:41:07.000000+09:00", # チャージQRによって付与されるポイントの失効日時
457
+ point_expires_in_days: 60, # チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
458
+ bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ポイント額を負担する店舗アカウントのID
459
459
  ))
460
460
  ```
461
461
  `money_amount`と`point_amount`の少なくとも一方は指定する必要があります。
@@ -484,8 +484,8 @@ response = $client.send(Pokepay::Request::CreateCheck.new(
484
484
 
485
485
  ```ruby
486
486
  response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
487
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // check_id: チャージ用QRコードのID
488
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // customer_id: エンドユーザーのID
487
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # check_id: チャージ用QRコードのID
488
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # customer_id: エンドユーザーのID
489
489
  ))
490
490
  ```
491
491
 
@@ -510,19 +510,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
510
510
  支払いQRコード一覧を表示します。
511
511
  ```ruby
512
512
  response = $client.send(Pokepay::Request::ListBills.new(
513
- page: 9486, // ページ番号
514
- per_page: 5839, // 1ページの表示数
515
- bill_id: "1Ez", // 支払いQRコードのID
516
- private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
517
- organization_code: "1rDRdnXy6PY122A---0nzUq-g", // 組織コード
518
- description: "test bill", // 取引説明文
519
- created_from: "2017-11-03T07:17:36.000000+09:00", // 作成日時(起点)
520
- created_to: "2016-02-19T04:37:01.000000+09:00", // 作成日時(終点)
521
- shop_name: "bill test shop1", // 店舗名
522
- shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
523
- lower_limit_amount: 8463, // 金額の範囲によるフィルタ(下限)
524
- upper_limit_amount: 3110, // 金額の範囲によるフィルタ(上限)
525
- is_disabled: true // 支払いQRコードが無効化されているかどうか
513
+ page: 6649, # ページ番号
514
+ per_page: 2896, # 1ページの表示数
515
+ bill_id: "3x6r1", # 支払いQRコードのID
516
+ private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
517
+ organization_code: "70s2krAk--iSH3DW--7--d----N", # 組織コード
518
+ description: "test bill", # 取引説明文
519
+ created_from: "2022-07-07T06:17:16.000000+09:00", # 作成日時(起点)
520
+ created_to: "2024-09-06T18:44:09.000000+09:00", # 作成日時(終点)
521
+ shop_name: "bill test shop1", # 店舗名
522
+ shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
523
+ lower_limit_amount: 8780, # 金額の範囲によるフィルタ(下限)
524
+ upper_limit_amount: 8338, # 金額の範囲によるフィルタ(上限)
525
+ is_disabled: true # 支払いQRコードが無効化されているかどうか
526
526
  ))
527
527
  ```
528
528
 
@@ -589,10 +589,10 @@ response = $client.send(Pokepay::Request::ListBills.new(
589
589
  支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
590
590
  ```ruby
591
591
  response = $client.send(Pokepay::Request::CreateBill.new(
592
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: 支払いマネーのマネーID
593
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // shop_id: 支払い先(受け取り人)の店舗ID
594
- amount: 9236, // 支払い額
595
- description: "test bill" // 説明文(アプリ上で取引の説明文として表示される)
592
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
593
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
594
+ amount: 9137, # 支払い額
595
+ description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
596
596
  ))
597
597
  ```
598
598
 
@@ -607,10 +607,10 @@ response = $client.send(Pokepay::Request::CreateBill.new(
607
607
  支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
608
608
  ```ruby
609
609
  response = $client.send(Pokepay::Request::UpdateBill.new(
610
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // bill_id: 支払いQRコードのID
611
- amount: 1515, // 支払い額
612
- description: "test bill", // 説明文
613
- is_disabled: true // 無効化されているかどうか
610
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
611
+ amount: 8582, # 支払い額
612
+ description: "test bill", # 説明文
613
+ is_disabled: false # 無効化されているかどうか
614
614
  ))
615
615
  ```
616
616
 
@@ -639,9 +639,9 @@ response = $client.send(Pokepay::Request::UpdateBill.new(
639
639
  指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
640
640
  ```ruby
641
641
  response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
642
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
643
- user_name: "ポケペイ太郎", // ユーザー名
644
- account_name: "ポケペイ太郎のアカウント" // アカウント名
642
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
643
+ user_name: "ポケペイ太郎", # ユーザー名
644
+ account_name: "ポケペイ太郎のアカウント" # アカウント名
645
645
  ))
646
646
  ```
647
647
 
@@ -666,7 +666,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
666
666
  ウォレットを取得します。
667
667
  ```ruby
668
668
  response = $client.send(Pokepay::Request::GetAccount.new(
669
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // account_id: ウォレットID
669
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # account_id: ウォレットID
670
670
  ))
671
671
  ```
672
672
 
@@ -683,12 +683,12 @@ response = $client.send(Pokepay::Request::GetAccount.new(
683
683
  エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
684
684
  ```ruby
685
685
  response = $client.send(Pokepay::Request::ListAccountBalances.new(
686
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // account_id: ウォレットID
687
- page: 2589, // ページ番号
688
- per_page: 6451, // 1ページ分の取引数
689
- expires_at_from: "2024-03-14T23:56:23.000000+09:00", // 有効期限の期間によるフィルター(開始時点)
690
- expires_at_to: "2019-10-04T17:19:48.000000+09:00", // 有効期限の期間によるフィルター(終了時点)
691
- direction: "asc" // 有効期限によるソート順序
686
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
687
+ page: 1912, # ページ番号
688
+ per_page: 4503, # 1ページ分の取引数
689
+ expires_at_from: "2021-11-26T22:06:49.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
690
+ expires_at_to: "2019-12-08T14:37:45.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
691
+ direction: "asc" # 有効期限によるソート順序
692
692
  ))
693
693
  ```
694
694
 
@@ -725,12 +725,12 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
725
725
  エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
726
726
  ```ruby
727
727
  response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
728
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // account_id: ウォレットID
729
- page: 6958, // ページ番号
730
- per_page: 2994, // 1ページ分の取引数
731
- expires_at_from: "2016-02-15T00:43:30.000000+09:00", // 有効期限の期間によるフィルター(開始時点)
732
- expires_at_to: "2016-06-15T15:33:00.000000+09:00", // 有効期限の期間によるフィルター(終了時点)
733
- direction: "asc" // 有効期限によるソート順序
728
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
729
+ page: 7446, # ページ番号
730
+ per_page: 9384, # 1ページ分の取引数
731
+ expires_at_from: "2020-08-10T16:38:08.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
732
+ expires_at_to: "2024-03-31T04:16:45.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
733
+ direction: "asc" # 有効期限によるソート順序
734
734
  ))
735
735
  ```
736
736
 
@@ -767,15 +767,15 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
767
767
  取引一覧を返します。
768
768
  ```ruby
769
769
  response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
770
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
771
- sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 送金エンドユーザーID
772
- receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 受取エンドユーザーID
773
- type: "FjJy7", // 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
774
- is_modified: true, // キャンセル済みかどうか
775
- from: "2019-01-09T15:47:03.000000+09:00", // 開始日時
776
- to: "2025-02-14T22:55:32.000000+09:00", // 終了日時
777
- page: 1, // ページ番号
778
- per_page: 50 // 1ページ分の取引数
770
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
771
+ sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
772
+ receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
773
+ type: "sFsWbo7bpQ", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
774
+ is_modified: true, # キャンセル済みかどうか
775
+ from: "2021-04-11T02:43:13.000000+09:00", # 開始日時
776
+ to: "2022-03-18T03:41:42.000000+09:00", # 終了日時
777
+ page: 1, # ページ番号
778
+ per_page: 50 # 1ページ分の取引数
779
779
  ))
780
780
  ```
781
781
 
@@ -847,19 +847,19 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
847
847
  #### 新規加盟店組織を追加する
848
848
  ```ruby
849
849
  response = $client.send(Pokepay::Request::CreateOrganization.new(
850
- "ox_supermarket", // code: 新規組織コード
851
- "oxスーパー", // name: 新規組織名
852
- ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], // private_money_ids: 加盟店組織で有効にするマネーIDの配列
853
- "Kkoz4u4vqN@tkYj.com", // issuer_admin_user_email: 発行体担当者メールアドレス
854
- "PXUyJ1V0r5@CHRN.com", // member_admin_user_email: 新規組織担当者メールアドレス
855
- bank_name: "XYZ銀行", // 銀行名
856
- bank_code: "99X", // 銀行金融機関コード
857
- bank_branch_name: "ABC支店", // 銀行支店名
858
- bank_branch_code: "99X", // 銀行支店コード
859
- bank_account_type: "saving", // 銀行口座種別 (普通=saving, 当座=current, その他=other)
860
- bank_account: 9999999, // 銀行口座番号
861
- bank_account_holder_name: "フクザワユキチ", // 口座名義人名
862
- contact_name: "佐藤清" // 担当者名
850
+ "ox_supermarket", # code: 新規組織コード
851
+ "oxスーパー", # name: 新規組織名
852
+ ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # private_money_ids: 加盟店組織で有効にするマネーIDの配列
853
+ "PszkN335U1@t4DY.com", # issuer_admin_user_email: 発行体担当者メールアドレス
854
+ "suiE88p3Ho@g0k8.com", # member_admin_user_email: 新規組織担当者メールアドレス
855
+ bank_name: "XYZ銀行", # 銀行名
856
+ bank_code: "99X", # 銀行金融機関コード
857
+ bank_branch_name: "ABC支店", # 銀行支店名
858
+ bank_branch_code: "99X", # 銀行支店コード
859
+ bank_account_type: "saving", # 銀行口座種別 (普通=saving, 当座=current, その他=other)
860
+ bank_account: 9999999, # 銀行口座番号
861
+ bank_account_holder_name: "フクザワユキチ", # 口座名義人名
862
+ contact_name: "佐藤清" # 担当者名
863
863
  ))
864
864
  ```
865
865
  成功したときは[Organization](#organization)オブジェクトを返します
@@ -869,13 +869,13 @@ response = $client.send(Pokepay::Request::CreateOrganization.new(
869
869
  #### 新規店舗を追加する
870
870
  ```ruby
871
871
  response = $client.send(Pokepay::Request::CreateShop.new(
872
- "oxスーパー三田店", // shop_name: 店舗名
873
- shop_postal_code: "422-5364", // 店舗の郵便番号
874
- shop_address: "東京都港区芝...", // 店舗の住所
875
- shop_tel: "083-33-947", // 店舗の電話番号
876
- shop_email: "pSCBGnb27K@I1Ko.com", // 店舗のメールアドレス
877
- shop_external_id: "9Ro9P2UOPHKc", // 店舗の外部ID
878
- organization_code: "ox-supermarket" // 組織コード
872
+ "oxスーパー三田店", # shop_name: 店舗名
873
+ shop_postal_code: "805-5907", # 店舗の郵便番号
874
+ shop_address: "東京都港区芝...", # 店舗の住所
875
+ shop_tel: "06-01122", # 店舗の電話番号
876
+ shop_email: "n8ATMTNMME@yVAp.com", # 店舗のメールアドレス
877
+ shop_external_id: "kaDeYuOtBoCZgc4gwc8RSE7", # 店舗の外部ID
878
+ organization_code: "ox-supermarket" # 組織コード
879
879
  ))
880
880
  ```
881
881
  成功したときは[User](#user)オブジェクトを返します
@@ -883,10 +883,16 @@ response = $client.send(Pokepay::Request::CreateShop.new(
883
883
  #### 店舗一覧を取得する
884
884
  ```ruby
885
885
  response = $client.send(Pokepay::Request::ListShops.new(
886
- organization_code: "pocketchange", // 組織コード
887
- private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
888
- page: 1, // ページ番号
889
- per_page: 50 // 1ページ分の取引数
886
+ organization_code: "pocketchange", # 組織コード
887
+ private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
888
+ name: "oxスーパー三田店", # 店舗名
889
+ postal_code: "257-1310", # 店舗の郵便番号
890
+ address: "東京都港区芝...", # 店舗の住所
891
+ tel: "0689-859-5517", # 店舗の電話番号
892
+ email: "pb9AHk6UF1@UjWU.com", # 店舗のメールアドレス
893
+ external_id: "yw97H5Wi0UlM5hWRopq8fm3QjwrUJD", # 店舗の外部ID
894
+ page: 1, # ページ番号
895
+ per_page: 50 # 1ページ分の取引数
890
896
  ))
891
897
  ```
892
898
 
@@ -900,6 +906,36 @@ response = $client.send(Pokepay::Request::ListShops.new(
900
906
  このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
901
907
 
902
908
 
909
+ ---
910
+ `name`
911
+ このパラメータを渡すとその名前の店舗のみが返されます。
912
+
913
+
914
+ ---
915
+ `postal_code`
916
+ このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
917
+
918
+
919
+ ---
920
+ `address`
921
+ このパラメータを渡すとその住所が登録された店舗のみが返されます。
922
+
923
+
924
+ ---
925
+ `tel`
926
+ このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
927
+
928
+
929
+ ---
930
+ `email`
931
+ このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
932
+
933
+
934
+ ---
935
+ `external_id`
936
+ このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
937
+
938
+
903
939
  ---
904
940
  `page`
905
941
  取得したいページ番号です。
@@ -917,7 +953,7 @@ response = $client.send(Pokepay::Request::ListShops.new(
917
953
  ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
918
954
  ```ruby
919
955
  response = $client.send(Pokepay::Request::ListUserAccounts.new(
920
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // user_id: ユーザーID
956
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # user_id: ユーザーID
921
957
  ))
922
958
  ```
923
959
 
@@ -935,17 +971,66 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
935
971
  #### 決済加盟店の取引サマリを取得する
936
972
  ```ruby
937
973
  response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
938
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
939
- from: "2020-03-02T19:54:29.000000+09:00", // 開始日時(toと同時に指定する必要有)
940
- to: "2024-10-09T07:46:14.000000+09:00", // 終了日時(fromと同時に指定する必要有)
941
- page: 1, // ページ番号
942
- per_page: 50 // 1ページ分の取引数
974
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
975
+ from: "2021-01-27T10:09:02.000000+09:00", # 開始日時(toと同時に指定する必要有)
976
+ to: "2016-02-05T23:42:53.000000+09:00", # 終了日時(fromと同時に指定する必要有)
977
+ page: 1, # ページ番号
978
+ per_page: 50 # 1ページ分の取引数
943
979
  ))
944
980
  ```
945
981
  `from`と`to`は同時に指定する必要があります。
946
982
 
947
983
  成功したときは[PaginatedPrivateMoneyOrganizationSummaries](#paginated-private-money-organization-summaries)オブジェクトを返します
948
984
 
985
+ ### バルクチャージ
986
+
987
+ #### CSVファイル一括取引
988
+ CSVファイルから一括取引をします。
989
+ ```ruby
990
+ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
991
+ "IEgbGEOQG1PZp7fjd9", # name: 一括取引タスク名
992
+ "1zgh1", # content: 取引する情報のCSV
993
+ "RHHtL55R7YEprCJ0U4QnLZWmGvTqLQwaZ9vO", # request_id: リクエストID
994
+ description: "v67spoRoPKUgWvYVa3Gv9xbfzvgScohGvfvszFZKZ0fsirdyb8N5N4uLXeppDXZ9aq2pYugtiiL7qWoYElTKmZkEzCv7OKUa8NeEnF41oUMWRj1" # 一括取引の説明
995
+ ))
996
+ ```
997
+
998
+ ---
999
+ `name`
1000
+ 一括取引タスクの管理用の名前です。
1001
+
1002
+ ---
1003
+ `description`
1004
+ 一括取引タスクの管理用の説明文です。
1005
+
1006
+ ---
1007
+ `content`
1008
+ 一括取引する情報を書いたCSVの文字列です。
1009
+ 1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
1010
+ カラムは以下の7つです。任意のカラムには空文字を指定します。
1011
+
1012
+ - `type`: 取引種別
1013
+ - 必須。'topup' または 'payment'
1014
+ - `sender_account_id`: 送金ウォレットID
1015
+ - 必須。UUID
1016
+ - `receiver_account_id`: 受取ウォレットID
1017
+ - 必須。UUID
1018
+ - `money_amount`: マネー額
1019
+ - 任意。ただし `point_amount` といずれかが必須。0以上の数字
1020
+ - `point_amount`: ポイント額
1021
+ - 任意。ただし `money_amount` といずれかが必須。0以上の数字
1022
+ - `bear_account_id`: ポイント負担ウォレットID
1023
+ - `point_amount` があるときは必須。UUID
1024
+ - `point_expires_at`: ポイントの有効期限
1025
+ - 任意。指定がないときはマネーに設定された有効期限を適用
1026
+
1027
+ ---
1028
+ `request_id`
1029
+ 重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
1030
+
1031
+ ---
1032
+ 成功したときは[BulkTransaction](#bulk-transaction)オブジェクトを返します
1033
+
949
1034
  ## Responses
950
1035
 
951
1036
 
@@ -1036,6 +1121,15 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
1036
1121
 
1037
1122
  `receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
1038
1123
 
1124
+ <a name="bulk-transaction"></a>
1125
+ ## BulkTransaction
1126
+ * `request_id (string)`: リクエストID
1127
+ * `name (string)`: バルクチャージ管理用の名前
1128
+ * `description (string)`: バルクチャージ管理用の説明文
1129
+ * `status (string)`: バルクチャージの状態
1130
+ * `submitted_at (string)`: バルクチャージが登録された日時
1131
+ * `updated_at (string)`: バルクチャージが更新された日時
1132
+
1039
1133
  <a name="transfer"></a>
1040
1134
  ## Transfer
1041
1135
  * `id (string)`:
@@ -25,6 +25,7 @@ require "pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check"
25
25
  require "pokepay_partner_ruby_sdk/request/create_payment_transaction"
26
26
  require "pokepay_partner_ruby_sdk/request/create_transfer_transaction"
27
27
  require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
28
+ require "pokepay_partner_ruby_sdk/request/bulk_create_transaction"
28
29
  require "pokepay_partner_ruby_sdk/request/get_transaction"
29
30
  require "pokepay_partner_ruby_sdk/request/refund_transaction"
30
31
  require "pokepay_partner_ruby_sdk/request/list_transfers"
@@ -49,6 +50,7 @@ require "pokepay_partner_ruby_sdk/response/organization"
49
50
  require "pokepay_partner_ruby_sdk/response/transaction"
50
51
  require "pokepay_partner_ruby_sdk/response/shop_with_metadata"
51
52
  require "pokepay_partner_ruby_sdk/response/user_transaction"
53
+ require "pokepay_partner_ruby_sdk/response/bulk_transaction"
52
54
  require "pokepay_partner_ruby_sdk/response/account_without_private_money_detail"
53
55
  require "pokepay_partner_ruby_sdk/response/transfer"
54
56
  require "pokepay_partner_ruby_sdk/response/organization_summary"
@@ -0,0 +1,17 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/bulk_transaction"
4
+
5
+ module Pokepay::Request
6
+ class BulkCreateTransaction < Request
7
+ def initialize(name, content, request_id, rest_args = {})
8
+ @path = "/transactions" + "/bulk"
9
+ @method = "POST"
10
+ @body_params = { "name" => name,
11
+ "content" => content,
12
+ "request_id" => request_id }.merge(rest_args)
13
+ @response_class = Pokepay::Response::BulkTransaction
14
+ end
15
+ attr_reader :response_class
16
+ end
17
+ end
@@ -0,0 +1,21 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+
4
+ module Pokepay::Response
5
+ class BulkTransaction
6
+ def initialize(row)
7
+ @request_id = row["request_id"]
8
+ @name = row["name"]
9
+ @description = row["description"]
10
+ @status = row["status"]
11
+ @submitted_at = row["submitted_at"]
12
+ @updated_at = row["updated_at"]
13
+ end
14
+ attr_reader :request_id
15
+ attr_reader :name
16
+ attr_reader :description
17
+ attr_reader :status
18
+ attr_reader :submitted_at
19
+ attr_reader :updated_at
20
+ end
21
+ end
@@ -1,3 +1,3 @@
1
1
  module Pokepay
2
- VERSION = "0.1.7"
2
+ VERSION = "0.1.8"
3
3
  end
@@ -403,6 +403,36 @@ components:
403
403
  enum: [topup, payment, transfer, exchange]
404
404
  is_modified:
405
405
  type: boolean
406
+ BulkTransaction:
407
+ x-pokepay-schema-type: "response"
408
+ properties:
409
+ request_id:
410
+ type: string
411
+ summary: リクエストID
412
+ name:
413
+ type: string
414
+ summary: バルクチャージ管理用の名前
415
+ description:
416
+ type: string
417
+ summary: バルクチャージ管理用の説明文
418
+ status:
419
+ type: string
420
+ enum:
421
+ - submitted
422
+ - examining
423
+ - queued
424
+ - processing
425
+ - error
426
+ - done
427
+ summary: バルクチャージの状態
428
+ submitted_at:
429
+ type: string
430
+ format: date-time
431
+ summary: バルクチャージが登録された日時
432
+ updated_at:
433
+ type: string
434
+ format: date-time
435
+ summary: バルクチャージが更新された日時
406
436
  AccountWithoutPrivateMoneyDetail:
407
437
  x-pokepay-schema-type: "response"
408
438
  properties:
@@ -1087,13 +1117,13 @@ paths:
1087
1117
  summary: '店舗ID'
1088
1118
  description: 支払いQRコードを作成した店舗IDでフィルターします。
1089
1119
  lower_limit_amount:
1090
- type: number
1120
+ type: integer
1091
1121
  minimum: 0
1092
1122
  format: decimal
1093
1123
  summary: '金額の範囲によるフィルタ(下限)'
1094
1124
  description: 支払いQRコードの金額の下限を指定してフィルターします。
1095
1125
  upper_limit_amount:
1096
- type: number
1126
+ type: integer
1097
1127
  minimum: 0
1098
1128
  format: decimal
1099
1129
  summary: '金額の範囲によるフィルタ(上限)'
@@ -1769,6 +1799,73 @@ paths:
1769
1799
  $ref: '#/components/responses/BadRequest'
1770
1800
  '422':
1771
1801
  $ref: '#/components/responses/UnprocessableEntity'
1802
+ /transactions/bulk:
1803
+ post:
1804
+ summary: CSVファイル一括取引
1805
+ description: CSVファイルから一括取引をします。
1806
+ x-pokepay-operator-name: "BulkCreateTransaction"
1807
+ x-pokepay-allow-server-side: true
1808
+ requestBody:
1809
+ required: true
1810
+ content:
1811
+ application/json:
1812
+ schema:
1813
+ required: ["name", "content", "request_id"]
1814
+ properties:
1815
+ name:
1816
+ type: string
1817
+ maxLength: 32
1818
+ summary: 一括取引タスク名
1819
+ description: |-
1820
+ 一括取引タスクの管理用の名前です。
1821
+ description:
1822
+ type: string
1823
+ maxLength: 128
1824
+ summary: 一括取引の説明
1825
+ description: |-
1826
+ 一括取引タスクの管理用の説明文です。
1827
+ content:
1828
+ type: string
1829
+ summary: 取引する情報のCSV
1830
+ description: |-
1831
+ 一括取引する情報を書いたCSVの文字列です。
1832
+ 1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
1833
+ カラムは以下の7つです。任意のカラムには空文字を指定します。
1834
+
1835
+ - `type`: 取引種別
1836
+ - 必須。'topup' または 'payment'
1837
+ - `sender_account_id`: 送金ウォレットID
1838
+ - 必須。UUID
1839
+ - `receiver_account_id`: 受取ウォレットID
1840
+ - 必須。UUID
1841
+ - `money_amount`: マネー額
1842
+ - 任意。ただし `point_amount` といずれかが必須。0以上の数字
1843
+ - `point_amount`: ポイント額
1844
+ - 任意。ただし `money_amount` といずれかが必須。0以上の数字
1845
+ - `bear_account_id`: ポイント負担ウォレットID
1846
+ - `point_amount` があるときは必須。UUID
1847
+ - `point_expires_at`: ポイントの有効期限
1848
+ - 任意。指定がないときはマネーに設定された有効期限を適用
1849
+ request_id:
1850
+ type: string
1851
+ minLength: 36
1852
+ maxLength: 36
1853
+ summary: リクエストID
1854
+ description: |-
1855
+ 重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
1856
+ responses:
1857
+ '200':
1858
+ description: OK
1859
+ content:
1860
+ application/json:
1861
+ schema:
1862
+ $ref: '#/components/schemas/BulkTransaction'
1863
+ '400':
1864
+ $ref: '#/components/responses/BadRequest'
1865
+ '403':
1866
+ $ref: '#/components/responses/Forbidden'
1867
+ '409':
1868
+ $ref: '#/components/responses/Conflict'
1772
1869
  /transactions/{transaction_id}:
1773
1870
  get:
1774
1871
  summary: '取引情報を取得する'
@@ -2008,6 +2105,46 @@ paths:
2008
2105
  summary: 'マネーID'
2009
2106
  description: |
2010
2107
  このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
2108
+ name:
2109
+ type: string
2110
+ minLength: 1
2111
+ maxLength: 256
2112
+ summary: '店舗名'
2113
+ example: 'oxスーパー三田店'
2114
+ description: |
2115
+ このパラメータを渡すとその名前の店舗のみが返されます。
2116
+ postal_code:
2117
+ type: string
2118
+ pattern: '^[0-9]{3}-?[0-9]{4}$'
2119
+ summary: '店舗の郵便番号'
2120
+ description: |
2121
+ このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
2122
+ address:
2123
+ type: string
2124
+ maxLength: 256
2125
+ summary: '店舗の住所'
2126
+ example: '東京都港区芝...'
2127
+ description: |
2128
+ このパラメータを渡すとその住所が登録された店舗のみが返されます。
2129
+ tel:
2130
+ type: string
2131
+ pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
2132
+ summary: '店舗の電話番号'
2133
+ description: |
2134
+ このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
2135
+ email:
2136
+ type: string
2137
+ format: email
2138
+ maxLength: 256
2139
+ summary: '店舗のメールアドレス'
2140
+ description: |
2141
+ このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
2142
+ external_id:
2143
+ type: string
2144
+ maxLength: 36
2145
+ summary: '店舗の外部ID'
2146
+ description: |
2147
+ このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
2011
2148
  page:
2012
2149
  type: integer
2013
2150
  minimum: 1
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.7
4
+ version: 0.1.8
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: 2020-09-18 00:00:00.000000000 Z
11
+ date: 2020-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -116,6 +116,7 @@ files:
116
116
  - lib/pokepay_partner_ruby_sdk.rb
117
117
  - lib/pokepay_partner_ruby_sdk/client.rb
118
118
  - lib/pokepay_partner_ruby_sdk/crypto.rb
119
+ - lib/pokepay_partner_ruby_sdk/request/bulk_create_transaction.rb
119
120
  - lib/pokepay_partner_ruby_sdk/request/create_bill.rb
120
121
  - lib/pokepay_partner_ruby_sdk/request/create_check.rb
121
122
  - lib/pokepay_partner_ruby_sdk/request/create_customer_account.rb
@@ -153,6 +154,7 @@ files:
153
154
  - lib/pokepay_partner_ruby_sdk/response/admin_user_with_shops_and_private_moneys.rb
154
155
  - lib/pokepay_partner_ruby_sdk/response/bad_request.rb
155
156
  - lib/pokepay_partner_ruby_sdk/response/bill.rb
157
+ - lib/pokepay_partner_ruby_sdk/response/bulk_transaction.rb
156
158
  - lib/pokepay_partner_ruby_sdk/response/check.rb
157
159
  - lib/pokepay_partner_ruby_sdk/response/echo.rb
158
160
  - lib/pokepay_partner_ruby_sdk/response/invalid_parameters.rb