pokepay_partner_ruby_sdk 0.1.12 → 0.1.15.1

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 (19) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docs/index.md +473 -100
  4. data/lib/pokepay_partner_ruby_sdk/client.rb +24 -13
  5. data/lib/pokepay_partner_ruby_sdk/request/create_cpm_transaction.rb +17 -0
  6. data/lib/pokepay_partner_ruby_sdk/request/get_cpm_token.rb +15 -0
  7. data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb +2 -2
  8. data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb +3 -0
  9. data/lib/pokepay_partner_ruby_sdk/response/cashtray_attempt.rb +1 -1
  10. data/lib/pokepay_partner_ruby_sdk/response/cashtray_with_result.rb +2 -2
  11. data/lib/pokepay_partner_ruby_sdk/response/cpm_token.rb +26 -0
  12. data/lib/pokepay_partner_ruby_sdk/response/external_transaction.rb +31 -0
  13. data/lib/pokepay_partner_ruby_sdk/response/paginated_account_details.rb +16 -0
  14. data/lib/pokepay_partner_ruby_sdk/response/product.rb +21 -0
  15. data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
  16. data/lib/pokepay_partner_ruby_sdk.rb +6 -0
  17. data/partner.yaml +483 -8
  18. data/pokepay_partner_ruby_sdk.gemspec +3 -3
  19. metadata +12 -6
data/docs/index.md CHANGED
@@ -57,6 +57,20 @@ SSL_KEY_FILE = /path/to/key.pem
57
57
  SSL_CERT_FILE = /path/to/cert.pem
58
58
  ```
59
59
 
60
+ 設定はハッシュで渡すこともできます。
61
+
62
+ ```ruby
63
+ client = Pokepay::Client.new(
64
+ {
65
+ client_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
66
+ client_secret: "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
67
+ api_base_url: "https://partnerapi-sandbox.pokepay.jp",
68
+ ssl_key_file: "/path/to/key.pem",
69
+ ssl_cert_file: "/path/to/cert.pem"
70
+ }
71
+ )
72
+ ```
73
+
60
74
  ## Overview
61
75
 
62
76
  ### APIリクエスト
@@ -142,14 +156,16 @@ response.body
142
156
  <a name="api-operations"></a>
143
157
  ## API Operations
144
158
 
159
+ - [GetCpmToken](#get-cpm-token): CPMトークンの状態取得
145
160
  - [ListTransactions](#list-transactions): 取引履歴を取得する
146
161
  - [CreateTransaction](#create-transaction): チャージする(廃止予定)
147
162
  - [CreateTopupTransaction](#create-topup-transaction): チャージする
148
163
  - [CreatePaymentTransaction](#create-payment-transaction): 支払いする
164
+ - [CreateCpmTransaction](#create-cpm-transaction): CPMトークンによる取引作成
149
165
  - [CreateTransferTransaction](#create-transfer-transaction): 個人間送金
150
166
  - [CreateExchangeTransaction](#create-exchange-transaction):
151
167
  - [GetTransaction](#get-transaction): 取引情報を取得する
152
- - [RefundTransaction](#refund-transaction): 返金する
168
+ - [RefundTransaction](#refund-transaction): 取引をキャンセルする
153
169
  - [ListTransfers](#list-transfers):
154
170
  - [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
155
171
  - [ListBills](#list-bills): 支払いQRコード一覧を表示する
@@ -177,13 +193,35 @@ response.body
177
193
  - [GetPrivateMoneyOrganizationSummaries](#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
178
194
  - [BulkCreateTransaction](#bulk-create-transaction): CSVファイル一括取引
179
195
  ### Transaction
196
+ <a name="get-cpm-token"></a>
197
+ #### CPMトークンの状態取得
198
+ CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
199
+ ```ruby
200
+ response = $client.send(Pokepay::Request::GetCpmToken.new(
201
+ "EKYDjBWPKCwbirzvScUvjs" # cpm_token: CPMトークン
202
+ ))
203
+ ```
204
+
205
+ ---
206
+ `cpm_token`
207
+ ```json
208
+ {
209
+ "type": "string",
210
+ "minLength": 22,
211
+ "maxLength": 22
212
+ }
213
+ ```
214
+ CPM取引時にエンドユーザーが店舗に提示するバーコードを解析して得られる22桁の文字列です。
215
+
216
+ ---
217
+ 成功したときは[CpmToken](#cpm-token)オブジェクトを返します
180
218
  <a name="list-transactions"></a>
181
219
  #### 取引履歴を取得する
182
220
  取引一覧を返します。
183
221
  ```ruby
184
222
  response = $client.send(Pokepay::Request::ListTransactions.new(
185
- from: "2019-11-15T06:49:18.000000+09:00", # 開始日時
186
- to: "2017-11-14T20:55:11.000000+09:00", # 終了日時
223
+ from: "2023-06-11T07:51:21.000000+09:00", # 開始日時
224
+ to: "2022-06-22T01:22:59.000000+09:00", # 終了日時
187
225
  page: 1, # ページ番号
188
226
  per_page: 50, # 1ページ分の取引数
189
227
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
@@ -390,10 +428,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
390
428
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
391
429
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
392
430
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
393
- money_amount: 2372,
394
- point_amount: 450,
395
- point_expires_at: "2023-01-18T09:59:31.000000+09:00", # ポイント有効期限
396
- description: "WPKCwbirzvScUvjsqVkcSInvOjFPIL9qlVMwg0ANEHCj5eM805Swtsg2NkJB"
431
+ money_amount: 4169,
432
+ point_amount: 2565,
433
+ point_expires_at: "2022-07-08T13:32:38.000000+09:00", # ポイント有効期限
434
+ description: "jFPIL9qlVMwg0ANEHCj5eM805Swtsg2NkJBDvuxWoqdLq3QmHRbZpwbPRidVG7B6hajGJrCJBxTKH0YU"
397
435
  ))
398
436
  ```
399
437
 
@@ -419,10 +457,12 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
419
457
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
420
458
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
421
459
  bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
422
- money_amount: 8235, # マネー額
423
- point_amount: 2326, # ポイント額
424
- point_expires_at: "2024-09-08T13:01:58.000000+09:00", # ポイント有効期限
425
- description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
460
+ money_amount: 6743, # マネー額
461
+ point_amount: 734, # ポイント額
462
+ point_expires_at: "2025-05-30T13:08:03.000000+09:00", # ポイント有効期限
463
+ description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
464
+ metadata: "{\"key\":\"value\"}", # 取引メタデータ
465
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
426
466
  ))
427
467
  ```
428
468
 
@@ -521,6 +561,32 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
521
561
 
522
562
  任意入力で、取引履歴に表示される説明文です。
523
563
 
564
+ ---
565
+ `metadata`
566
+ ```json
567
+ {
568
+ "type": "string",
569
+ "format": "json"
570
+ }
571
+ ```
572
+ 取引作成時に指定されるメタデータです。
573
+
574
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
575
+
576
+ ---
577
+ `request_id`
578
+ ```json
579
+ {
580
+ "type": "string",
581
+ "format": "uuid"
582
+ }
583
+ ```
584
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
585
+
586
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
587
+
588
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
589
+
524
590
  ---
525
591
  成功したときは[Transaction](#transaction)オブジェクトを返します
526
592
  <a name="create-payment-transaction"></a>
@@ -533,8 +599,16 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
533
599
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
534
600
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
535
601
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
536
- 6084, # amount: 支払い額
537
- description: "たい焼き(小倉)" # 取引履歴に表示する説明文
602
+ 2221, # amount: 支払い額
603
+ description: "たい焼き(小倉)", # 取引履歴に表示する説明文
604
+ metadata: "{\"key\":\"value\"}", # 取引メタデータ
605
+ products: [{"jan_code":"abc",
606
+ "name":"name1",
607
+ "unit_price":100,
608
+ "price": 100,
609
+ "is_discounted": false,
610
+ "other":"{}"}], # 商品情報データ
611
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
538
612
  ))
539
613
  ```
540
614
 
@@ -598,6 +672,174 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
598
672
 
599
673
  任意入力で、取引履歴に表示される説明文です。
600
674
 
675
+ ---
676
+ `metadata`
677
+ ```json
678
+ {
679
+ "type": "string",
680
+ "format": "json"
681
+ }
682
+ ```
683
+ 取引作成時に指定されるメタデータです。
684
+
685
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
686
+
687
+ ---
688
+ `products`
689
+ ```json
690
+ {
691
+ "type": "array",
692
+ "items": { "type": "object" }
693
+ }
694
+ ```
695
+ 一つの取引に含まれる商品情報データです。
696
+ 以下の内容からなるJSONオブジェクトの配列で指定します。
697
+
698
+ - `jan_code`: JANコード。64字以下の文字列
699
+ - `name`: 商品名。256字以下の文字列
700
+ - `unit_price`: 商品単価。0以上の数値
701
+ - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
702
+ - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
703
+ - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
704
+
705
+ ---
706
+ `request_id`
707
+ ```json
708
+ {
709
+ "type": "string",
710
+ "format": "uuid"
711
+ }
712
+ ```
713
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
714
+
715
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
716
+
717
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
718
+
719
+ ---
720
+ 成功したときは[Transaction](#transaction)オブジェクトを返します
721
+ <a name="create-cpm-transaction"></a>
722
+ #### CPMトークンによる取引作成
723
+ CPMトークンにより取引を作成します。
724
+ CPMトークンに設定されたスコープの取引を作ることができます。
725
+
726
+ ```ruby
727
+ response = $client.send(Pokepay::Request::CreateCpmTransaction.new(
728
+ "iwJJuJPCjlaztijN3vebjT", # cpm_token: CPMトークン
729
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
730
+ 9912, # amount: 取引金額
731
+ description: "たい焼き(小倉)", # 取引説明文
732
+ metadata: "{\"key\":\"value\"}", # 店舗側メタデータ
733
+ products: [{"jan_code":"abc",
734
+ "name":"name1",
735
+ "unit_price":100,
736
+ "price": 100,
737
+ "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
+ "other":"{}"}], # 商品情報データ
749
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
750
+ ))
751
+ ```
752
+
753
+ ---
754
+ `cpm_token`
755
+ ```json
756
+ {
757
+ "type": "string",
758
+ "minLength": 22,
759
+ "maxLength": 22
760
+ }
761
+ ```
762
+ エンドユーザーによって作られ、アプリなどに表示され、店舗に対して提示される22桁の文字列です。
763
+
764
+ エンドユーザーによって許可された取引のスコープを持っています。
765
+
766
+ ---
767
+ `shop_id`
768
+ ```json
769
+ {
770
+ "type": "string",
771
+ "format": "uuid"
772
+ }
773
+ ```
774
+ 店舗IDです。
775
+
776
+ 支払いやチャージを行う店舗を指定します。
777
+
778
+ ---
779
+ `amount`
780
+ ```json
781
+ { "type": "number" }
782
+ ```
783
+ 取引金額を指定します。
784
+
785
+ 正の値を与えるとチャージになり、負の値を与えると支払いとなります。
786
+
787
+ ---
788
+ `description`
789
+ ```json
790
+ {
791
+ "type": "string",
792
+ "maxLength": 200
793
+ }
794
+ ```
795
+ 取引説明文です。
796
+
797
+ エンドユーザーアプリの取引履歴などに表示されます。
798
+
799
+ ---
800
+ `metadata`
801
+ ```json
802
+ {
803
+ "type": "string",
804
+ "format": "json"
805
+ }
806
+ ```
807
+ 取引作成時に店舗側から指定されるメタデータです。
808
+
809
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
810
+
811
+ ---
812
+ `products`
813
+ ```json
814
+ {
815
+ "type": "array",
816
+ "items": { "type": "object" }
817
+ }
818
+ ```
819
+ 一つの取引に含まれる商品情報データです。
820
+ 以下の内容からなるJSONオブジェクトの配列で指定します。
821
+
822
+ - `jan_code`: JANコード。64字以下の文字列
823
+ - `name`: 商品名。256字以下の文字列
824
+ - `unit_price`: 商品単価。0以上の数値
825
+ - `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
826
+ - `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
827
+ - `other`: その他商品に関する情報。JSONオブジェクトで指定します。
828
+
829
+ ---
830
+ `request_id`
831
+ ```json
832
+ {
833
+ "type": "string",
834
+ "format": "uuid"
835
+ }
836
+ ```
837
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
838
+
839
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
840
+
841
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
842
+
601
843
  ---
602
844
  成功したときは[Transaction](#transaction)オブジェクトを返します
603
845
  <a name="create-transfer-transaction"></a>
@@ -610,8 +852,10 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
610
852
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
611
853
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
612
854
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
613
- 9336, # amount: 送金額
614
- description: "たい焼き(小倉)" # 取引履歴に表示する説明文
855
+ 1306, # amount: 送金額
856
+ metadata: "{\"key\":\"value\"}", # 取引メタデータ
857
+ description: "たい焼き(小倉)", # 取引履歴に表示する説明文
858
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
615
859
  ))
616
860
  ```
617
861
 
@@ -663,6 +907,18 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
663
907
 
664
908
  送金するマネー額を指定します。
665
909
 
910
+ ---
911
+ `metadata`
912
+ ```json
913
+ {
914
+ "type": "string",
915
+ "format": "json"
916
+ }
917
+ ```
918
+ 取引作成時に指定されるメタデータです。
919
+
920
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
921
+
666
922
  ---
667
923
  `description`
668
924
  ```json
@@ -675,6 +931,20 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
675
931
 
676
932
  任意入力で、取引履歴に表示される説明文です。
677
933
 
934
+ ---
935
+ `request_id`
936
+ ```json
937
+ {
938
+ "type": "string",
939
+ "format": "uuid"
940
+ }
941
+ ```
942
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
943
+
944
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
945
+
946
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
947
+
678
948
  ---
679
949
  成功したときは[Transaction](#transaction)オブジェクトを返します
680
950
  <a name="create-exchange-transaction"></a>
@@ -684,10 +954,27 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
684
954
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
685
955
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
686
956
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
687
- 7953,
688
- description: "WoqdLq3QmHRbZpwbPRidVG7B6hajGJrCJBxTKH0Y"
957
+ 9015,
958
+ description: "9RjYRPCqvnZ1YzdrhG",
959
+ request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
689
960
  ))
690
961
  ```
962
+
963
+ ---
964
+ `request_id`
965
+ ```json
966
+ {
967
+ "type": "string",
968
+ "format": "uuid"
969
+ }
970
+ ```
971
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
972
+
973
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
974
+
975
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
976
+
977
+ ---
691
978
  成功したときは[Transaction](#transaction)オブジェクトを返します
692
979
  <a name="get-transaction"></a>
693
980
  #### 取引情報を取得する
@@ -713,7 +1000,14 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
713
1000
  ---
714
1001
  成功したときは[Transaction](#transaction)オブジェクトを返します
715
1002
  <a name="refund-transaction"></a>
716
- #### 返金する
1003
+ #### 取引をキャンセルする
1004
+ 取引IDを指定して取引をキャンセルします。
1005
+
1006
+ 発行体の管理者は自組織の直営店、または発行しているマネーの決済加盟店組織での取引をキャンセルできます。
1007
+ キャンセル対象の取引に付随するポイント還元キャンペーンやクーポン適用も取り消されます。
1008
+
1009
+ チャージ取引のキャンセル時に返金すべき残高が足りないときは `account_balance_not_enough (422)` エラーが返ります。
1010
+ 取引をキャンセルできるのは1回きりです。既にキャンセルされた取引を重ねてキャンセルしようとすると `transaction_already_refunded (422)` エラーが返ります。
717
1011
  ```ruby
718
1012
  response = $client.send(Pokepay::Request::RefundTransaction.new(
719
1013
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
@@ -725,19 +1019,19 @@ response = $client.send(Pokepay::Request::RefundTransaction.new(
725
1019
  ####
726
1020
  ```ruby
727
1021
  response = $client.send(Pokepay::Request::ListTransfers.new(
728
- from: "2021-03-24T05:27:59.000000+09:00",
729
- to: "2025-05-30T13:08:03.000000+09:00",
730
- page: 2222,
731
- per_page: 5540,
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,
732
1026
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
733
- shop_name: "8iwJJuJPCjlaztijN3vebjT869RjYRPCqvnZ1YzdrhGH7XKNoGDpqqjYUa42NN7jWbTA8sT9CjYdhYyR9ZtWhMAKSZHQ2Tjahc0hASAcEibjku1fdQetgL0O7DlAFrkXVihIdQWu7J4NYirXryPP6taqbm6hsnA9hELkacVB4dzDqQ1LbTyVIgVP7fIz1xemnrDx9P7HPwLX5lwWZKuWWf4n5wNPq2rj",
1027
+ shop_name: "GDpqqjYUa42NN7jWbTA8sT9CjYdhYyR9ZtWhMAKSZHQ2Tja",
734
1028
  customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
735
- customer_name: "28QfQLnQ9Qr2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCpNJGZG6LzTWIbd8ZNVrafdiivNn4NbNLXIdoiqtrelImUNmLeKEfXUc2dQExu22E4bXnTsrAuXzcUztcjpDcIzv8TjKb1dIcQKtgPEpt9Ynsu0LI4T70lQwB453YpOK96EoFGxVJNTeRlFM4Xw2YneFRtau24yc1kus",
1029
+ customer_name: "hc0hASAcEibjku1fdQetgL0O7DlAFrkXVihIdQWu7J4NYirXryPP6taqbm6hsnA9hELkacVB4dzDqQ1LbTyVIgVP7fIz1xemnrDx9P7HPwLX5lwWZKuWWf4n5wNPq2rjN28QfQLnQ9Qr2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCp",
736
1030
  transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
737
1031
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
738
1032
  is_modified: true,
739
- transaction_types: ["exchange", "transfer", "topup"],
740
- transfer_types: ["transfer"], # 取引明細の種類でフィルターします。
1033
+ transaction_types: ["transfer"],
1034
+ transfer_types: ["coupon"], # 取引明細の種類でフィルターします。
741
1035
  description: "店頭QRコードによる支払い" # 取引詳細説明文
742
1036
  ))
743
1037
  ```
@@ -845,19 +1139,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
845
1139
  支払いQRコード一覧を表示します。
846
1140
  ```ruby
847
1141
  response = $client.send(Pokepay::Request::ListBills.new(
848
- page: 4039, # ページ番号
849
- per_page: 6790, # 1ページの表示数
850
- bill_id: "HNP", # 支払いQRコードのID
1142
+ page: 2359, # ページ番号
1143
+ per_page: 9119, # 1ページの表示数
1144
+ bill_id: "WIbd8", # 支払いQRコードのID
851
1145
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
852
- organization_code: "-v-7TmsnnC4-N1Sa1H", # 組織コード
1146
+ organization_code: "U5j-HH14BbFT54v-4FDv-si", # 組織コード
853
1147
  description: "test bill", # 取引説明文
854
- created_from: "2018-10-12T16:21:05.000000+09:00", # 作成日時(起点)
855
- created_to: "2021-01-23T14:16:21.000000+09:00", # 作成日時(終点)
1148
+ created_from: "2023-07-11T01:18:59.000000+09:00", # 作成日時(起点)
1149
+ created_to: "2018-10-19T23:38:10.000000+09:00", # 作成日時(終点)
856
1150
  shop_name: "bill test shop1", # 店舗名
857
1151
  shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
858
- lower_limit_amount: 9962, # 金額の範囲によるフィルタ(下限)
859
- upper_limit_amount: 7245, # 金額の範囲によるフィルタ(上限)
860
- is_disabled: false # 支払いQRコードが無効化されているかどうか
1152
+ lower_limit_amount: 5189, # 金額の範囲によるフィルタ(下限)
1153
+ upper_limit_amount: 1460, # 金額の範囲によるフィルタ(上限)
1154
+ is_disabled: true # 支払いQRコードが無効化されているかどうか
861
1155
  ))
862
1156
  ```
863
1157
 
@@ -1001,7 +1295,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
1001
1295
  response = $client.send(Pokepay::Request::CreateBill.new(
1002
1296
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
1003
1297
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
1004
- amount: 1206, # 支払い額
1298
+ amount: 7969, # 支払い額
1005
1299
  description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
1006
1300
  ))
1007
1301
  ```
@@ -1025,9 +1319,9 @@ response = $client.send(Pokepay::Request::CreateBill.new(
1025
1319
  ```ruby
1026
1320
  response = $client.send(Pokepay::Request::UpdateBill.new(
1027
1321
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
1028
- amount: 2363, # 支払い額
1322
+ amount: 9387, # 支払い額
1029
1323
  description: "test bill", # 説明文
1030
- is_disabled: false # 無効化されているかどうか
1324
+ is_disabled: true # 無効化されているかどうか
1031
1325
  ))
1032
1326
  ```
1033
1327
 
@@ -1090,9 +1384,9 @@ Cashtrayを作成します。
1090
1384
  response = $client.send(Pokepay::Request::CreateCashtray.new(
1091
1385
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1092
1386
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
1093
- 2185, # amount: 金額
1387
+ 4206, # amount: 金額
1094
1388
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
1095
- expires_in: 4327 # 失効時間(秒)
1389
+ expires_in: 2971 # 失効時間(秒)
1096
1390
  ))
1097
1391
  ```
1098
1392
 
@@ -1253,9 +1547,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
1253
1547
  ```ruby
1254
1548
  response = $client.send(Pokepay::Request::UpdateCashtray.new(
1255
1549
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
1256
- amount: 3700, # 金額
1550
+ amount: 4180, # 金額
1257
1551
  description: "たい焼き(小倉)", # 取引履歴に表示する説明文
1258
- expires_in: 8713 # 失効時間(秒)
1552
+ expires_in: 5017 # 失効時間(秒)
1259
1553
  ))
1260
1554
  ```
1261
1555
 
@@ -1361,10 +1655,10 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
1361
1655
  ```ruby
1362
1656
  response = $client.send(Pokepay::Request::ListAccountBalances.new(
1363
1657
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
1364
- page: 7958, # ページ番号
1365
- per_page: 233, # 1ページ分の取引数
1366
- expires_at_from: "2023-04-12T23:21:21.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1367
- expires_at_to: "2024-10-10T05:42:51.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
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", # 有効期限の期間によるフィルター(終了時点)
1368
1662
  direction: "asc" # 有効期限によるソート順序
1369
1663
  ))
1370
1664
  ```
@@ -1439,11 +1733,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
1439
1733
  ```ruby
1440
1734
  response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
1441
1735
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
1442
- page: 7656, # ページ番号
1443
- per_page: 4892, # 1ページ分の取引数
1444
- expires_at_from: "2020-01-19T11:53:20.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
1445
- expires_at_to: "2021-08-17T13:01:31.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
1446
- direction: "desc" # 有効期限によるソート順序
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", # 有効期限の期間によるフィルター(終了時点)
1740
+ direction: "asc" # 有効期限によるソート順序
1447
1741
  ))
1448
1742
  ```
1449
1743
 
@@ -1517,11 +1811,14 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
1517
1811
  ```ruby
1518
1812
  response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
1519
1813
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1520
- page: 6897, # ページ番号
1521
- per_page: 7778, # 1ページ分のウォレット数
1522
- created_at_from: "2024-10-01T15:15:39.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1523
- created_at_to: "2016-09-16T11:22:10.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
1524
- is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
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", # ウォレット作成日によるフィルター(終了時点)
1818
+ is_suspended: false, # ウォレットが凍結状態かどうかでフィルターする
1819
+ external_id: "Izv8TjKb1dIcQKtgPEpt9Ynsu0LI4", # 外部ID
1820
+ tel: "01172-559", # エンドユーザーの電話番号
1821
+ email: "3YpOK96EoF@GxVJ.com" # エンドユーザーのメールアドレス
1525
1822
  ))
1526
1823
  ```
1527
1824
 
@@ -1584,6 +1881,36 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
1584
1881
  ```
1585
1882
  このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
1586
1883
 
1884
+ ---
1885
+ `external_id`
1886
+ ```json
1887
+ {
1888
+ "type": "string",
1889
+ "maxLength": 50
1890
+ }
1891
+ ```
1892
+ 外部IDでのフィルタリングです。デフォルトでは未指定です。
1893
+
1894
+ ---
1895
+ `tel`
1896
+ ```json
1897
+ {
1898
+ "type": "string",
1899
+ "pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
1900
+ }
1901
+ ```
1902
+ エンドユーザーの電話番号でのフィルタリングです。デフォルトでは未指定です。
1903
+
1904
+ ---
1905
+ `email`
1906
+ ```json
1907
+ {
1908
+ "type": "string",
1909
+ "format": "email"
1910
+ }
1911
+ ```
1912
+ エンドユーザーのメールアドレスでのフィルタリングです。デフォルトでは未指定です。
1913
+
1587
1914
  ---
1588
1915
  成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
1589
1916
  <a name="create-customer-account"></a>
@@ -1593,7 +1920,8 @@ response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
1593
1920
  response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
1594
1921
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1595
1922
  user_name: "ポケペイ太郎", # ユーザー名
1596
- account_name: "ポケペイ太郎のアカウント" # アカウント名
1923
+ account_name: "ポケペイ太郎のアカウント", # アカウント名
1924
+ external_id: "NTeRlFM4Xw2YneFRtau24yc1kusN7qW2yhhPFbHNPhRgn" # 外部ID
1597
1925
  ))
1598
1926
  ```
1599
1927
 
@@ -1629,6 +1957,16 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
1629
1957
  ```
1630
1958
  作成するウォレット名です。省略した場合は空文字となります。
1631
1959
 
1960
+ ---
1961
+ `external_id`
1962
+ ```json
1963
+ {
1964
+ "type": "string",
1965
+ "maxLength": 50
1966
+ }
1967
+ ```
1968
+ PAPIクライアントシステムから利用するPokepayユーザーのIDです。デフォルトでは未指定です。
1969
+
1632
1970
  ---
1633
1971
  成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
1634
1972
  <a name="get-shop-accounts"></a>
@@ -1637,10 +1975,10 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
1637
1975
  ```ruby
1638
1976
  response = $client.send(Pokepay::Request::GetShopAccounts.new(
1639
1977
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1640
- page: 4421, # ページ番号
1641
- per_page: 9305, # 1ページ分のウォレット数
1642
- created_at_from: "2023-06-03T12:27:49.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
1643
- created_at_to: "2016-01-17T12:47:37.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
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", # ウォレット作成日によるフィルター(終了時点)
1644
1982
  is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
1645
1983
  ))
1646
1984
  ```
@@ -1714,10 +2052,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
1714
2052
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
1715
2053
  sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
1716
2054
  receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
1717
- type: "yMo26iq", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
1718
- is_modified: false, # キャンセル済みかどうか
1719
- from: "2019-06-30T23:11:41.000000+09:00", # 開始日時
1720
- to: "2024-04-19T00:57:24.000000+09:00", # 終了日時
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", # 終了日時
1721
2059
  page: 1, # ページ番号
1722
2060
  per_page: 50 # 1ページ分の取引数
1723
2061
  ))
@@ -1842,11 +2180,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
1842
2180
  organization_code: "pocketchange", # 組織コード
1843
2181
  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
1844
2182
  name: "oxスーパー三田店", # 店舗名
1845
- postal_code: "9061434", # 店舗の郵便番号
2183
+ postal_code: "6729142", # 店舗の郵便番号
1846
2184
  address: "東京都港区芝...", # 店舗の住所
1847
- tel: "036-858434", # 店舗の電話番号
1848
- email: "x6Ov6eGwjQ@Cqxd.com", # 店舗のメールアドレス
1849
- external_id: "tQnDY", # 店舗の外部ID
2185
+ tel: "05-7934492", # 店舗の電話番号
2186
+ email: "jt9M12BOno@1Acj.com", # 店舗のメールアドレス
2187
+ external_id: "M96oftC7mHhiSDgXKvVy5paxKD2XcOfyMo2", # 店舗の外部ID
1850
2188
  page: 1, # ページ番号
1851
2189
  per_page: 50 # 1ページ分の取引数
1852
2190
  ))
@@ -1971,11 +2309,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
1971
2309
  ```ruby
1972
2310
  response = $client.send(Pokepay::Request::CreateShop.new(
1973
2311
  "oxスーパー三田店", # shop_name: 店舗名
1974
- shop_postal_code: "4391483", # 店舗の郵便番号
2312
+ shop_postal_code: "2691189", # 店舗の郵便番号
1975
2313
  shop_address: "東京都港区芝...", # 店舗の住所
1976
- shop_tel: "088152-979", # 店舗の電話番号
1977
- shop_email: "CsXRcUZY47@cpIh.com", # 店舗のメールアドレス
1978
- shop_external_id: "03BvqB7CzLjYHoO28zEE65UlKtMCe12", # 店舗の外部ID
2314
+ shop_tel: "0643430858", # 店舗の電話番号
2315
+ shop_email: "x6Ov6eGwjQ@Cqxd.com", # 店舗のメールアドレス
2316
+ shop_external_id: "tQnDY", # 店舗の外部ID
1979
2317
  organization_code: "ox-supermarket" # 組織コード
1980
2318
  ))
1981
2319
  ```
@@ -1985,14 +2323,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
1985
2323
  ```ruby
1986
2324
  response = $client.send(Pokepay::Request::CreateShopV2.new(
1987
2325
  "oxスーパー三田店", # name: 店舗名
1988
- postal_code: "891-6024", # 店舗の郵便番号
2326
+ postal_code: "4391483", # 店舗の郵便番号
1989
2327
  address: "東京都港区芝...", # 店舗の住所
1990
- tel: "0224-585", # 店舗の電話番号
1991
- email: "WnFZLX87qt@edPz.com", # 店舗のメールアドレス
1992
- external_id: "8NdiYCurcmVOPZzwMWHgQ0V", # 店舗の外部ID
2328
+ tel: "088152-979", # 店舗の電話番号
2329
+ email: "CsXRcUZY47@cpIh.com", # 店舗のメールアドレス
2330
+ external_id: "03BvqB7CzLjYHoO28zEE65UlKtMCe12", # 店舗の外部ID
1993
2331
  organization_code: "ox-supermarket", # 組織コード
1994
- private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
1995
- can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
2332
+ private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2333
+ can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
1996
2334
  ))
1997
2335
  ```
1998
2336
 
@@ -2063,13 +2401,13 @@ response = $client.send(Pokepay::Request::GetShop.new(
2063
2401
  response = $client.send(Pokepay::Request::UpdateShop.new(
2064
2402
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
2065
2403
  name: "oxスーパー三田店", # 店舗名
2066
- postal_code: "486-3690", # 店舗の郵便番号
2404
+ postal_code: "891-6024", # 店舗の郵便番号
2067
2405
  address: "東京都港区芝...", # 店舗の住所
2068
- tel: "02-924308", # 店舗の電話番号
2069
- email: "TSynCfTiWL@EN2p.com", # 店舗のメールアドレス
2070
- external_id: "E", # 店舗の外部ID
2071
- private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2072
- can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
2406
+ tel: "0224-585", # 店舗の電話番号
2407
+ email: "WnFZLX87qt@edPz.com", # 店舗のメールアドレス
2408
+ external_id: "8NdiYCurcmVOPZzwMWHgQ0V", # 店舗の外部ID
2409
+ private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
2410
+ can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
2073
2411
  ))
2074
2412
  ```
2075
2413
 
@@ -2186,7 +2524,7 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
2186
2524
  指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
2187
2525
 
2188
2526
  ---
2189
- 成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
2527
+ 成功したときは[PaginatedAccountDetails](#paginated-account-details)オブジェクトを返します
2190
2528
  ### Private Money
2191
2529
  <a name="get-private-moneys"></a>
2192
2530
  #### マネー一覧を取得する
@@ -2219,8 +2557,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
2219
2557
  ```ruby
2220
2558
  response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
2221
2559
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
2222
- from: "2016-09-20T16:43:03.000000+09:00", # 開始日時(toと同時に指定する必要有)
2223
- to: "2019-10-20T11:06:22.000000+09:00", # 終了日時(fromと同時に指定する必要有)
2560
+ from: "2024-01-30T11:08:00.000000+09:00", # 開始日時(toと同時に指定する必要有)
2561
+ to: "2023-12-25T17:27:23.000000+09:00", # 終了日時(fromと同時に指定する必要有)
2224
2562
  page: 1, # ページ番号
2225
2563
  per_page: 50 # 1ページ分の取引数
2226
2564
  ))
@@ -2234,10 +2572,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
2234
2572
  CSVファイルから一括取引をします。
2235
2573
  ```ruby
2236
2574
  response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2237
- "B8PVJkE9NzaeTptZ5kX9rLpagdWQ", # name: 一括取引タスク名
2238
- "E", # content: 取引する情報のCSV
2239
- "nTlLyubwibc5uG9Y4cn6ApRZ5NX6gFb5nuOD", # request_id: リクエストID
2240
- description: "mm9rpn022H3wQmNFzbLFmfFSz1uperYHhU5vbLxW8Yq15XpRuu89q3NykiRPYO2oQiAYMcKkXBWEu4RSjxgCW3jFlgob7yobgqdqFleVhpCeb" # 一括取引の説明
2575
+ "pW9b9NBdcz", # name: 一括取引タスク名
2576
+ "T", # content: 取引する情報のCSV
2577
+ "SynCfTiWLEN2pEbq7ZeB8PVJkE9NzaeTptZ5", # request_id: リクエストID
2578
+ description: "kX9rLpagdWQnEnTlLyubwibc5uG9Y4cn6ApRZ5NX6g" # 一括取引の説明
2241
2579
  ))
2242
2580
  ```
2243
2581
 
@@ -2326,9 +2664,12 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2326
2664
  * `money_balance (double)`:
2327
2665
  * `point_balance (double)`:
2328
2666
  * `private_money (PrivateMoney)`:
2667
+ * `user (User)`:
2329
2668
 
2330
2669
  `private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
2331
2670
 
2671
+ `user`は [User](#user) オブジェクトを返します。
2672
+
2332
2673
  <a name="bill"></a>
2333
2674
  ## Bill
2334
2675
  * `id (string)`: 支払いQRコードのID
@@ -2342,6 +2683,22 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2342
2683
 
2343
2684
  `account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
2344
2685
 
2686
+ <a name="cpm-token"></a>
2687
+ ## CpmToken
2688
+ * `cpm_token (string)`:
2689
+ * `account (AccountDetail)`:
2690
+ * `transaction (Transaction)`:
2691
+ * `event (ExternalTransaction)`:
2692
+ * `scopes (array of strings)`: 許可された取引種別
2693
+ * `expires_at (string)`: CPMトークンの失効日時
2694
+ * `metadata (string)`: エンドユーザー側メタデータ
2695
+
2696
+ `account`は [AccountDetail](#account-detail) オブジェクトを返します。
2697
+
2698
+ `transaction`は [Transaction](#transaction) オブジェクトを返します。
2699
+
2700
+ `event`は [ExternalTransaction](#external-transaction) オブジェクトを返します。
2701
+
2345
2702
  <a name="cashtray"></a>
2346
2703
  ## Cashtray
2347
2704
  * `id (string)`: Cashtray自体のIDです。
@@ -2453,23 +2810,23 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2453
2810
 
2454
2811
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
2455
2812
 
2456
- <a name="paginated-accounts"></a>
2457
- ## PaginatedAccounts
2458
- * `rows (array of Accounts)`:
2813
+ <a name="paginated-account-with-users"></a>
2814
+ ## PaginatedAccountWithUsers
2815
+ * `rows (array of AccountWithUsers)`:
2459
2816
  * `count (integer)`:
2460
2817
  * `pagination (Pagination)`:
2461
2818
 
2462
- `rows`は [Account](#account) オブジェクトの配列を返します。
2819
+ `rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
2463
2820
 
2464
2821
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
2465
2822
 
2466
- <a name="paginated-account-with-users"></a>
2467
- ## PaginatedAccountWithUsers
2468
- * `rows (array of AccountWithUsers)`:
2823
+ <a name="paginated-account-details"></a>
2824
+ ## PaginatedAccountDetails
2825
+ * `rows (array of AccountDetails)`:
2469
2826
  * `count (integer)`:
2470
2827
  * `pagination (Pagination)`:
2471
2828
 
2472
- `rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
2829
+ `rows`は [AccountDetail](#account-detail) オブジェクトの配列を返します。
2473
2830
 
2474
2831
  `pagination`は [Pagination](#pagination) オブジェクトを返します。
2475
2832
 
@@ -2530,6 +2887,22 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
2530
2887
 
2531
2888
  `organization`は [Organization](#organization) オブジェクトを返します。
2532
2889
 
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
+
2533
2906
  <a name="cashtray-attempt"></a>
2534
2907
  ## CashtrayAttempt
2535
2908
  * `account (AccountWithUser)`: エンドユーザーのウォレット