pokepay_partner_ruby_sdk 0.1.12 → 0.1.13
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/index.md +148 -86
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/partner.yaml +44 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1630f5d909147fb03a05583bbde221dc53fafe375d2cd5b7ab85727b63429662
|
4
|
+
data.tar.gz: 30242c08c57c768e0866c17fa5e378dbc35e600225346d9710cda0695c937f4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b97c52f0c83b1fcf7b7b633a1d5490c78a33923c82318bc09dd9e3fbd896c6b87d9929084717831f88d46618af06e22e0b249a4e8c28874d4783b30716d193c4
|
7
|
+
data.tar.gz: c5e179d9e18940099d2131311d5ae5f66f82b9688ab60af60b19292f2393faa19771b653e53d915ff9e424b8239010040076eb16080ef97c6b44d91bac0a69cd
|
data/Gemfile.lock
CHANGED
data/docs/index.md
CHANGED
@@ -182,8 +182,8 @@ response.body
|
|
182
182
|
取引一覧を返します。
|
183
183
|
```ruby
|
184
184
|
response = $client.send(Pokepay::Request::ListTransactions.new(
|
185
|
-
from: "
|
186
|
-
to: "
|
185
|
+
from: "2016-06-03T22:47:56.000000+09:00", # 開始日時
|
186
|
+
to: "2020-02-14T17:14:59.000000+09:00", # 終了日時
|
187
187
|
page: 1, # ページ番号
|
188
188
|
per_page: 50, # 1ページ分の取引数
|
189
189
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
@@ -390,10 +390,10 @@ response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
390
390
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
391
391
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
392
392
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
393
|
-
money_amount:
|
394
|
-
point_amount:
|
395
|
-
point_expires_at: "2023-
|
396
|
-
description: "
|
393
|
+
money_amount: 534,
|
394
|
+
point_amount: 1195,
|
395
|
+
point_expires_at: "2023-05-29T08:46:58.000000+09:00", # ポイント有効期限
|
396
|
+
description: "N6lsKCXAkk07Q9YuV27x2ZZwJNPJ0aXH1uRWCYsw6VRBfXAF7xeoT0y6lNlDnKEOyMV89HUL5OwvTmfk"
|
397
397
|
))
|
398
398
|
```
|
399
399
|
|
@@ -419,10 +419,11 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
419
419
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
420
420
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
421
421
|
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
422
|
-
money_amount:
|
423
|
-
point_amount:
|
424
|
-
point_expires_at: "2024-
|
425
|
-
description: "初夏のチャージキャンペーン"
|
422
|
+
money_amount: 6611, # マネー額
|
423
|
+
point_amount: 3184, # ポイント額
|
424
|
+
point_expires_at: "2024-11-16T15:12:20.000000+09:00", # ポイント有効期限
|
425
|
+
description: "初夏のチャージキャンペーン", # 取引履歴に表示する説明文
|
426
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
426
427
|
))
|
427
428
|
```
|
428
429
|
|
@@ -521,6 +522,20 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
521
522
|
|
522
523
|
任意入力で、取引履歴に表示される説明文です。
|
523
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
|
+
|
524
539
|
---
|
525
540
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
526
541
|
<a name="create-payment-transaction"></a>
|
@@ -533,8 +548,9 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
533
548
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
534
549
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
535
550
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
536
|
-
|
537
|
-
description: "たい焼き(小倉)"
|
551
|
+
7587, # amount: 支払い額
|
552
|
+
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
553
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
538
554
|
))
|
539
555
|
```
|
540
556
|
|
@@ -598,6 +614,20 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
598
614
|
|
599
615
|
任意入力で、取引履歴に表示される説明文です。
|
600
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
|
+
|
601
631
|
---
|
602
632
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
603
633
|
<a name="create-transfer-transaction"></a>
|
@@ -610,8 +640,9 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
610
640
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
611
641
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
612
642
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
613
|
-
|
614
|
-
description: "たい焼き(小倉)"
|
643
|
+
9515, # amount: 送金額
|
644
|
+
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
645
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
615
646
|
))
|
616
647
|
```
|
617
648
|
|
@@ -675,6 +706,20 @@ response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
675
706
|
|
676
707
|
任意入力で、取引履歴に表示される説明文です。
|
677
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
|
+
|
678
723
|
---
|
679
724
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
680
725
|
<a name="create-exchange-transaction"></a>
|
@@ -684,10 +729,27 @@ response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
684
729
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
685
730
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
686
731
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
687
|
-
|
688
|
-
description: "
|
732
|
+
4983,
|
733
|
+
description: "sJQRiuvWpRkphzntqbTr2vHF1iF0Y7dBxe8hiTzwkLtzBfAa7kaQm6vULSy1FKdTtu83N0tnRGbdpbMjOs6NsjUaiDroY6Q3IK7BQ6AmswdAM3IJrwVbs9pMxfMCth",
|
734
|
+
request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # リクエストID
|
689
735
|
))
|
690
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
|
+
---
|
691
753
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
692
754
|
<a name="get-transaction"></a>
|
693
755
|
#### 取引情報を取得する
|
@@ -725,19 +787,19 @@ response = $client.send(Pokepay::Request::RefundTransaction.new(
|
|
725
787
|
####
|
726
788
|
```ruby
|
727
789
|
response = $client.send(Pokepay::Request::ListTransfers.new(
|
728
|
-
from: "
|
729
|
-
to: "
|
730
|
-
page:
|
731
|
-
per_page:
|
790
|
+
from: "2016-06-14T19:11:56.000000+09:00",
|
791
|
+
to: "2022-09-27T00:44:53.000000+09:00",
|
792
|
+
page: 3877,
|
793
|
+
per_page: 9011,
|
732
794
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
733
|
-
shop_name: "
|
795
|
+
shop_name: "EHFmQw4OmJsXraAGliEBPmHrH76ocsr7yZptwOIMGRxZLktLdV7uiWarFr5GP0wp4l70Zs",
|
734
796
|
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
735
|
-
customer_name: "
|
797
|
+
customer_name: "yPlyZYRURgUMf0P5ozHDn0iOeoWIRRMyR0nQkh8Zz7eaFGoiOPKR0rUW9UTcnGDBsZuPfABdiNvfS9Anufij6THnocikBJOkD3FvwnaI0WeOGlWmmegc1KGhe3TxnuKac7CS1DK4Gnrr3oBLGMXHrz9mqfRhRmUp8pN9pjtBKEK15Dd3XxCT0Zmu6u7tOxquneNatGol",
|
736
798
|
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
737
799
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
738
|
-
is_modified:
|
739
|
-
transaction_types: ["
|
740
|
-
transfer_types: ["transfer"],
|
800
|
+
is_modified: false,
|
801
|
+
transaction_types: ["transfer", "exchange"],
|
802
|
+
transfer_types: ["transfer", "topup", "payment", "campaign", "exchange", "coupon"], # 取引明細の種類でフィルターします。
|
741
803
|
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
742
804
|
))
|
743
805
|
```
|
@@ -845,19 +907,19 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|
|
845
907
|
支払いQRコード一覧を表示します。
|
846
908
|
```ruby
|
847
909
|
response = $client.send(Pokepay::Request::ListBills.new(
|
848
|
-
page:
|
849
|
-
per_page:
|
850
|
-
bill_id: "
|
910
|
+
page: 4107, # ページ番号
|
911
|
+
per_page: 1151, # 1ページの表示数
|
912
|
+
bill_id: "yMS6WkNJ2", # 支払いQRコードのID
|
851
913
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
852
|
-
organization_code: "-
|
914
|
+
organization_code: "--y6-I0", # 組織コード
|
853
915
|
description: "test bill", # 取引説明文
|
854
|
-
created_from: "
|
855
|
-
created_to: "
|
916
|
+
created_from: "2017-06-06T23:19:55.000000+09:00", # 作成日時(起点)
|
917
|
+
created_to: "2024-08-04T19:51:44.000000+09:00", # 作成日時(終点)
|
856
918
|
shop_name: "bill test shop1", # 店舗名
|
857
919
|
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
858
|
-
lower_limit_amount:
|
859
|
-
upper_limit_amount:
|
860
|
-
is_disabled:
|
920
|
+
lower_limit_amount: 8925, # 金額の範囲によるフィルタ(下限)
|
921
|
+
upper_limit_amount: 149, # 金額の範囲によるフィルタ(上限)
|
922
|
+
is_disabled: true # 支払いQRコードが無効化されているかどうか
|
861
923
|
))
|
862
924
|
```
|
863
925
|
|
@@ -1001,7 +1063,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
|
|
1001
1063
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
1002
1064
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
1003
1065
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
1004
|
-
amount:
|
1066
|
+
amount: 1855, # 支払い額
|
1005
1067
|
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
1006
1068
|
))
|
1007
1069
|
```
|
@@ -1025,7 +1087,7 @@ response = $client.send(Pokepay::Request::CreateBill.new(
|
|
1025
1087
|
```ruby
|
1026
1088
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
1027
1089
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
1028
|
-
amount:
|
1090
|
+
amount: 7862, # 支払い額
|
1029
1091
|
description: "test bill", # 説明文
|
1030
1092
|
is_disabled: false # 無効化されているかどうか
|
1031
1093
|
))
|
@@ -1090,9 +1152,9 @@ Cashtrayを作成します。
|
|
1090
1152
|
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
1091
1153
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1092
1154
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
1093
|
-
|
1155
|
+
2752, # amount: 金額
|
1094
1156
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
1095
|
-
expires_in:
|
1157
|
+
expires_in: 1057 # 失効時間(秒)
|
1096
1158
|
))
|
1097
1159
|
```
|
1098
1160
|
|
@@ -1253,9 +1315,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
|
|
1253
1315
|
```ruby
|
1254
1316
|
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
1255
1317
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
1256
|
-
amount:
|
1318
|
+
amount: 781, # 金額
|
1257
1319
|
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
1258
|
-
expires_in:
|
1320
|
+
expires_in: 1632 # 失効時間(秒)
|
1259
1321
|
))
|
1260
1322
|
```
|
1261
1323
|
|
@@ -1361,10 +1423,10 @@ response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
1361
1423
|
```ruby
|
1362
1424
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
1363
1425
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
1364
|
-
page:
|
1365
|
-
per_page:
|
1366
|
-
expires_at_from: "
|
1367
|
-
expires_at_to: "
|
1426
|
+
page: 1479, # ページ番号
|
1427
|
+
per_page: 7500, # 1ページ分の取引数
|
1428
|
+
expires_at_from: "2021-02-11T09:11:28.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
1429
|
+
expires_at_to: "2022-08-08T00:02:11.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
1368
1430
|
direction: "asc" # 有効期限によるソート順序
|
1369
1431
|
))
|
1370
1432
|
```
|
@@ -1439,10 +1501,10 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
1439
1501
|
```ruby
|
1440
1502
|
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
1441
1503
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
1442
|
-
page:
|
1443
|
-
per_page:
|
1444
|
-
expires_at_from: "
|
1445
|
-
expires_at_to: "
|
1504
|
+
page: 8104, # ページ番号
|
1505
|
+
per_page: 1970, # 1ページ分の取引数
|
1506
|
+
expires_at_from: "2019-12-01T21:52:13.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
1507
|
+
expires_at_to: "2022-06-02T02:05:40.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
1446
1508
|
direction: "desc" # 有効期限によるソート順序
|
1447
1509
|
))
|
1448
1510
|
```
|
@@ -1517,11 +1579,11 @@ response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
1517
1579
|
```ruby
|
1518
1580
|
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
1519
1581
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1520
|
-
page:
|
1521
|
-
per_page:
|
1522
|
-
created_at_from: "
|
1523
|
-
created_at_to: "2016-
|
1524
|
-
is_suspended:
|
1582
|
+
page: 3492, # ページ番号
|
1583
|
+
per_page: 7179, # 1ページ分のウォレット数
|
1584
|
+
created_at_from: "2019-05-15T08:37:19.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
1585
|
+
created_at_to: "2016-06-13T22:28:14.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
1586
|
+
is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
|
1525
1587
|
))
|
1526
1588
|
```
|
1527
1589
|
|
@@ -1637,10 +1699,10 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
1637
1699
|
```ruby
|
1638
1700
|
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
1639
1701
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1640
|
-
page:
|
1641
|
-
per_page:
|
1642
|
-
created_at_from: "
|
1643
|
-
created_at_to: "
|
1702
|
+
page: 6974, # ページ番号
|
1703
|
+
per_page: 6258, # 1ページ分のウォレット数
|
1704
|
+
created_at_from: "2021-12-09T06:29:53.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
1705
|
+
created_at_to: "2022-01-08T09:28:00.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
1644
1706
|
is_suspended: false # ウォレットが凍結状態かどうかでフィルターする
|
1645
1707
|
))
|
1646
1708
|
```
|
@@ -1714,10 +1776,10 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
1714
1776
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
1715
1777
|
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
1716
1778
|
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
1717
|
-
type: "
|
1718
|
-
is_modified:
|
1719
|
-
from: "2019-
|
1720
|
-
to: "
|
1779
|
+
type: "N9jftsBTkZ", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
|
1780
|
+
is_modified: true, # キャンセル済みかどうか
|
1781
|
+
from: "2019-07-11T14:20:45.000000+09:00", # 開始日時
|
1782
|
+
to: "2019-01-16T06:48:10.000000+09:00", # 終了日時
|
1721
1783
|
page: 1, # ページ番号
|
1722
1784
|
per_page: 50 # 1ページ分の取引数
|
1723
1785
|
))
|
@@ -1842,11 +1904,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
1842
1904
|
organization_code: "pocketchange", # 組織コード
|
1843
1905
|
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
1844
1906
|
name: "oxスーパー三田店", # 店舗名
|
1845
|
-
postal_code: "
|
1907
|
+
postal_code: "9793795", # 店舗の郵便番号
|
1846
1908
|
address: "東京都港区芝...", # 店舗の住所
|
1847
|
-
tel: "
|
1848
|
-
email: "
|
1849
|
-
external_id: "
|
1909
|
+
tel: "03-45-292", # 店舗の電話番号
|
1910
|
+
email: "gXoYNaRDH3@xa5Z.com", # 店舗のメールアドレス
|
1911
|
+
external_id: "Xl3L94kmDiQZVmfdCV9wG", # 店舗の外部ID
|
1850
1912
|
page: 1, # ページ番号
|
1851
1913
|
per_page: 50 # 1ページ分の取引数
|
1852
1914
|
))
|
@@ -1971,11 +2033,11 @@ response = $client.send(Pokepay::Request::ListShops.new(
|
|
1971
2033
|
```ruby
|
1972
2034
|
response = $client.send(Pokepay::Request::CreateShop.new(
|
1973
2035
|
"oxスーパー三田店", # shop_name: 店舗名
|
1974
|
-
shop_postal_code: "
|
2036
|
+
shop_postal_code: "5270015", # 店舗の郵便番号
|
1975
2037
|
shop_address: "東京都港区芝...", # 店舗の住所
|
1976
|
-
shop_tel: "
|
1977
|
-
shop_email: "
|
1978
|
-
shop_external_id: "
|
2038
|
+
shop_tel: "0434-32-763", # 店舗の電話番号
|
2039
|
+
shop_email: "ZmJCZwuee4@w9Rk.com", # 店舗のメールアドレス
|
2040
|
+
shop_external_id: "vag9C19xRl1IlJpGXqlhd5uwOg", # 店舗の外部ID
|
1979
2041
|
organization_code: "ox-supermarket" # 組織コード
|
1980
2042
|
))
|
1981
2043
|
```
|
@@ -1985,13 +2047,13 @@ response = $client.send(Pokepay::Request::CreateShop.new(
|
|
1985
2047
|
```ruby
|
1986
2048
|
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
1987
2049
|
"oxスーパー三田店", # name: 店舗名
|
1988
|
-
postal_code: "
|
2050
|
+
postal_code: "534-0319", # 店舗の郵便番号
|
1989
2051
|
address: "東京都港区芝...", # 店舗の住所
|
1990
|
-
tel: "
|
1991
|
-
email: "
|
1992
|
-
external_id: "
|
2052
|
+
tel: "09598-3740", # 店舗の電話番号
|
2053
|
+
email: "nZxaZi9iCa@2kj9.com", # 店舗のメールアドレス
|
2054
|
+
external_id: "DD4FLU53H4", # 店舗の外部ID
|
1993
2055
|
organization_code: "ox-supermarket", # 組織コード
|
1994
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
2056
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
1995
2057
|
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
1996
2058
|
))
|
1997
2059
|
```
|
@@ -2063,13 +2125,13 @@ response = $client.send(Pokepay::Request::GetShop.new(
|
|
2063
2125
|
response = $client.send(Pokepay::Request::UpdateShop.new(
|
2064
2126
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
2065
2127
|
name: "oxスーパー三田店", # 店舗名
|
2066
|
-
postal_code: "
|
2128
|
+
postal_code: "445-1656", # 店舗の郵便番号
|
2067
2129
|
address: "東京都港区芝...", # 店舗の住所
|
2068
|
-
tel: "
|
2069
|
-
email: "
|
2070
|
-
external_id: "
|
2071
|
-
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
2072
|
-
can_topup_private_money_ids: [
|
2130
|
+
tel: "008767500", # 店舗の電話番号
|
2131
|
+
email: "SdiADG37ey@dGEN.com", # 店舗のメールアドレス
|
2132
|
+
external_id: "PuSUGCPNHip0Y3", # 店舗の外部ID
|
2133
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
2134
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
2073
2135
|
))
|
2074
2136
|
```
|
2075
2137
|
|
@@ -2219,8 +2281,8 @@ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
2219
2281
|
```ruby
|
2220
2282
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
2221
2283
|
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
2222
|
-
from: "
|
2223
|
-
to: "
|
2284
|
+
from: "2022-03-23T13:20:28.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
2285
|
+
to: "2016-02-11T07:58:41.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
2224
2286
|
page: 1, # ページ番号
|
2225
2287
|
per_page: 50 # 1ページ分の取引数
|
2226
2288
|
))
|
@@ -2234,10 +2296,10 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
2234
2296
|
CSVファイルから一括取引をします。
|
2235
2297
|
```ruby
|
2236
2298
|
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
2237
|
-
"
|
2238
|
-
"
|
2239
|
-
"
|
2240
|
-
description: "
|
2299
|
+
"cNdXe1sI", # name: 一括取引タスク名
|
2300
|
+
"S", # content: 取引する情報のCSV
|
2301
|
+
"VztCspdpKcDGU85LATApzQ2dQG1XtK0UfX1f", # request_id: リクエストID
|
2302
|
+
description: "zmKZw4jAX5TdVMZA3FsBWHTaR7q8iHovbTWoPNbCUX3WmvU0lnYW7MWulxJqejEo" # 一括取引の説明
|
2241
2303
|
))
|
2242
2304
|
```
|
2243
2305
|
|
data/partner.yaml
CHANGED
@@ -1959,6 +1959,17 @@ paths:
|
|
1959
1959
|
|
1960
1960
|
任意入力で、取引履歴に表示される説明文です。
|
1961
1961
|
example: 初夏のチャージキャンペーン
|
1962
|
+
request_id:
|
1963
|
+
type: string
|
1964
|
+
format: uuid
|
1965
|
+
title: 'リクエストID'
|
1966
|
+
description: |-
|
1967
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
1968
|
+
|
1969
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
1970
|
+
|
1971
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
1972
|
+
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
|
1962
1973
|
responses:
|
1963
1974
|
'200':
|
1964
1975
|
description: OK
|
@@ -2079,6 +2090,17 @@ paths:
|
|
2079
2090
|
|
2080
2091
|
任意入力で、取引履歴に表示される説明文です。
|
2081
2092
|
example: たい焼き(小倉)
|
2093
|
+
request_id:
|
2094
|
+
type: string
|
2095
|
+
format: uuid
|
2096
|
+
title: 'リクエストID'
|
2097
|
+
description: |-
|
2098
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
2099
|
+
|
2100
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
2101
|
+
|
2102
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
2103
|
+
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
|
2082
2104
|
responses:
|
2083
2105
|
'200':
|
2084
2106
|
description: OK
|
@@ -2150,6 +2172,17 @@ paths:
|
|
2150
2172
|
|
2151
2173
|
任意入力で、取引履歴に表示される説明文です。
|
2152
2174
|
example: たい焼き(小倉)
|
2175
|
+
request_id:
|
2176
|
+
type: string
|
2177
|
+
format: uuid
|
2178
|
+
title: 'リクエストID'
|
2179
|
+
description: |-
|
2180
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
2181
|
+
|
2182
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
2183
|
+
|
2184
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
2185
|
+
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
|
2153
2186
|
responses:
|
2154
2187
|
'200':
|
2155
2188
|
description: OK
|
@@ -2190,6 +2223,17 @@ paths:
|
|
2190
2223
|
description:
|
2191
2224
|
type: string
|
2192
2225
|
maxLength: 200
|
2226
|
+
request_id:
|
2227
|
+
type: string
|
2228
|
+
format: uuid
|
2229
|
+
title: 'リクエストID'
|
2230
|
+
description: |-
|
2231
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
2232
|
+
|
2233
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
2234
|
+
|
2235
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
2236
|
+
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
|
2193
2237
|
responses:
|
2194
2238
|
'200':
|
2195
2239
|
description: OK
|
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.
|
4
|
+
version: 0.1.13
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Pocket Change, Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-08-
|
11
|
+
date: 2021-08-31 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|