pokepay_partner_ruby_sdk 0.1.10 → 0.1.14
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -1
- data/docs/index.md +430 -87
- data/lib/pokepay_partner_ruby_sdk/request/get_customer_accounts.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_shop_accounts.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/request/refund_transaction.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb +3 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_account_details.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +4 -0
- data/partner.yaml +275 -9
- metadata +6 -2
data/docs/index.md
CHANGED
|
@@ -149,6 +149,7 @@ response.body
|
|
|
149
149
|
- [CreateTransferTransaction](#create-transfer-transaction): 個人間送金
|
|
150
150
|
- [CreateExchangeTransaction](#create-exchange-transaction):
|
|
151
151
|
- [GetTransaction](#get-transaction): 取引情報を取得する
|
|
152
|
+
- [RefundTransaction](#refund-transaction): 返金する
|
|
152
153
|
- [ListTransfers](#list-transfers):
|
|
153
154
|
- [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
|
|
154
155
|
- [ListBills](#list-bills): 支払いQRコード一覧を表示する
|
|
@@ -162,7 +163,9 @@ response.body
|
|
|
162
163
|
- [UpdateAccount](#update-account): ウォレット情報を更新する
|
|
163
164
|
- [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
|
|
164
165
|
- [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
|
|
166
|
+
- [GetCustomerAccounts](#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
|
|
165
167
|
- [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーウォレットを追加する
|
|
168
|
+
- [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
|
|
166
169
|
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
|
167
170
|
- [ListShops](#list-shops): 店舗一覧を取得する
|
|
168
171
|
- [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
|
|
@@ -179,8 +182,8 @@ response.body
|
|
|
179
182
|
取引一覧を返します。
|
|
180
183
|
```ruby
|
|
181
184
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
182
|
-
from: "
|
|
183
|
-
to: "
|
|
185
|
+
from: "2017-05-10T09:01:07.000000+09:00", # 開始日時
|
|
186
|
+
to: "2017-02-12T17:02:56.000000+09:00", # 終了日時
|
|
184
187
|
page: 1, # ページ番号
|
|
185
188
|
per_page: 50, # 1ページ分の取引数
|
|
186
189
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
@@ -190,8 +193,9 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
|
190
193
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
|
|
191
194
|
organization_code: "pocketchange", # 組織コード
|
|
192
195
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
193
|
-
is_modified:
|
|
194
|
-
types: ["topup", "payment"]
|
|
196
|
+
is_modified: false, # キャンセルフラグ
|
|
197
|
+
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
198
|
+
description: "店頭QRコードによる支払い" # 取引説明文
|
|
195
199
|
))
|
|
196
200
|
```
|
|
197
201
|
|
|
@@ -364,6 +368,18 @@ response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
|
364
368
|
4. exchange-inflow
|
|
365
369
|
他マネーからの流入
|
|
366
370
|
|
|
371
|
+
---
|
|
372
|
+
`description`
|
|
373
|
+
```json
|
|
374
|
+
{
|
|
375
|
+
"type": "string",
|
|
376
|
+
"maxLength": 200
|
|
377
|
+
}
|
|
378
|
+
```
|
|
379
|
+
取引を指定の取引説明文でフィルターします。
|
|
380
|
+
|
|
381
|
+
取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
|
|
382
|
+
|
|
367
383
|
---
|
|
368
384
|
成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
|
|
369
385
|
<a name="create-transaction"></a>
|
|
@@ -374,10 +390,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
|
374
390
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
375
391
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
376
392
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
377
|
-
money_amount:
|
|
378
|
-
point_amount:
|
|
379
|
-
point_expires_at: "2024-
|
|
380
|
-
description: "
|
|
393
|
+
money_amount: 5545,
|
|
394
|
+
point_amount: 6708,
|
|
395
|
+
point_expires_at: "2024-02-06T11:02:52.000000+09:00", # ポイント有効期限
|
|
396
|
+
description: "CafuN856J50SdiADG37eydGENMPuSUGCPNHip0"
|
|
381
397
|
))
|
|
382
398
|
```
|
|
383
399
|
|
|
@@ -403,10 +419,11 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
403
419
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
404
420
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
405
421
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
406
|
-
money_amount:
|
|
407
|
-
point_amount:
|
|
408
|
-
point_expires_at: "
|
|
409
|
-
description: "初夏のチャージキャンペーン"
|
|
422
|
+
money_amount: 7001, # マネー額
|
|
423
|
+
point_amount: 650, # ポイント額
|
|
424
|
+
point_expires_at: "2018-05-18T16:46:21.000000+09:00", # ポイント有効期限
|
|
425
|
+
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
|
426
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
410
427
|
))
|
|
411
428
|
```
|
|
412
429
|
|
|
@@ -505,6 +522,20 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
|
505
522
|
|
|
506
523
|
任意入力で、取引履歴に表示される説明文です。
|
|
507
524
|
|
|
525
|
+
---
|
|
526
|
+
`request_id`
|
|
527
|
+
```json
|
|
528
|
+
{
|
|
529
|
+
"type": "string",
|
|
530
|
+
"format": "uuid"
|
|
531
|
+
}
|
|
532
|
+
```
|
|
533
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
|
534
|
+
|
|
535
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
|
536
|
+
|
|
537
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
|
538
|
+
|
|
508
539
|
---
|
|
509
540
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
510
541
|
<a name="create-payment-transaction"></a>
|
|
@@ -517,8 +548,9 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
517
548
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
518
549
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
519
550
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
520
|
-
|
|
521
|
-
description: "たい焼き(小倉)"
|
|
551
|
+
6244, # amount: 支払い額
|
|
552
|
+
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
553
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
522
554
|
))
|
|
523
555
|
```
|
|
524
556
|
|
|
@@ -582,6 +614,20 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
|
582
614
|
|
|
583
615
|
任意入力で、取引履歴に表示される説明文です。
|
|
584
616
|
|
|
617
|
+
---
|
|
618
|
+
`request_id`
|
|
619
|
+
```json
|
|
620
|
+
{
|
|
621
|
+
"type": "string",
|
|
622
|
+
"format": "uuid"
|
|
623
|
+
}
|
|
624
|
+
```
|
|
625
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
|
626
|
+
|
|
627
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
|
628
|
+
|
|
629
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
|
630
|
+
|
|
585
631
|
---
|
|
586
632
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
587
633
|
<a name="create-transfer-transaction"></a>
|
|
@@ -594,8 +640,9 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
594
640
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
595
641
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
596
642
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
597
|
-
|
|
598
|
-
description: "たい焼き(小倉)"
|
|
643
|
+
2754, # amount: 送金額
|
|
644
|
+
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
645
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
599
646
|
))
|
|
600
647
|
```
|
|
601
648
|
|
|
@@ -659,6 +706,20 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
|
659
706
|
|
|
660
707
|
任意入力で、取引履歴に表示される説明文です。
|
|
661
708
|
|
|
709
|
+
---
|
|
710
|
+
`request_id`
|
|
711
|
+
```json
|
|
712
|
+
{
|
|
713
|
+
"type": "string",
|
|
714
|
+
"format": "uuid"
|
|
715
|
+
}
|
|
716
|
+
```
|
|
717
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
|
718
|
+
|
|
719
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
|
720
|
+
|
|
721
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
|
722
|
+
|
|
662
723
|
---
|
|
663
724
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
664
725
|
<a name="create-exchange-transaction"></a>
|
|
@@ -668,10 +729,27 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
|
668
729
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
669
730
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
670
731
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
671
|
-
|
|
672
|
-
description: "
|
|
732
|
+
7140,
|
|
733
|
+
description: "Xe1sIjLSVztCspdpKcDGU85LATApzQ2dQG1XtK0UfX1fzmKZw4jAX5TdVMZA3FsBWHTaR7q8iHovbTWoPNbCUX3WmvU0lnYW7MWulxJqejEoXiemEzy22TP2wtSY9IoDSrJUA2sSTBsOwjVmr0",
|
|
734
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
|
673
735
|
))
|
|
674
736
|
```
|
|
737
|
+
|
|
738
|
+
---
|
|
739
|
+
`request_id`
|
|
740
|
+
```json
|
|
741
|
+
{
|
|
742
|
+
"type": "string",
|
|
743
|
+
"format": "uuid"
|
|
744
|
+
}
|
|
745
|
+
```
|
|
746
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
|
747
|
+
|
|
748
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
|
749
|
+
|
|
750
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
|
751
|
+
|
|
752
|
+
---
|
|
675
753
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
676
754
|
<a name="get-transaction"></a>
|
|
677
755
|
#### 取引情報を取得する
|
|
@@ -696,25 +774,83 @@ response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
|
696
774
|
|
|
697
775
|
---
|
|
698
776
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
777
|
+
<a name="refund-transaction"></a>
|
|
778
|
+
#### 返金する
|
|
779
|
+
```ruby
|
|
780
|
+
response = $client.send(Pokepay::Request::RefundTransaction.new(
|
|
781
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # transaction_id: 取引ID
|
|
782
|
+
description: "返品対応のため" # 取引履歴に表示する返金事由
|
|
783
|
+
))
|
|
784
|
+
```
|
|
785
|
+
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
699
786
|
<a name="list-transfers"></a>
|
|
700
787
|
####
|
|
701
788
|
```ruby
|
|
702
789
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
703
|
-
from: "
|
|
704
|
-
to: "
|
|
705
|
-
page:
|
|
706
|
-
per_page:
|
|
790
|
+
from: "2020-12-08T12:26:18.000000+09:00",
|
|
791
|
+
to: "2017-11-24T07:36:36.000000+09:00",
|
|
792
|
+
page: 4740,
|
|
793
|
+
per_page: 1712,
|
|
707
794
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
708
|
-
shop_name: "
|
|
795
|
+
shop_name: "79fqhITnnz7WaCAiQd9B8sle88sl7rSWKN9oQjHsNX48VkSyiuzE1L2wv36YuE4jwp0IiR44I5KLiOrRKq3qxtTGifN6KrraD5uojwDmQdLNOKHIlDiaOh78QfhNbZ3YfGhlbqaOElvScjtjkG1",
|
|
709
796
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
710
|
-
customer_name: "
|
|
797
|
+
customer_name: "WEjltqaYkhp7caXjUtBcNe9XyY4wthFo0glXBErIUB1p7aPMzXnAdDrY96Gn0OAQ9xSN0zfKx7ivixiVqjgvBNcsQLQxAtJm",
|
|
711
798
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
712
799
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
713
|
-
is_modified:
|
|
714
|
-
transaction_types: ["
|
|
715
|
-
transfer_types: ["
|
|
800
|
+
is_modified: true,
|
|
801
|
+
transaction_types: ["transfer", "payment", "topup", "exchange"],
|
|
802
|
+
transfer_types: ["exchange", "payment", "campaign", "transfer"], # 取引明細の種類でフィルターします。
|
|
803
|
+
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
716
804
|
))
|
|
717
805
|
```
|
|
806
|
+
|
|
807
|
+
---
|
|
808
|
+
`transfer_types`
|
|
809
|
+
```json
|
|
810
|
+
{
|
|
811
|
+
"type": "array",
|
|
812
|
+
"items": {
|
|
813
|
+
"type": "string",
|
|
814
|
+
"enum": {
|
|
815
|
+
"topup": "payment",
|
|
816
|
+
"exchange": "transfer",
|
|
817
|
+
"coupon": "campaign"
|
|
818
|
+
}
|
|
819
|
+
}
|
|
820
|
+
}
|
|
821
|
+
```
|
|
822
|
+
取引明細の種類でフィルターします。
|
|
823
|
+
|
|
824
|
+
以下の種類を指定できます。
|
|
825
|
+
|
|
826
|
+
1. topup
|
|
827
|
+
店舗からエンドユーザーへの送金取引(チャージ)、またはそのキャンセル取引
|
|
828
|
+
|
|
829
|
+
2. payment
|
|
830
|
+
エンドユーザーから店舗への送金取引(支払い)、またはそのキャンセル取引
|
|
831
|
+
|
|
832
|
+
3. exchange
|
|
833
|
+
他マネーへの流出/流入
|
|
834
|
+
|
|
835
|
+
4. campaign
|
|
836
|
+
取引に対するポイント還元キャンペーンによるポイント付与、またはそのキャンセル取引
|
|
837
|
+
|
|
838
|
+
5. coupon
|
|
839
|
+
クーポンによる値引き処理、またはそのキャンセル取引
|
|
840
|
+
|
|
841
|
+
---
|
|
842
|
+
`description`
|
|
843
|
+
```json
|
|
844
|
+
{
|
|
845
|
+
"type": "string",
|
|
846
|
+
"maxLength": 200
|
|
847
|
+
}
|
|
848
|
+
```
|
|
849
|
+
取引詳細を指定の取引詳細説明文でフィルターします。
|
|
850
|
+
|
|
851
|
+
取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
|
|
852
|
+
|
|
853
|
+
---
|
|
718
854
|
成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
|
|
719
855
|
### Check
|
|
720
856
|
店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
|
|
@@ -771,19 +907,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
|
771
907
|
支払いQRコード一覧を表示します。
|
|
772
908
|
```ruby
|
|
773
909
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
774
|
-
page:
|
|
775
|
-
per_page:
|
|
776
|
-
bill_id: "
|
|
910
|
+
page: 5974, # ページ番号
|
|
911
|
+
per_page: 4994, # 1ページの表示数
|
|
912
|
+
bill_id: "kNd3", # 支払いQRコードのID
|
|
777
913
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
778
|
-
organization_code: "
|
|
914
|
+
organization_code: "jUp3-N--X92Fbs--D0fn--Hx6Q-zy1", # 組織コード
|
|
779
915
|
description: "test bill", # 取引説明文
|
|
780
|
-
created_from: "
|
|
781
|
-
created_to: "
|
|
916
|
+
created_from: "2017-04-21T18:37:28.000000+09:00", # 作成日時(起点)
|
|
917
|
+
created_to: "2021-05-08T05:36:00.000000+09:00", # 作成日時(終点)
|
|
782
918
|
shop_name: "bill test shop1", # 店舗名
|
|
783
919
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
784
|
-
lower_limit_amount:
|
|
785
|
-
upper_limit_amount:
|
|
786
|
-
is_disabled:
|
|
920
|
+
lower_limit_amount: 6767, # 金額の範囲によるフィルタ(下限)
|
|
921
|
+
upper_limit_amount: 2585, # 金額の範囲によるフィルタ(上限)
|
|
922
|
+
is_disabled: false # 支払いQRコードが無効化されているかどうか
|
|
787
923
|
))
|
|
788
924
|
```
|
|
789
925
|
|
|
@@ -927,7 +1063,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
|
927
1063
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
928
1064
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
929
1065
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
930
|
-
amount:
|
|
1066
|
+
amount: 8458, # 支払い額
|
|
931
1067
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
932
1068
|
))
|
|
933
1069
|
```
|
|
@@ -951,9 +1087,9 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
|
951
1087
|
```ruby
|
|
952
1088
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
953
1089
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
954
|
-
amount:
|
|
1090
|
+
amount: 45, # 支払い額
|
|
955
1091
|
description: "test bill", # 説明文
|
|
956
|
-
is_disabled:
|
|
1092
|
+
is_disabled: false # 無効化されているかどうか
|
|
957
1093
|
))
|
|
958
1094
|
```
|
|
959
1095
|
|
|
@@ -1016,9 +1152,9 @@ Cashtrayを作成します。
|
|
|
1016
1152
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
1017
1153
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1018
1154
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1019
|
-
|
|
1155
|
+
6575, # amount: 金額
|
|
1020
1156
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1021
|
-
expires_in:
|
|
1157
|
+
expires_in: 1228 # 失効時間(秒)
|
|
1022
1158
|
))
|
|
1023
1159
|
```
|
|
1024
1160
|
|
|
@@ -1179,9 +1315,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
|
1179
1315
|
```ruby
|
|
1180
1316
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
1181
1317
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
1182
|
-
amount:
|
|
1318
|
+
amount: 7001, # 金額
|
|
1183
1319
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1184
|
-
expires_in:
|
|
1320
|
+
expires_in: 6822 # 失効時間(秒)
|
|
1185
1321
|
))
|
|
1186
1322
|
```
|
|
1187
1323
|
|
|
@@ -1287,10 +1423,10 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
|
1287
1423
|
```ruby
|
|
1288
1424
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
1289
1425
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1290
|
-
page:
|
|
1291
|
-
per_page:
|
|
1292
|
-
expires_at_from: "2023-
|
|
1293
|
-
expires_at_to: "
|
|
1426
|
+
page: 2373, # ページ番号
|
|
1427
|
+
per_page: 451, # 1ページ分の取引数
|
|
1428
|
+
expires_at_from: "2023-01-18T09:59:31.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1429
|
+
expires_at_to: "2016-09-25T04:41:30.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1294
1430
|
direction: "asc" # 有効期限によるソート順序
|
|
1295
1431
|
))
|
|
1296
1432
|
```
|
|
@@ -1365,11 +1501,11 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
|
1365
1501
|
```ruby
|
|
1366
1502
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
1367
1503
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1368
|
-
page:
|
|
1369
|
-
per_page:
|
|
1370
|
-
expires_at_from: "
|
|
1371
|
-
expires_at_to: "
|
|
1372
|
-
direction: "
|
|
1504
|
+
page: 1228, # ページ番号
|
|
1505
|
+
per_page: 7032, # 1ページ分の取引数
|
|
1506
|
+
expires_at_from: "2023-02-16T15:27:38.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1507
|
+
expires_at_to: "2025-04-18T14:51:29.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1508
|
+
direction: "asc" # 有効期限によるソート順序
|
|
1373
1509
|
))
|
|
1374
1510
|
```
|
|
1375
1511
|
|
|
@@ -1437,6 +1573,114 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
1437
1573
|
|
|
1438
1574
|
---
|
|
1439
1575
|
成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
|
|
1576
|
+
<a name="get-customer-accounts"></a>
|
|
1577
|
+
#### エンドユーザーのウォレット一覧を表示する
|
|
1578
|
+
マネーを指定してエンドユーザーのウォレット一覧を取得します。
|
|
1579
|
+
```ruby
|
|
1580
|
+
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
1581
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1582
|
+
page: 4539, # ページ番号
|
|
1583
|
+
per_page: 2772, # 1ページ分のウォレット数
|
|
1584
|
+
created_at_from: "2023-12-25T19:33:57.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1585
|
+
created_at_to: "2020-11-16T21:21:47.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1586
|
+
is_suspended: true, # ウォレットが凍結状態かどうかでフィルターする
|
|
1587
|
+
external_id: "vjsqVkcSInvOjFPIL9qlVM", # 外部ID
|
|
1588
|
+
tel: "07018335-9579", # エンドユーザーの電話番号
|
|
1589
|
+
email: "805Swtsg2N@kJBD.com" # エンドユーザーのメールアドレス
|
|
1590
|
+
))
|
|
1591
|
+
```
|
|
1592
|
+
|
|
1593
|
+
---
|
|
1594
|
+
`private_money_id`
|
|
1595
|
+
```json
|
|
1596
|
+
{
|
|
1597
|
+
"type": "string",
|
|
1598
|
+
"format": "uuid"
|
|
1599
|
+
}
|
|
1600
|
+
```
|
|
1601
|
+
マネーIDです。
|
|
1602
|
+
|
|
1603
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1604
|
+
|
|
1605
|
+
---
|
|
1606
|
+
`page`
|
|
1607
|
+
```json
|
|
1608
|
+
{
|
|
1609
|
+
"type": "integer",
|
|
1610
|
+
"minimum": 1
|
|
1611
|
+
}
|
|
1612
|
+
```
|
|
1613
|
+
取得したいページ番号です。デフォルト値は1です。
|
|
1614
|
+
|
|
1615
|
+
---
|
|
1616
|
+
`per_page`
|
|
1617
|
+
```json
|
|
1618
|
+
{
|
|
1619
|
+
"type": "integer",
|
|
1620
|
+
"minimum": 1
|
|
1621
|
+
}
|
|
1622
|
+
```
|
|
1623
|
+
1ページ分のウォレット数です。デフォルト値は30です。
|
|
1624
|
+
|
|
1625
|
+
---
|
|
1626
|
+
`created_at_from`
|
|
1627
|
+
```json
|
|
1628
|
+
{
|
|
1629
|
+
"type": "string",
|
|
1630
|
+
"format": "date-time"
|
|
1631
|
+
}
|
|
1632
|
+
```
|
|
1633
|
+
ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1634
|
+
|
|
1635
|
+
---
|
|
1636
|
+
`created_at_to`
|
|
1637
|
+
```json
|
|
1638
|
+
{
|
|
1639
|
+
"type": "string",
|
|
1640
|
+
"format": "date-time"
|
|
1641
|
+
}
|
|
1642
|
+
```
|
|
1643
|
+
ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1644
|
+
|
|
1645
|
+
---
|
|
1646
|
+
`is_suspended`
|
|
1647
|
+
```json
|
|
1648
|
+
{ "type": "boolean" }
|
|
1649
|
+
```
|
|
1650
|
+
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1651
|
+
|
|
1652
|
+
---
|
|
1653
|
+
`external_id`
|
|
1654
|
+
```json
|
|
1655
|
+
{
|
|
1656
|
+
"type": "string",
|
|
1657
|
+
"maxLength": 50
|
|
1658
|
+
}
|
|
1659
|
+
```
|
|
1660
|
+
外部IDでのフィルタリングです。デフォルトでは未指定です。
|
|
1661
|
+
|
|
1662
|
+
---
|
|
1663
|
+
`tel`
|
|
1664
|
+
```json
|
|
1665
|
+
{
|
|
1666
|
+
"type": "string",
|
|
1667
|
+
"pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
|
|
1668
|
+
}
|
|
1669
|
+
```
|
|
1670
|
+
エンドユーザーの電話番号でのフィルタリングです。デフォルトでは未指定です。
|
|
1671
|
+
|
|
1672
|
+
---
|
|
1673
|
+
`email`
|
|
1674
|
+
```json
|
|
1675
|
+
{
|
|
1676
|
+
"type": "string",
|
|
1677
|
+
"format": "email"
|
|
1678
|
+
}
|
|
1679
|
+
```
|
|
1680
|
+
エンドユーザーのメールアドレスでのフィルタリングです。デフォルトでは未指定です。
|
|
1681
|
+
|
|
1682
|
+
---
|
|
1683
|
+
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1440
1684
|
<a name="create-customer-account"></a>
|
|
1441
1685
|
#### 新規エンドユーザーウォレットを追加する
|
|
1442
1686
|
指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
|
|
@@ -1444,7 +1688,8 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
|
1444
1688
|
response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
1445
1689
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1446
1690
|
user_name: "ポケペイ太郎", # ユーザー名
|
|
1447
|
-
account_name: "ポケペイ太郎のアカウント"
|
|
1691
|
+
account_name: "ポケペイ太郎のアカウント", # アカウント名
|
|
1692
|
+
external_id: "WoqdLq3QmHRbZpwbP" # 外部ID
|
|
1448
1693
|
))
|
|
1449
1694
|
```
|
|
1450
1695
|
|
|
@@ -1480,8 +1725,93 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
|
1480
1725
|
```
|
|
1481
1726
|
作成するウォレット名です。省略した場合は空文字となります。
|
|
1482
1727
|
|
|
1728
|
+
---
|
|
1729
|
+
`external_id`
|
|
1730
|
+
```json
|
|
1731
|
+
{
|
|
1732
|
+
"type": "string",
|
|
1733
|
+
"maxLength": 50
|
|
1734
|
+
}
|
|
1735
|
+
```
|
|
1736
|
+
PAPIクライアントシステムから利用するPokepayユーザーのIDです。デフォルトでは未指定です。
|
|
1737
|
+
|
|
1483
1738
|
---
|
|
1484
1739
|
成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
|
|
1740
|
+
<a name="get-shop-accounts"></a>
|
|
1741
|
+
#### 店舗ユーザーのウォレット一覧を表示する
|
|
1742
|
+
マネーを指定して店舗ユーザーのウォレット一覧を取得します。
|
|
1743
|
+
```ruby
|
|
1744
|
+
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
1745
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1746
|
+
page: 83, # ページ番号
|
|
1747
|
+
per_page: 5866, # 1ページ分のウォレット数
|
|
1748
|
+
created_at_from: "2021-03-18T09:33:18.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1749
|
+
created_at_to: "2019-10-15T23:24:49.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1750
|
+
is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
|
|
1751
|
+
))
|
|
1752
|
+
```
|
|
1753
|
+
|
|
1754
|
+
---
|
|
1755
|
+
`private_money_id`
|
|
1756
|
+
```json
|
|
1757
|
+
{
|
|
1758
|
+
"type": "string",
|
|
1759
|
+
"format": "uuid"
|
|
1760
|
+
}
|
|
1761
|
+
```
|
|
1762
|
+
マネーIDです。
|
|
1763
|
+
|
|
1764
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1765
|
+
|
|
1766
|
+
---
|
|
1767
|
+
`page`
|
|
1768
|
+
```json
|
|
1769
|
+
{
|
|
1770
|
+
"type": "integer",
|
|
1771
|
+
"minimum": 1
|
|
1772
|
+
}
|
|
1773
|
+
```
|
|
1774
|
+
取得したいページ番号です。デフォルト値は1です。
|
|
1775
|
+
|
|
1776
|
+
---
|
|
1777
|
+
`per_page`
|
|
1778
|
+
```json
|
|
1779
|
+
{
|
|
1780
|
+
"type": "integer",
|
|
1781
|
+
"minimum": 1
|
|
1782
|
+
}
|
|
1783
|
+
```
|
|
1784
|
+
1ページ分のウォレット数です。デフォルト値は30です。
|
|
1785
|
+
|
|
1786
|
+
---
|
|
1787
|
+
`created_at_from`
|
|
1788
|
+
```json
|
|
1789
|
+
{
|
|
1790
|
+
"type": "string",
|
|
1791
|
+
"format": "date-time"
|
|
1792
|
+
}
|
|
1793
|
+
```
|
|
1794
|
+
ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1795
|
+
|
|
1796
|
+
---
|
|
1797
|
+
`created_at_to`
|
|
1798
|
+
```json
|
|
1799
|
+
{
|
|
1800
|
+
"type": "string",
|
|
1801
|
+
"format": "date-time"
|
|
1802
|
+
}
|
|
1803
|
+
```
|
|
1804
|
+
ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1805
|
+
|
|
1806
|
+
---
|
|
1807
|
+
`is_suspended`
|
|
1808
|
+
```json
|
|
1809
|
+
{ "type": "boolean" }
|
|
1810
|
+
```
|
|
1811
|
+
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1812
|
+
|
|
1813
|
+
---
|
|
1814
|
+
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1485
1815
|
<a name="list-customer-transactions"></a>
|
|
1486
1816
|
#### 取引履歴を取得する
|
|
1487
1817
|
取引一覧を返します。
|
|
@@ -1490,10 +1820,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
1490
1820
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1491
1821
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
1492
1822
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
1493
|
-
type: "
|
|
1494
|
-
is_modified:
|
|
1495
|
-
from: "
|
|
1496
|
-
to: "
|
|
1823
|
+
type: "B6hajGJrCJ", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
|
|
1824
|
+
is_modified: true, # キャンセル済みかどうか
|
|
1825
|
+
from: "2019-02-13T12:10:46.000000+09:00", # 開始日時
|
|
1826
|
+
to: "2017-02-20T06:05:40.000000+09:00", # 終了日時
|
|
1497
1827
|
page: 1, # ページ番号
|
|
1498
1828
|
per_page: 50 # 1ページ分の取引数
|
|
1499
1829
|
))
|
|
@@ -1618,11 +1948,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
1618
1948
|
organization_code: "pocketchange", # 組織コード
|
|
1619
1949
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1620
1950
|
name: "oxスーパー三田店", # 店舗名
|
|
1621
|
-
postal_code: "
|
|
1951
|
+
postal_code: "800-9576", # 店舗の郵便番号
|
|
1622
1952
|
address: "東京都港区芝...", # 店舗の住所
|
|
1623
|
-
tel: "
|
|
1624
|
-
email: "
|
|
1625
|
-
external_id: "
|
|
1953
|
+
tel: "089682-5023", # 店舗の電話番号
|
|
1954
|
+
email: "jlaztijN3v@ebjT.com", # 店舗のメールアドレス
|
|
1955
|
+
external_id: "69RjYRPCqvnZ1YzdrhGH7XKNoGDpqqjY", # 店舗の外部ID
|
|
1626
1956
|
page: 1, # ページ番号
|
|
1627
1957
|
per_page: 50 # 1ページ分の取引数
|
|
1628
1958
|
))
|
|
@@ -1747,11 +2077,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
|
1747
2077
|
```ruby
|
|
1748
2078
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
1749
2079
|
"oxスーパー三田店", # shop_name: 店舗名
|
|
1750
|
-
shop_postal_code: "
|
|
2080
|
+
shop_postal_code: "5142087", # 店舗の郵便番号
|
|
1751
2081
|
shop_address: "東京都港区芝...", # 店舗の住所
|
|
1752
|
-
shop_tel: "
|
|
1753
|
-
shop_email: "
|
|
1754
|
-
shop_external_id: "
|
|
2082
|
+
shop_tel: "0074-18354932", # 店舗の電話番号
|
|
2083
|
+
shop_email: "YdhYyR9ZtW@hMAK.com", # 店舗のメールアドレス
|
|
2084
|
+
shop_external_id: "ZHQ2Tjahc0hASAcEibjk", # 店舗の外部ID
|
|
1755
2085
|
organization_code: "ox-supermarket" # 組織コード
|
|
1756
2086
|
))
|
|
1757
2087
|
```
|
|
@@ -1761,14 +2091,14 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
|
1761
2091
|
```ruby
|
|
1762
2092
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
1763
2093
|
"oxスーパー三田店", # name: 店舗名
|
|
1764
|
-
postal_code: "
|
|
2094
|
+
postal_code: "5184159", # 店舗の郵便番号
|
|
1765
2095
|
address: "東京都港区芝...", # 店舗の住所
|
|
1766
|
-
tel: "
|
|
1767
|
-
email: "
|
|
1768
|
-
external_id: "
|
|
2096
|
+
tel: "07-97912", # 店舗の電話番号
|
|
2097
|
+
email: "FrkXVihIdQ@Wu7J.com", # 店舗のメールアドレス
|
|
2098
|
+
external_id: "4NYirXryPP6taqbm6hsnA9hELka", # 店舗の外部ID
|
|
1769
2099
|
organization_code: "ox-supermarket", # 組織コード
|
|
1770
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
1771
|
-
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
2100
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2101
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
1772
2102
|
))
|
|
1773
2103
|
```
|
|
1774
2104
|
|
|
@@ -1839,12 +2169,12 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
|
1839
2169
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
1840
2170
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1841
2171
|
name: "oxスーパー三田店", # 店舗名
|
|
1842
|
-
postal_code: "
|
|
2172
|
+
postal_code: "376-2080", # 店舗の郵便番号
|
|
1843
2173
|
address: "東京都港区芝...", # 店舗の住所
|
|
1844
|
-
tel: "
|
|
1845
|
-
email: "
|
|
1846
|
-
external_id: "
|
|
1847
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2174
|
+
tel: "041115489", # 店舗の電話番号
|
|
2175
|
+
email: "VIgVP7fIz1@xemn.com", # 店舗のメールアドレス
|
|
2176
|
+
external_id: "x9P7H", # 店舗の外部ID
|
|
2177
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
1848
2178
|
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
|
1849
2179
|
))
|
|
1850
2180
|
```
|
|
@@ -1962,7 +2292,7 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
|
1962
2292
|
指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
|
|
1963
2293
|
|
|
1964
2294
|
---
|
|
1965
|
-
成功したときは[
|
|
2295
|
+
成功したときは[PaginatedAccountDetails](#paginated-account-details)オブジェクトを返します
|
|
1966
2296
|
### Private Money
|
|
1967
2297
|
<a name="get-private-moneys"></a>
|
|
1968
2298
|
#### マネー一覧を取得する
|
|
@@ -1995,8 +2325,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
|
1995
2325
|
```ruby
|
|
1996
2326
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
1997
2327
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1998
|
-
from: "
|
|
1999
|
-
to: "
|
|
2328
|
+
from: "2016-05-21T23:00:33.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
2329
|
+
to: "2021-05-24T13:34:12.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
2000
2330
|
page: 1, # ページ番号
|
|
2001
2331
|
per_page: 50 # 1ページ分の取引数
|
|
2002
2332
|
))
|
|
@@ -2010,10 +2340,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
2010
2340
|
CSVファイルから一括取引をします。
|
|
2011
2341
|
```ruby
|
|
2012
2342
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
2013
|
-
"
|
|
2014
|
-
"
|
|
2015
|
-
"
|
|
2016
|
-
description: "
|
|
2343
|
+
"lwWZKuWWf4n5wNPq2rjN28", # name: 一括取引タスク名
|
|
2344
|
+
"QfQLnQ9Qr", # content: 取引する情報のCSV
|
|
2345
|
+
"2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCpNJ", # request_id: リクエストID
|
|
2346
|
+
description: "ZG6LzTWIbd8ZNVrafdiivNn4NbNLXIdoiqtrelImUNmLeKEfXUc2dQExu22E4bXnTsrAuXzc" # 一括取引の説明
|
|
2017
2347
|
))
|
|
2018
2348
|
```
|
|
2019
2349
|
|
|
@@ -2102,9 +2432,12 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
|
2102
2432
|
* `money_balance (double)`:
|
|
2103
2433
|
* `point_balance (double)`:
|
|
2104
2434
|
* `private_money (PrivateMoney)`:
|
|
2435
|
+
* `user (User)`:
|
|
2105
2436
|
|
|
2106
2437
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
2107
2438
|
|
|
2439
|
+
`user`は [User](#user) オブジェクトを返します。
|
|
2440
|
+
|
|
2108
2441
|
<a name="bill"></a>
|
|
2109
2442
|
## Bill
|
|
2110
2443
|
* `id (string)`: 支払いQRコードのID
|
|
@@ -2229,13 +2562,23 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
|
2229
2562
|
|
|
2230
2563
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2231
2564
|
|
|
2232
|
-
<a name="paginated-
|
|
2233
|
-
##
|
|
2234
|
-
* `rows (array of
|
|
2565
|
+
<a name="paginated-account-with-users"></a>
|
|
2566
|
+
## PaginatedAccountWithUsers
|
|
2567
|
+
* `rows (array of AccountWithUsers)`:
|
|
2568
|
+
* `count (integer)`:
|
|
2569
|
+
* `pagination (Pagination)`:
|
|
2570
|
+
|
|
2571
|
+
`rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
|
|
2572
|
+
|
|
2573
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2574
|
+
|
|
2575
|
+
<a name="paginated-account-details"></a>
|
|
2576
|
+
## PaginatedAccountDetails
|
|
2577
|
+
* `rows (array of AccountDetails)`:
|
|
2235
2578
|
* `count (integer)`:
|
|
2236
2579
|
* `pagination (Pagination)`:
|
|
2237
2580
|
|
|
2238
|
-
`rows`は [
|
|
2581
|
+
`rows`は [AccountDetail](#account-detail) オブジェクトの配列を返します。
|
|
2239
2582
|
|
|
2240
2583
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2241
2584
|
|