pokepay_partner_ruby_sdk 0.1.6 → 0.1.7

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: 1fd61e182a33f59658adeb782593d28971cc70072d3d434b8880ba51d1348e81
4
- data.tar.gz: 26dae7ac67ff5e10e2ab44f7e1fe2c03efcf30616e2cab5cb755b6bf757518fc
3
+ metadata.gz: 9db39bf7da512ddaf415d0312da429572674806d75d1a5beca492a8e10860f4b
4
+ data.tar.gz: 843b0548ce65832615325185665fd702b52dadcc13deadb0f0a3edbd7123d6a5
5
5
  SHA512:
6
- metadata.gz: 5e2b87c098a019491ffac0b7744d672747cbc0a6a1756e4d7b6ce61da8dc765e4d05b61522eb206a27618c0bf793a7c7c89f03aa1e761e0dde503f5b6e999926
7
- data.tar.gz: d8fd52165e868d36d33de7e96637cd02d30fb99107ca74b1b8964c2780bf16cee298c2af817cd1983a6a149e932495a4c17a72261ce12c7b73e6e8d37b42a58d
6
+ metadata.gz: 174b9e30acfcd57947de69f0860fb0def5703b4a35b6d90931760bcf604799bb6c5bd2e6d43428929a53452b88eb2736ed013d0e32646254ca7547f03906ce2e
7
+ data.tar.gz: ab2167de48835f66b92a3db675e768288736ad04376a76d2415b291d2146888ad6c24296ce345436a2bfa23f24da15169b7ec94bea7513452302d96122c1d07d
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- pokepay_partner_ruby_sdk (0.1.6)
4
+ pokepay_partner_ruby_sdk (0.1.7)
5
5
  inifile (~> 3.0.0)
6
6
  json (~> 2.3.0)
7
7
  openssl (~> 2.1.2)
@@ -169,8 +169,8 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
169
169
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // customer_id: エンドユーザーのID
170
170
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
171
171
  bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント支払時の負担店舗ID
172
- money_amount: 3515, // マネー額
173
- point_amount: 7853, // ポイント額
172
+ money_amount: 8987, // マネー額
173
+ point_amount: 750, // ポイント額
174
174
  description: "初夏のチャージキャンペーン" // 取引履歴に表示する説明文
175
175
  ))
176
176
  ```
@@ -229,7 +229,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
229
229
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // shop_id: 店舗ID
230
230
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // customer_id: エンドユーザーID
231
231
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
232
- 4119, // amount: 支払い額
232
+ 8123, // amount: 支払い額
233
233
  description: "たい焼き(小倉)" // 取引履歴に表示する説明文
234
234
  ))
235
235
  ```
@@ -267,12 +267,59 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
267
267
  ---
268
268
  成功したときは[Transaction](#transaction)オブジェクトを返します
269
269
 
270
+ #### 個人間送金
271
+ エンドユーザー間での送金取引(個人間送金)を作成します。
272
+ 個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
273
+
274
+ ```ruby
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: "たい焼き(小倉)" // 取引履歴に表示する説明文
281
+ ))
282
+ ```
283
+
284
+ ---
285
+ `sender_id`
286
+ エンドユーザーIDです。
287
+
288
+ 送金元のエンドユーザー(送り主)を指定します。
289
+
290
+ ---
291
+ `receiver_id`
292
+ エンドユーザーIDです。
293
+
294
+ 送金先のエンドユーザー(受け取り人)を指定します。
295
+
296
+ ---
297
+ `private_money_id`
298
+ マネーIDです。
299
+
300
+ マネーを指定します。
301
+
302
+ ---
303
+ `amount`
304
+ マネー額です。
305
+
306
+ 送金するマネー額を指定します。
307
+
308
+ ---
309
+ `description`
310
+ 取引説明文です。
311
+
312
+ 任意入力で、取引履歴に表示される説明文です。
313
+
314
+ ---
315
+ 成功したときは[Transaction](#transaction)オブジェクトを返します
316
+
270
317
  #### 取引履歴を取得する
271
318
  取引一覧を返します。
272
319
  ```ruby
273
320
  response = $client.send(Pokepay::Request::ListTransactions.new(
274
- from: "2024-03-14T02:41:24.000000+09:00", // 開始日時
275
- to: "2019-04-09T15:58:53.000000+09:00", // 終了日時
321
+ from: "2016-11-19T02:36:58.000000+09:00", // 開始日時
322
+ to: "2021-03-05T00:00:07.000000+09:00", // 終了日時
276
323
  page: 1, // ページ番号
277
324
  per_page: 50, // 1ページ分の取引数
278
325
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
@@ -400,13 +447,13 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
400
447
  ```ruby
401
448
  response = $client.send(Pokepay::Request::CreateCheck.new(
402
449
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // account_id: 送金元の店舗アカウントID
403
- money_amount: 9919, // 付与マネー額
404
- point_amount: 2608, // 付与ポイント額
450
+ money_amount: 8455, // 付与マネー額
451
+ point_amount: 6119, // 付与ポイント額
405
452
  description: "test check", // 説明文(アプリ上で取引の説明文として表示される)
406
- is_onetime: false, // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
407
- usage_limit: 8625, // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
408
- expires_at: "2022-02-18T00:32:55.000000+09:00", // チャージQR自体の失効日時
409
- point_expires_at: "2017-12-02T22:53:00.000000+09:00", // チャージQRによって付与されるポイントの失効日時
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によって付与されるポイントの失効日時
410
457
  point_expires_in_days: 60, // チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
411
458
  bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ポイント額を負担する店舗アカウントのID
412
459
  ))
@@ -457,6 +504,135 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
457
504
  ---
458
505
  成功したときは[Transaction](#transaction)オブジェクトを返します
459
506
 
507
+ ### 支払いQRコード
508
+
509
+ #### 支払いQRコード一覧を表示する
510
+ 支払いQRコード一覧を表示します。
511
+ ```ruby
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コードが無効化されているかどうか
526
+ ))
527
+ ```
528
+
529
+ ---
530
+ `page`
531
+ 取得したいページ番号です。
532
+
533
+ ---
534
+ `per_page`
535
+ 1ページに表示する支払いQRコードの数です。
536
+
537
+ ---
538
+ `bill_id`
539
+ 支払いQRコードのIDを指定して検索します。IDは部分一致で検索できます。
540
+
541
+ ---
542
+ `private_money_id`
543
+ 支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
544
+
545
+ ---
546
+ `organization_code`
547
+ 支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
548
+
549
+ ---
550
+ `description`
551
+ 支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
552
+
553
+ ---
554
+ `created_from`
555
+ 支払いQRコードの作成日時でフィルターします。
556
+
557
+ これ以降に作成された支払いQRコードのみ一覧に表示されます。
558
+
559
+ ---
560
+ `created_to`
561
+ 支払いQRコードの作成日時でフィルターします。
562
+
563
+ これ以前に作成された支払いQRコードのみ一覧に表示されます。
564
+
565
+ ---
566
+ `shop_name`
567
+ 支払いQRコードを作成した店舗名でフィルターします。
568
+
569
+ ---
570
+ `shop_id`
571
+ 支払いQRコードを作成した店舗IDでフィルターします。
572
+
573
+ ---
574
+ `lower_limit_amount`
575
+ 支払いQRコードの金額の下限を指定してフィルターします。
576
+
577
+ ---
578
+ `upper_limit_amount`
579
+ 支払いQRコードの金額の上限を指定してフィルターします。
580
+
581
+ ---
582
+ `is_disabled`
583
+ 支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
584
+
585
+ ---
586
+ 成功したときは[PaginatedBills](#paginated-bills)オブジェクトを返します
587
+
588
+ #### 支払いQRコードの発行
589
+ 支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
590
+ ```ruby
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" // 説明文(アプリ上で取引の説明文として表示される)
596
+ ))
597
+ ```
598
+
599
+ ---
600
+ `amount`
601
+ 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
602
+
603
+ ---
604
+ 成功したときは[Bill](#bill)オブジェクトを返します
605
+
606
+ #### 支払いQRコードの更新
607
+ 支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
608
+ ```ruby
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 // 無効化されているかどうか
614
+ ))
615
+ ```
616
+
617
+ ---
618
+ `bill_id`
619
+ 更新対象の支払いQRコードのIDです。
620
+
621
+ ---
622
+ `amount`
623
+ 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
624
+
625
+ ---
626
+ `description`
627
+ 支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
628
+
629
+ ---
630
+ `is_disabled`
631
+ 支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
632
+
633
+ ---
634
+ 成功したときは[Bill](#bill)オブジェクトを返します
635
+
460
636
  ### Customer
461
637
 
462
638
  #### 新規エンドユーザーウォレットを追加する
@@ -486,7 +662,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
486
662
  ---
487
663
  成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
488
664
 
489
- #### エンドユーザーのウォレット情報を表示する
665
+ #### ウォレット情報を表示する
490
666
  ウォレットを取得します。
491
667
  ```ruby
492
668
  response = $client.send(Pokepay::Request::GetAccount.new(
@@ -504,12 +680,15 @@ response = $client.send(Pokepay::Request::GetAccount.new(
504
680
  成功したときは[AccountDetail](#account-detail)オブジェクトを返します
505
681
 
506
682
  #### エンドユーザーの残高内訳を表示する
507
- エンドユーザーの残高は有効期限別のリストとして取得できます。
683
+ エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
508
684
  ```ruby
509
685
  response = $client.send(Pokepay::Request::ListAccountBalances.new(
510
686
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // account_id: ウォレットID
511
- page: 7956, // ページ番号
512
- per_page: 4513 // 1ページ分の取引数
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" // 有効期限によるソート順序
513
692
  ))
514
693
  ```
515
694
 
@@ -521,15 +700,148 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
521
700
 
522
701
  ---
523
702
  `page`
524
- 取得したいページ番号です。
703
+ 取得したいページ番号です。デフォルト値は1です。
525
704
 
526
705
  ---
527
706
  `per_page`
528
- 1ページ分のウォレット残高数です。
707
+ 1ページ分のウォレット残高数です。デフォルト値は30です。
708
+
709
+ ---
710
+ `expires_at_from`
711
+ 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
712
+
713
+ ---
714
+ `expires_at_to`
715
+ 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
716
+
717
+ ---
718
+ `direction`
719
+ 有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
529
720
 
530
721
  ---
531
722
  成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
532
723
 
724
+ #### エンドユーザーの失効済みの残高内訳を表示する
725
+ エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
726
+ ```ruby
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" // 有効期限によるソート順序
734
+ ))
735
+ ```
736
+
737
+ ---
738
+ `account_id`
739
+ ウォレットIDです。
740
+
741
+ フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
742
+
743
+ ---
744
+ `page`
745
+ 取得したいページ番号です。デフォルト値は1です。
746
+
747
+ ---
748
+ `per_page`
749
+ 1ページ分のウォレット残高数です。デフォルト値は30です。
750
+
751
+ ---
752
+ `expires_at_from`
753
+ 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
754
+
755
+ ---
756
+ `expires_at_to`
757
+ 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
758
+
759
+ ---
760
+ `direction`
761
+ 有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
762
+
763
+ ---
764
+ 成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
765
+
766
+ #### 取引履歴を取得する
767
+ 取引一覧を返します。
768
+ ```ruby
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ページ分の取引数
779
+ ))
780
+ ```
781
+
782
+ ---
783
+ `private_money_id`
784
+ マネーIDです。
785
+ フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
786
+
787
+ ---
788
+ `sender_customer_id`
789
+ 送金ユーザーIDです。
790
+
791
+ フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
792
+
793
+ ---
794
+ `receiver_customer_id`
795
+ 受取ユーザーIDです。
796
+
797
+ フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
798
+
799
+ ---
800
+ `type`
801
+ 取引の種類でフィルターします。
802
+
803
+ 以下の種類を指定できます。
804
+
805
+ 1. topup
806
+ 店舗からエンドユーザーへの送金取引(チャージ)
807
+ 2. payment
808
+ エンドユーザーから店舗への送金取引(支払い)
809
+ 3. exchange
810
+ 他マネーへの流出(outflow)/他マネーからの流入(inflow)
811
+ 4. transfer
812
+ 個人間送金
813
+
814
+ ---
815
+ `is_modified`
816
+ キャンセル済みかどうかを判定するフラグです。
817
+
818
+ これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
819
+ falseを指定するとキャンセルされていない取引のみ一覧に表示されます
820
+ 何も指定しなければキャンセルの有無にかかわらず一覧に表示されます。
821
+
822
+ ---
823
+ `from`
824
+ 抽出期間の開始日時です。
825
+
826
+ フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
827
+
828
+ ---
829
+ `to`
830
+ 抽出期間の終了日時です。
831
+
832
+ フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
833
+
834
+ ---
835
+ `page`
836
+ 取得したいページ番号です。
837
+
838
+ ---
839
+ `per_page`
840
+ 1ページ分の取引数です。
841
+
842
+ ---
843
+ 成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
844
+
533
845
  ### Organization
534
846
 
535
847
  #### 新規加盟店組織を追加する
@@ -537,14 +849,14 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
537
849
  response = $client.send(Pokepay::Request::CreateOrganization.new(
538
850
  "ox_supermarket", // code: 新規組織コード
539
851
  "oxスーパー", // name: 新規組織名
540
- ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], // private_money_ids: 加盟店組織で有効にするマネーIDの配列
541
- "1qSYlEPOrX@96su.com", // issuer_admin_user_email: 発行体担当者メールアドレス
542
- "Y89xlB3mgj@Y6Ph.com", // member_admin_user_email: 新規組織担当者メールアドレス
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: 新規組織担当者メールアドレス
543
855
  bank_name: "XYZ銀行", // 銀行名
544
856
  bank_code: "99X", // 銀行金融機関コード
545
857
  bank_branch_name: "ABC支店", // 銀行支店名
546
858
  bank_branch_code: "99X", // 銀行支店コード
547
- bank_account_type: "current", // 銀行口座種別 (普通=saving, 当座=current, その他=other)
859
+ bank_account_type: "saving", // 銀行口座種別 (普通=saving, 当座=current, その他=other)
548
860
  bank_account: 9999999, // 銀行口座番号
549
861
  bank_account_holder_name: "フクザワユキチ", // 口座名義人名
550
862
  contact_name: "佐藤清" // 担当者名
@@ -558,24 +870,74 @@ response = $client.send(Pokepay::Request::CreateOrganization.new(
558
870
  ```ruby
559
871
  response = $client.send(Pokepay::Request::CreateShop.new(
560
872
  "oxスーパー三田店", // shop_name: 店舗名
561
- shop_postal_code: "652-4859", // 店舗の郵便番号
873
+ shop_postal_code: "422-5364", // 店舗の郵便番号
562
874
  shop_address: "東京都港区芝...", // 店舗の住所
563
- shop_tel: "096-99-5223", // 店舗の電話番号
564
- shop_email: "0ktWQ723w2@IG1J.com", // 店舗のメールアドレス
565
- shop_external_id: "lBzqgWY2glpsEhUQhgL9hEwO7oPQpA", // 店舗の外部ID
875
+ shop_tel: "083-33-947", // 店舗の電話番号
876
+ shop_email: "pSCBGnb27K@I1Ko.com", // 店舗のメールアドレス
877
+ shop_external_id: "9Ro9P2UOPHKc", // 店舗の外部ID
566
878
  organization_code: "ox-supermarket" // 組織コード
567
879
  ))
568
880
  ```
569
881
  成功したときは[User](#user)オブジェクトを返します
570
882
 
883
+ #### 店舗一覧を取得する
884
+ ```ruby
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ページ分の取引数
890
+ ))
891
+ ```
892
+
893
+ ---
894
+ `organization_code`
895
+ このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
896
+
897
+
898
+ ---
899
+ `private_money_id`
900
+ このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
901
+
902
+
903
+ ---
904
+ `page`
905
+ 取得したいページ番号です。
906
+
907
+ ---
908
+ `per_page`
909
+ 1ページ分の取引数です。
910
+
911
+ ---
912
+ 成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
913
+
914
+ ### Account
915
+
916
+ #### エンドユーザー、店舗ユーザーのウォレット一覧を表示する
917
+ ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
918
+ ```ruby
919
+ response = $client.send(Pokepay::Request::ListUserAccounts.new(
920
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // user_id: ユーザーID
921
+ ))
922
+ ```
923
+
924
+ ---
925
+ `user_id`
926
+ ユーザーIDです。
927
+
928
+ 指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
929
+
930
+ ---
931
+ 成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
932
+
571
933
  ### Private Money
572
934
 
573
935
  #### 決済加盟店の取引サマリを取得する
574
936
  ```ruby
575
937
  response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
576
938
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // private_money_id: マネーID
577
- from: "2017-05-21T20:37:05.000000+09:00", // 開始日時(toと同時に指定する必要有)
578
- to: "2018-07-11T00:21:30.000000+09:00", // 終了日時(fromと同時に指定する必要有)
939
+ from: "2020-03-02T19:54:29.000000+09:00", // 開始日時(toと同時に指定する必要有)
940
+ to: "2024-10-09T07:46:14.000000+09:00", // 終了日時(fromと同時に指定する必要有)
579
941
  page: 1, // ページ番号
580
942
  per_page: 50 // 1ページ分の取引数
581
943
  ))
@@ -586,6 +948,7 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
586
948
 
587
949
  ## Responses
588
950
 
951
+
589
952
  <a name="account-with-user"></a>
590
953
  ## AccountWithUser
591
954
  * `id (string)`:
@@ -610,6 +973,19 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
610
973
 
611
974
  `private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
612
975
 
976
+ <a name="bill"></a>
977
+ ## Bill
978
+ * `id (string)`: 支払いQRコードのID
979
+ * `amount (double)`: 支払い額
980
+ * `max_amount (double)`: 支払い額を範囲指定した場合の上限
981
+ * `min_amount (double)`: 支払い額を範囲指定した場合の下限
982
+ * `description (string)`: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
983
+ * `account (AccountWithUser)`: 支払いQRコード発行ウォレット
984
+ * `is_disabled (boolean)`: 無効化されているかどうか
985
+ * `token (string)`:
986
+
987
+ `account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
988
+
613
989
  <a name="check"></a>
614
990
  ## Check
615
991
  * `id (string)`: チャージQRコードのID
@@ -695,6 +1071,16 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
695
1071
 
696
1072
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
697
1073
 
1074
+ <a name="paginated-accounts"></a>
1075
+ ## PaginatedAccounts
1076
+ * `rows (array of Accounts)`:
1077
+ * `count (integer)`:
1078
+ * `pagination (Pagination)`:
1079
+
1080
+ `rows`は [Account](#account) オブジェクトの配列を返します。
1081
+
1082
+ `pagination`は [Pagination](#pagination) オブジェクトを返します。
1083
+
698
1084
  <a name="paginated-account-balance"></a>
699
1085
  ## PaginatedAccountBalance
700
1086
  * `rows (array of AccountBalances)`:
@@ -705,6 +1091,26 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
705
1091
 
706
1092
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
707
1093
 
1094
+ <a name="paginated-shops"></a>
1095
+ ## PaginatedShops
1096
+ * `rows (array of ShopWithMetadatas)`:
1097
+ * `count (integer)`:
1098
+ * `pagination (Pagination)`:
1099
+
1100
+ `rows`は [ShopWithMetadata](#shop-with-metadata) オブジェクトの配列を返します。
1101
+
1102
+ `pagination`は [Pagination](#pagination) オブジェクトを返します。
1103
+
1104
+ <a name="paginated-bills"></a>
1105
+ ## PaginatedBills
1106
+ * `rows (array of Bills)`:
1107
+ * `count (integer)`:
1108
+ * `pagination (Pagination)`:
1109
+
1110
+ `rows`は [Bill](#bill) オブジェクトの配列を返します。
1111
+
1112
+ `pagination`は [Pagination](#pagination) オブジェクトを返します。
1113
+
708
1114
  <a name="private-money"></a>
709
1115
  ## PrivateMoney
710
1116
  * `id (string)`: マネーID
@@ -763,3 +1169,14 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
763
1169
  * `expires_at (string)`:
764
1170
  * `money_amount (double)`:
765
1171
  * `point_amount (double)`:
1172
+
1173
+ <a name="shop-with-metadata"></a>
1174
+ ## ShopWithMetadata
1175
+ * `id (string)`: 店舗ID
1176
+ * `name (string)`: 店舗名
1177
+ * `organization_code (string)`: 組織コード
1178
+ * `postal_code (string)`: 店舗の郵便番号
1179
+ * `address (string)`: 店舗の住所
1180
+ * `tel (string)`: 店舗の電話番号
1181
+ * `email (string)`: 店舗のメールアドレス
1182
+ * `external_id (string)`: 店舗の外部ID
@@ -12,8 +12,11 @@ require "pokepay_partner_ruby_sdk/request/list_user_accounts"
12
12
  require "pokepay_partner_ruby_sdk/request/get_account"
13
13
  require "pokepay_partner_ruby_sdk/request/update_account"
14
14
  require "pokepay_partner_ruby_sdk/request/list_account_balances"
15
+ require "pokepay_partner_ruby_sdk/request/list_account_expired_balances"
15
16
  require "pokepay_partner_ruby_sdk/request/create_customer_account"
16
17
  require "pokepay_partner_ruby_sdk/request/list_bills"
18
+ require "pokepay_partner_ruby_sdk/request/create_bill"
19
+ require "pokepay_partner_ruby_sdk/request/update_bill"
17
20
  require "pokepay_partner_ruby_sdk/request/create_check"
18
21
  require "pokepay_partner_ruby_sdk/request/list_transactions"
19
22
  require "pokepay_partner_ruby_sdk/request/create_transaction"
@@ -29,6 +32,7 @@ require "pokepay_partner_ruby_sdk/request/create_organization"
29
32
  require "pokepay_partner_ruby_sdk/request/list_shops"
30
33
  require "pokepay_partner_ruby_sdk/request/create_shop"
31
34
  require "pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries"
35
+ require "pokepay_partner_ruby_sdk/request/list_customer_transactions"
32
36
  require "pokepay_partner_ruby_sdk/response/pong"
33
37
  require "pokepay_partner_ruby_sdk/response/echo"
34
38
  require "pokepay_partner_ruby_sdk/response/pagination"
@@ -0,0 +1,16 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/bill"
4
+
5
+ module Pokepay::Request
6
+ class CreateBill < Request
7
+ def initialize(private_money_id, shop_id, rest_args = {})
8
+ @path = "/bills"
9
+ @method = "POST"
10
+ @body_params = { "private_money_id" => private_money_id,
11
+ "shop_id" => shop_id }.merge(rest_args)
12
+ @response_class = Pokepay::Response::Bill
13
+ end
14
+ attr_reader :response_class
15
+ end
16
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
4
+
5
+ module Pokepay::Request
6
+ class ListAccountExpiredBalances < Request
7
+ def initialize(account_id, rest_args = {})
8
+ @path = "/accounts" + "/" + account_id + "/expired-balances"
9
+ @method = "GET"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::PaginatedAccountBalance
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_transaction"
4
+
5
+ module Pokepay::Request
6
+ class ListCustomerTransactions < Request
7
+ def initialize(private_money_id, rest_args = {})
8
+ @path = "/customers" + "/transactions"
9
+ @method = "GET"
10
+ @body_params = { "private_money_id" => private_money_id }.merge(rest_args)
11
+ @response_class = Pokepay::Response::PaginatedTransaction
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/bill"
4
+
5
+ module Pokepay::Request
6
+ class UpdateBill < Request
7
+ def initialize(bill_id, rest_args = {})
8
+ @path = "/bills" + "/" + bill_id
9
+ @method = "PATCH"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::Bill
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -12,6 +12,7 @@ module Pokepay::Response
12
12
  @description = row["description"]
13
13
  @account = AccountWithUser.new(row["account"])
14
14
  @is_disabled = row["is_disabled"]
15
+ @token = row["token"]
15
16
  end
16
17
  attr_reader :id
17
18
  attr_reader :amount
@@ -20,5 +21,6 @@ module Pokepay::Response
20
21
  attr_reader :description
21
22
  attr_reader :account
22
23
  attr_reader :is_disabled
24
+ attr_reader :token
23
25
  end
24
26
  end
@@ -1,3 +1,3 @@
1
1
  module Pokepay
2
- VERSION = "0.1.6"
2
+ VERSION = "0.1.7"
3
3
  end
@@ -165,6 +165,9 @@ components:
165
165
  is_disabled:
166
166
  type: boolean
167
167
  summary: 無効化されているかどうか
168
+ token:
169
+ type: string
170
+ description: 支払いQRコードを解析したときに出てくるURL
168
171
  Check:
169
172
  x-pokepay-schema-type: "response"
170
173
  properties:
@@ -771,7 +774,7 @@ paths:
771
774
  $ref: '#/components/responses/NotFound'
772
775
  /accounts/{account_id}:
773
776
  get:
774
- summary: 'エンドユーザーのウォレット情報を表示する'
777
+ summary: 'ウォレット情報を表示する'
775
778
  description: ウォレットを取得します。
776
779
  x-pokepay-operator-name: "GetAccount"
777
780
  x-pokepay-allow-server-side: true
@@ -801,6 +804,7 @@ paths:
801
804
  '404':
802
805
  $ref: '#/components/responses/NotFound'
803
806
  patch:
807
+ summary: 'ウォレット情報を更新する'
804
808
  description: ウォレットの状態を更新します。現在はウォレットの凍結/凍結解除の切り替えにのみ対応しています。
805
809
  x-pokepay-operator-name: "UpdateAccount"
806
810
  x-pokepay-allow-server-side: true
@@ -811,6 +815,7 @@ paths:
811
815
  schema:
812
816
  type: string
813
817
  format: uuid
818
+ summary: 'ウォレットID'
814
819
  description: |-
815
820
  ウォレットIDです。
816
821
 
@@ -823,6 +828,7 @@ paths:
823
828
  properties:
824
829
  is_suspended:
825
830
  type: boolean
831
+ summary: 'ウォレットが凍結されているかどうか'
826
832
  description: ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
827
833
  responses:
828
834
  '200':
@@ -840,7 +846,7 @@ paths:
840
846
  /accounts/{account_id}/balances:
841
847
  get:
842
848
  summary: 'エンドユーザーの残高内訳を表示する'
843
- description: エンドユーザーの残高は有効期限別のリストとして取得できます。
849
+ description: エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
844
850
  x-pokepay-operator-name: "ListAccountBalances"
845
851
  x-pokepay-allow-server-side: true
846
852
  parameters:
@@ -865,12 +871,89 @@ paths:
865
871
  type: integer
866
872
  minimum: 1
867
873
  summary: 'ページ番号'
868
- description: 取得したいページ番号です。
874
+ description: 取得したいページ番号です。デフォルト値は1です。
869
875
  per_page:
870
876
  type: integer
871
877
  minimum: 1
872
878
  summary: '1ページ分の取引数'
873
- description: 1ページ分のウォレット残高数です。
879
+ description: 1ページ分のウォレット残高数です。デフォルト値は30です。
880
+ expires_at_from:
881
+ type: string
882
+ format: date-time
883
+ summary: '有効期限の期間によるフィルター(開始時点)'
884
+ description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
885
+ expires_at_to:
886
+ type: string
887
+ format: date-time
888
+ summary: '有効期限の期間によるフィルター(終了時点)'
889
+ description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
890
+ direction:
891
+ type: string
892
+ enum: [asc, desc]
893
+ summary: '有効期限によるソート順序'
894
+ description: 有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
895
+ responses:
896
+ '200':
897
+ description: OK
898
+ content:
899
+ application/json:
900
+ schema:
901
+ $ref: '#/components/schemas/PaginatedAccountBalance'
902
+ '400':
903
+ $ref: '#/components/responses/BadRequest'
904
+ '403':
905
+ $ref: '#/components/responses/Forbidden'
906
+ '404':
907
+ $ref: '#/components/responses/NotFound'
908
+ /accounts/{account_id}/expired-balances:
909
+ get:
910
+ summary: 'エンドユーザーの失効済みの残高内訳を表示する'
911
+ description: エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
912
+ x-pokepay-operator-name: "ListAccountExpiredBalances"
913
+ x-pokepay-allow-server-side: true
914
+ parameters:
915
+ - name: account_id
916
+ in: path
917
+ required: true
918
+ schema:
919
+ type: string
920
+ format: uuid
921
+ summary: 'ウォレットID'
922
+ description: |-
923
+ ウォレットIDです。
924
+
925
+ フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
926
+ requestBody:
927
+ required: true
928
+ content:
929
+ application/json:
930
+ schema:
931
+ properties:
932
+ page:
933
+ type: integer
934
+ minimum: 1
935
+ summary: 'ページ番号'
936
+ description: 取得したいページ番号です。デフォルト値は1です。
937
+ per_page:
938
+ type: integer
939
+ minimum: 1
940
+ summary: '1ページ分の取引数'
941
+ description: 1ページ分のウォレット残高数です。デフォルト値は30です。
942
+ expires_at_from:
943
+ type: string
944
+ format: date-time
945
+ summary: '有効期限の期間によるフィルター(開始時点)'
946
+ description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
947
+ expires_at_to:
948
+ type: string
949
+ format: date-time
950
+ summary: '有効期限の期間によるフィルター(終了時点)'
951
+ description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
952
+ direction:
953
+ type: string
954
+ enum: [asc, desc]
955
+ summary: '有効期限によるソート順序'
956
+ description: 有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
874
957
  responses:
875
958
  '200':
876
959
  description: OK
@@ -1030,6 +1113,104 @@ paths:
1030
1113
  $ref: '#/components/responses/BadRequest'
1031
1114
  '403':
1032
1115
  $ref: '#/components/responses/Forbidden'
1116
+ post:
1117
+ summary: '支払いQRコードの発行'
1118
+ description: 支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
1119
+ x-pokepay-operator-name: "CreateBill"
1120
+ x-pokepay-allow-server-side: true
1121
+ requestBody:
1122
+ required: true
1123
+ content:
1124
+ application/json:
1125
+ schema:
1126
+ required: ["private_money_id", "shop_id"]
1127
+ properties:
1128
+ amount:
1129
+ type: number
1130
+ minimum: 0
1131
+ nullable: true
1132
+ format: decimal
1133
+ summary: '支払い額'
1134
+ description: 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
1135
+ private_money_id:
1136
+ type: string
1137
+ format: uuid
1138
+ summary: '支払いマネーのマネーID'
1139
+ shop_id:
1140
+ type: string
1141
+ format: uuid
1142
+ summary: '支払い先(受け取り人)の店舗ID'
1143
+ description:
1144
+ type: string
1145
+ maxLength: 200
1146
+ summary: '説明文(アプリ上で取引の説明文として表示される)'
1147
+ example: 'test bill'
1148
+ responses:
1149
+ '200':
1150
+ description: OK
1151
+ content:
1152
+ application/json:
1153
+ schema:
1154
+ $ref: '#/components/schemas/Bill'
1155
+ '400':
1156
+ $ref: '#/components/responses/BadRequest'
1157
+ '403':
1158
+ $ref: '#/components/responses/Forbidden'
1159
+ '422':
1160
+ $ref: '#/components/responses/UnprocessableEntity'
1161
+
1162
+ /bills/{bill_id}:
1163
+ patch:
1164
+ summary: '支払いQRコードの更新'
1165
+ description: 支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
1166
+ x-pokepay-operator-name: "UpdateBill"
1167
+ x-pokepay-allow-server-side: true
1168
+ parameters:
1169
+ - in: path
1170
+ name: bill_id
1171
+ required: true
1172
+ schema:
1173
+ type: string
1174
+ format: uuid
1175
+ summary: '支払いQRコードのID'
1176
+ description: |-
1177
+ 更新対象の支払いQRコードのIDです。
1178
+ requestBody:
1179
+ required: true
1180
+ content:
1181
+ application/json:
1182
+ schema:
1183
+ properties:
1184
+ amount:
1185
+ type: number
1186
+ minimum: 0
1187
+ nullable: true
1188
+ format: decimal
1189
+ summary: '支払い額'
1190
+ description: 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
1191
+ description:
1192
+ type: string
1193
+ maxLength: 200
1194
+ summary: '説明文'
1195
+ description: 支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
1196
+ example: 'test bill'
1197
+ is_disabled:
1198
+ type: boolean
1199
+ summary: '無効化されているかどうか'
1200
+ description: 支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
1201
+ responses:
1202
+ '200':
1203
+ description: OK
1204
+ content:
1205
+ application/json:
1206
+ schema:
1207
+ $ref: '#/components/schemas/Bill'
1208
+ '400':
1209
+ $ref: '#/components/responses/BadRequest'
1210
+ '403':
1211
+ $ref: '#/components/responses/Forbidden'
1212
+ '404':
1213
+ $ref: '#/components/responses/NotFound'
1033
1214
  /checks:
1034
1215
  post:
1035
1216
  summary: 'チャージQRコードの発行'
@@ -1965,3 +2146,105 @@ paths:
1965
2146
  $ref: '#/components/responses/Forbidden'
1966
2147
  '404':
1967
2148
  $ref: '#/components/responses/NotFound'
2149
+ /customers/transactions:
2150
+ get:
2151
+ summary: '取引履歴を取得する'
2152
+ description: '取引一覧を返します。'
2153
+ x-pokepay-operator-name: "ListCustomerTransactions"
2154
+ x-pokepay-allow-server-side: true
2155
+ requestBody:
2156
+ required: true
2157
+ content:
2158
+ application/json:
2159
+ schema:
2160
+ required: ["private_money_id"]
2161
+ properties:
2162
+ private_money_id:
2163
+ type: string
2164
+ format: uuid
2165
+ summary: 'マネーID'
2166
+ description: |-
2167
+ マネーIDです。
2168
+ フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
2169
+ sender_customer_id:
2170
+ type: string
2171
+ format: uuid
2172
+ summary: '送金エンドユーザーID'
2173
+ description: |-
2174
+ 送金ユーザーIDです。
2175
+
2176
+ フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
2177
+ receiver_customer_id:
2178
+ type: string
2179
+ format: uuid
2180
+ summary: '受取エンドユーザーID'
2181
+ description: |-
2182
+ 受取ユーザーIDです。
2183
+
2184
+ フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
2185
+ type:
2186
+ type: string
2187
+ summary: '取引種別、チャージ=topup、支払い=payment、個人間送金=transfer'
2188
+ description: |-
2189
+ 取引の種類でフィルターします。
2190
+
2191
+ 以下の種類を指定できます。
2192
+
2193
+ 1. topup
2194
+ 店舗からエンドユーザーへの送金取引(チャージ)
2195
+ 2. payment
2196
+ エンドユーザーから店舗への送金取引(支払い)
2197
+ 3. exchange
2198
+ 他マネーへの流出(outflow)/他マネーからの流入(inflow)
2199
+ 4. transfer
2200
+ 個人間送金
2201
+ is_modified:
2202
+ type: boolean
2203
+ summary: 'キャンセル済みかどうか'
2204
+ description: |-
2205
+ キャンセル済みかどうかを判定するフラグです。
2206
+
2207
+ これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
2208
+ falseを指定するとキャンセルされていない取引のみ一覧に表示されます
2209
+ 何も指定しなければキャンセルの有無にかかわらず一覧に表示されます。
2210
+ from:
2211
+ type: string
2212
+ format: date-time
2213
+ summary: '開始日時'
2214
+ description: |-
2215
+ 抽出期間の開始日時です。
2216
+
2217
+ フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
2218
+ to:
2219
+ type: string
2220
+ format: date-time
2221
+ summary: '終了日時'
2222
+ description: |-
2223
+ 抽出期間の終了日時です。
2224
+
2225
+ フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
2226
+ page:
2227
+ type: integer
2228
+ minimum: 1
2229
+ summary: 'ページ番号'
2230
+ description: 取得したいページ番号です。
2231
+ example: 1
2232
+ per_page:
2233
+ type: integer
2234
+ minimum: 1
2235
+ summary: '1ページ分の取引数'
2236
+ description: 1ページ分の取引数です。
2237
+ example: 50
2238
+ responses:
2239
+ '200':
2240
+ description: OK
2241
+ content:
2242
+ application/json:
2243
+ schema:
2244
+ $ref: '#/components/schemas/PaginatedTransaction'
2245
+ '400':
2246
+ $ref: '#/components/responses/InvalidParameters'
2247
+ '403':
2248
+ $ref: '#/components/responses/Forbidden'
2249
+ '422':
2250
+ $ref: '#/components/responses/UnprocessableEntity'
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.6
4
+ version: 0.1.7
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-08-28 00:00:00.000000000 Z
11
+ date: 2020-09-18 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/create_bill.rb
119
120
  - lib/pokepay_partner_ruby_sdk/request/create_check.rb
120
121
  - lib/pokepay_partner_ruby_sdk/request/create_customer_account.rb
121
122
  - lib/pokepay_partner_ruby_sdk/request/create_exchange_transaction.rb
@@ -132,7 +133,9 @@ files:
132
133
  - lib/pokepay_partner_ruby_sdk/request/get_transaction.rb
133
134
  - lib/pokepay_partner_ruby_sdk/request/get_user.rb
134
135
  - lib/pokepay_partner_ruby_sdk/request/list_account_balances.rb
136
+ - lib/pokepay_partner_ruby_sdk/request/list_account_expired_balances.rb
135
137
  - lib/pokepay_partner_ruby_sdk/request/list_bills.rb
138
+ - lib/pokepay_partner_ruby_sdk/request/list_customer_transactions.rb
136
139
  - lib/pokepay_partner_ruby_sdk/request/list_shops.rb
137
140
  - lib/pokepay_partner_ruby_sdk/request/list_transactions.rb
138
141
  - lib/pokepay_partner_ruby_sdk/request/list_transfers.rb
@@ -141,6 +144,7 @@ files:
141
144
  - lib/pokepay_partner_ruby_sdk/request/request.rb
142
145
  - lib/pokepay_partner_ruby_sdk/request/send_echo.rb
143
146
  - lib/pokepay_partner_ruby_sdk/request/update_account.rb
147
+ - lib/pokepay_partner_ruby_sdk/request/update_bill.rb
144
148
  - lib/pokepay_partner_ruby_sdk/response/account.rb
145
149
  - lib/pokepay_partner_ruby_sdk/response/account_balance.rb
146
150
  - lib/pokepay_partner_ruby_sdk/response/account_detail.rb