pokepay_partner_ruby_sdk 0.1.14 → 0.1.15
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 +338 -88
- data/lib/pokepay_partner_ruby_sdk/request/create_cpm_transaction.rb +17 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_cpm_token.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/response/cashtray_attempt.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/response/cashtray_with_result.rb +2 -2
- data/lib/pokepay_partner_ruby_sdk/response/cpm_token.rb +26 -0
- data/lib/pokepay_partner_ruby_sdk/response/external_transaction.rb +31 -0
- data/lib/pokepay_partner_ruby_sdk/response/product.rb +21 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk.rb +5 -0
- data/partner.yaml +382 -6
- data/pokepay_partner_ruby_sdk.gemspec +3 -3
- metadata +11 -6
@@ -0,0 +1,17 @@
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
2
|
+
|
3
|
+
require "pokepay_partner_ruby_sdk/response/transaction"
|
4
|
+
|
5
|
+
module Pokepay::Request
|
6
|
+
class CreateCpmTransaction < Request
|
7
|
+
def initialize(cpm_token, shop_id, amount, rest_args = {})
|
8
|
+
@path = "/transactions" + "/cpm"
|
9
|
+
@method = "POST"
|
10
|
+
@body_params = { "cpm_token" => cpm_token,
|
11
|
+
"shop_id" => shop_id,
|
12
|
+
"amount" => amount }.merge(rest_args)
|
13
|
+
@response_class = Pokepay::Response::Transaction
|
14
|
+
end
|
15
|
+
attr_reader :response_class
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
2
|
+
|
3
|
+
require "pokepay_partner_ruby_sdk/response/cpm_token"
|
4
|
+
|
5
|
+
module Pokepay::Request
|
6
|
+
class GetCpmToken < Request
|
7
|
+
def initialize(cpm_token)
|
8
|
+
@path = "/cpm" + "/" + cpm_token
|
9
|
+
@method = "GET"
|
10
|
+
@body_params = { }
|
11
|
+
@response_class = Pokepay::Response::CpmToken
|
12
|
+
end
|
13
|
+
attr_reader :response_class
|
14
|
+
end
|
15
|
+
end
|
@@ -5,7 +5,7 @@ require "pokepay_partner_ruby_sdk/response/account_with_user"
|
|
5
5
|
module Pokepay::Response
|
6
6
|
class CashtrayAttempt
|
7
7
|
def initialize(row)
|
8
|
-
@account = AccountWithUser.new(row["account"])
|
8
|
+
@account = row["account"] and AccountWithUser.new(row["account"])
|
9
9
|
@status_code = row["status_code"]
|
10
10
|
@error_type = row["error_type"]
|
11
11
|
@error_message = row["error_message"]
|
@@ -14,8 +14,8 @@ module Pokepay::Response
|
|
14
14
|
@expires_at = row["expires_at"]
|
15
15
|
@canceled_at = row["canceled_at"]
|
16
16
|
@token = row["token"]
|
17
|
-
@attempt = CashtrayAttempt.new(row["attempt"])
|
18
|
-
@transaction = Transaction.new(row["transaction"])
|
17
|
+
@attempt = row["attempt"] and CashtrayAttempt.new(row["attempt"])
|
18
|
+
@transaction = row["transaction"] and Transaction.new(row["transaction"])
|
19
19
|
end
|
20
20
|
attr_reader :id
|
21
21
|
attr_reader :amount
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
2
|
+
|
3
|
+
require "pokepay_partner_ruby_sdk/response/account_detail"
|
4
|
+
require "pokepay_partner_ruby_sdk/response/transaction"
|
5
|
+
require "pokepay_partner_ruby_sdk/response/external_transaction"
|
6
|
+
|
7
|
+
module Pokepay::Response
|
8
|
+
class CpmToken
|
9
|
+
def initialize(row)
|
10
|
+
@cpm_token = row["cpm_token"]
|
11
|
+
@account = AccountDetail.new(row["account"])
|
12
|
+
@transaction = row["transaction"] and Transaction.new(row["transaction"])
|
13
|
+
@event = row["event"] and ExternalTransaction.new(row["event"])
|
14
|
+
@scopes = row["scopes"]
|
15
|
+
@expires_at = row["expires_at"]
|
16
|
+
@metadata = row["metadata"]
|
17
|
+
end
|
18
|
+
attr_reader :cpm_token
|
19
|
+
attr_reader :account
|
20
|
+
attr_reader :transaction
|
21
|
+
attr_reader :event
|
22
|
+
attr_reader :scopes
|
23
|
+
attr_reader :expires_at
|
24
|
+
attr_reader :metadata
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
2
|
+
|
3
|
+
require "pokepay_partner_ruby_sdk/response/user"
|
4
|
+
require "pokepay_partner_ruby_sdk/response/account"
|
5
|
+
require "pokepay_partner_ruby_sdk/response/user"
|
6
|
+
require "pokepay_partner_ruby_sdk/response/account"
|
7
|
+
|
8
|
+
module Pokepay::Response
|
9
|
+
class ExternalTransaction
|
10
|
+
def initialize(row)
|
11
|
+
@id = row["id"]
|
12
|
+
@is_modified = row["is_modified"]
|
13
|
+
@sender = User.new(row["sender"])
|
14
|
+
@sender_account = Account.new(row["sender_account"])
|
15
|
+
@receiver = User.new(row["receiver"])
|
16
|
+
@receiver_account = Account.new(row["receiver_account"])
|
17
|
+
@amount = row["amount"]
|
18
|
+
@done_at = row["done_at"]
|
19
|
+
@description = row["description"]
|
20
|
+
end
|
21
|
+
attr_reader :id
|
22
|
+
attr_reader :is_modified
|
23
|
+
attr_reader :sender
|
24
|
+
attr_reader :sender_account
|
25
|
+
attr_reader :receiver
|
26
|
+
attr_reader :receiver_account
|
27
|
+
attr_reader :amount
|
28
|
+
attr_reader :done_at
|
29
|
+
attr_reader :description
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# DO NOT EDIT: File is generated by code generator.
|
2
|
+
|
3
|
+
|
4
|
+
module Pokepay::Response
|
5
|
+
class Product
|
6
|
+
def initialize(row)
|
7
|
+
@jan_code = row["jan_code"]
|
8
|
+
@name = row["name"]
|
9
|
+
@unit_price = row["unit_price"]
|
10
|
+
@price = row["price"]
|
11
|
+
@is_discounted = row["is_discounted"]
|
12
|
+
@other = row["other"]
|
13
|
+
end
|
14
|
+
attr_reader :jan_code
|
15
|
+
attr_reader :name
|
16
|
+
attr_reader :unit_price
|
17
|
+
attr_reader :price
|
18
|
+
attr_reader :is_discounted
|
19
|
+
attr_reader :other
|
20
|
+
end
|
21
|
+
end
|
@@ -20,11 +20,13 @@ require "pokepay_partner_ruby_sdk/request/list_bills"
|
|
20
20
|
require "pokepay_partner_ruby_sdk/request/create_bill"
|
21
21
|
require "pokepay_partner_ruby_sdk/request/update_bill"
|
22
22
|
require "pokepay_partner_ruby_sdk/request/create_check"
|
23
|
+
require "pokepay_partner_ruby_sdk/request/get_cpm_token"
|
23
24
|
require "pokepay_partner_ruby_sdk/request/list_transactions"
|
24
25
|
require "pokepay_partner_ruby_sdk/request/create_transaction"
|
25
26
|
require "pokepay_partner_ruby_sdk/request/create_topup_transaction"
|
26
27
|
require "pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check"
|
27
28
|
require "pokepay_partner_ruby_sdk/request/create_payment_transaction"
|
29
|
+
require "pokepay_partner_ruby_sdk/request/create_cpm_transaction"
|
28
30
|
require "pokepay_partner_ruby_sdk/request/create_transfer_transaction"
|
29
31
|
require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
|
30
32
|
require "pokepay_partner_ruby_sdk/request/bulk_create_transaction"
|
@@ -56,6 +58,7 @@ require "pokepay_partner_ruby_sdk/response/shop_account"
|
|
56
58
|
require "pokepay_partner_ruby_sdk/response/account_balance"
|
57
59
|
require "pokepay_partner_ruby_sdk/response/bill"
|
58
60
|
require "pokepay_partner_ruby_sdk/response/check"
|
61
|
+
require "pokepay_partner_ruby_sdk/response/cpm_token"
|
59
62
|
require "pokepay_partner_ruby_sdk/response/cashtray"
|
60
63
|
require "pokepay_partner_ruby_sdk/response/cashtray_with_result"
|
61
64
|
require "pokepay_partner_ruby_sdk/response/cashtray_attempt"
|
@@ -69,6 +72,8 @@ require "pokepay_partner_ruby_sdk/response/user_transaction"
|
|
69
72
|
require "pokepay_partner_ruby_sdk/response/bulk_transaction"
|
70
73
|
require "pokepay_partner_ruby_sdk/response/account_without_private_money_detail"
|
71
74
|
require "pokepay_partner_ruby_sdk/response/transfer"
|
75
|
+
require "pokepay_partner_ruby_sdk/response/external_transaction"
|
76
|
+
require "pokepay_partner_ruby_sdk/response/product"
|
72
77
|
require "pokepay_partner_ruby_sdk/response/organization_summary"
|
73
78
|
require "pokepay_partner_ruby_sdk/response/private_money_organization_summary"
|
74
79
|
require "pokepay_partner_ruby_sdk/response/paginated_private_money_organization_summaries"
|
data/partner.yaml
CHANGED
@@ -264,6 +264,40 @@ components:
|
|
264
264
|
token:
|
265
265
|
type: string
|
266
266
|
title: チャージQRコードを解析したときに出てくるURL
|
267
|
+
CpmToken:
|
268
|
+
x-pokepay-schema-type: "response"
|
269
|
+
type: object
|
270
|
+
properties:
|
271
|
+
cpm_token:
|
272
|
+
type: string
|
273
|
+
minLength: 22
|
274
|
+
maxLength: 22
|
275
|
+
account:
|
276
|
+
$ref: '#/components/schemas/AccountDetail'
|
277
|
+
transaction:
|
278
|
+
$ref: '#/components/schemas/Transaction'
|
279
|
+
nullable: true
|
280
|
+
event:
|
281
|
+
$ref: '#/components/schemas/ExternalTransaction'
|
282
|
+
nullable: true
|
283
|
+
scopes:
|
284
|
+
type: array
|
285
|
+
title: 許可された取引種別
|
286
|
+
description: エンドユーザーがCPMトークンを生成する際に指定する、CPMトークンに許可された取引の種別。
|
287
|
+
items:
|
288
|
+
type: string
|
289
|
+
enum: [payment, topup, external-transaction]
|
290
|
+
expires_at:
|
291
|
+
type: string
|
292
|
+
format: date-time
|
293
|
+
title: CPMトークンの失効日時
|
294
|
+
metadata:
|
295
|
+
type: string
|
296
|
+
format: json
|
297
|
+
title: エンドユーザー側メタデータ
|
298
|
+
description: |-
|
299
|
+
取引作成時に店舗側から指定されるメタデータです。
|
300
|
+
全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列です。
|
267
301
|
|
268
302
|
Cashtray:
|
269
303
|
x-pokepay-schema-type: "response"
|
@@ -682,6 +716,58 @@ components:
|
|
682
716
|
transaction_id:
|
683
717
|
type: string
|
684
718
|
format: uuid
|
719
|
+
ExternalTransaction:
|
720
|
+
x-pokepay-schema-type: "response"
|
721
|
+
properties:
|
722
|
+
id:
|
723
|
+
type: string
|
724
|
+
format: uuid
|
725
|
+
title: ポケペイ外部取引ID
|
726
|
+
is_modified:
|
727
|
+
type: boolean
|
728
|
+
title: 返金された取引かどうか
|
729
|
+
sender:
|
730
|
+
$ref: '#/components/schemas/User'
|
731
|
+
title: 送金者情報
|
732
|
+
sender_account:
|
733
|
+
$ref: '#/components/schemas/Account'
|
734
|
+
title: 送金ウォレット情報
|
735
|
+
receiver:
|
736
|
+
$ref: '#/components/schemas/User'
|
737
|
+
title: 受取者情報
|
738
|
+
receiver_account:
|
739
|
+
$ref: '#/components/schemas/Account'
|
740
|
+
title: 受取ウォレット情報
|
741
|
+
amount:
|
742
|
+
type: number
|
743
|
+
title: 決済額
|
744
|
+
done_at:
|
745
|
+
type: string
|
746
|
+
format: date-time
|
747
|
+
title: 取引日時
|
748
|
+
description:
|
749
|
+
type: string
|
750
|
+
title: 取引説明文
|
751
|
+
Product:
|
752
|
+
x-pokepay-schema-type: "response"
|
753
|
+
properties:
|
754
|
+
jan_code:
|
755
|
+
type: string
|
756
|
+
maxLength: 64
|
757
|
+
name:
|
758
|
+
type: string
|
759
|
+
maxLength: 256
|
760
|
+
unit_price:
|
761
|
+
type: number
|
762
|
+
minimum: 0
|
763
|
+
price:
|
764
|
+
type: number
|
765
|
+
minimum: 0
|
766
|
+
is_discounted:
|
767
|
+
type: boolean
|
768
|
+
other:
|
769
|
+
type: string
|
770
|
+
format: json
|
685
771
|
|
686
772
|
OrganizationSummary:
|
687
773
|
x-pokepay-schema-type: "response"
|
@@ -1723,6 +1809,37 @@ paths:
|
|
1723
1809
|
$ref: '#/components/schemas/Check'
|
1724
1810
|
'400':
|
1725
1811
|
$ref: '#/components/responses/InvalidParameters'
|
1812
|
+
/cpm/{cpm_token}:
|
1813
|
+
get:
|
1814
|
+
tags:
|
1815
|
+
- Transaction
|
1816
|
+
summary: 'CPMトークンの状態取得'
|
1817
|
+
description: CPMトークンの現在の状態を取得します。CPMトークンの有効期限やCPM取引の状態を返します。
|
1818
|
+
x-pokepay-operator-name: "GetCpmToken"
|
1819
|
+
x-pokepay-allow-server-side: true
|
1820
|
+
parameters:
|
1821
|
+
- in: path
|
1822
|
+
name: cpm_token
|
1823
|
+
required: true
|
1824
|
+
schema:
|
1825
|
+
type: string
|
1826
|
+
minLength: 22
|
1827
|
+
maxLength: 22
|
1828
|
+
title: CPMトークン
|
1829
|
+
description: CPM取引時にエンドユーザーが店舗に提示するバーコードを解析して得られる22桁の文字列です。
|
1830
|
+
responses:
|
1831
|
+
'200':
|
1832
|
+
description: OK
|
1833
|
+
content:
|
1834
|
+
application/json:
|
1835
|
+
schema:
|
1836
|
+
$ref: '#/components/schemas/CpmToken'
|
1837
|
+
'400':
|
1838
|
+
$ref: '#/components/responses/BadRequest'
|
1839
|
+
'403':
|
1840
|
+
$ref: '#/components/responses/Forbidden'
|
1841
|
+
'422':
|
1842
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
1726
1843
|
/transactions:
|
1727
1844
|
get:
|
1728
1845
|
tags:
|
@@ -2008,6 +2125,16 @@ paths:
|
|
2008
2125
|
|
2009
2126
|
任意入力で、取引履歴に表示される説明文です。
|
2010
2127
|
example: 初夏のチャージキャンペーン
|
2128
|
+
metadata:
|
2129
|
+
type: string
|
2130
|
+
format: json
|
2131
|
+
title: '取引メタデータ'
|
2132
|
+
description: |-
|
2133
|
+
取引作成時に指定されるメタデータです。
|
2134
|
+
|
2135
|
+
任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
|
2136
|
+
example: |-
|
2137
|
+
{"key":"value"}
|
2011
2138
|
request_id:
|
2012
2139
|
type: string
|
2013
2140
|
format: uuid
|
@@ -2139,6 +2266,56 @@ paths:
|
|
2139
2266
|
|
2140
2267
|
任意入力で、取引履歴に表示される説明文です。
|
2141
2268
|
example: たい焼き(小倉)
|
2269
|
+
metadata:
|
2270
|
+
type: string
|
2271
|
+
format: json
|
2272
|
+
title: '取引メタデータ'
|
2273
|
+
description: |-
|
2274
|
+
取引作成時に指定されるメタデータです。
|
2275
|
+
|
2276
|
+
任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
|
2277
|
+
example: |-
|
2278
|
+
{"key":"value"}
|
2279
|
+
products:
|
2280
|
+
type: array
|
2281
|
+
items:
|
2282
|
+
type: object
|
2283
|
+
properties:
|
2284
|
+
jan_code:
|
2285
|
+
type: string
|
2286
|
+
maxLength: 64
|
2287
|
+
name:
|
2288
|
+
type: string
|
2289
|
+
maxLength: 256
|
2290
|
+
unit_price:
|
2291
|
+
type: number
|
2292
|
+
minimum: 0
|
2293
|
+
price:
|
2294
|
+
type: number
|
2295
|
+
minimum: 0
|
2296
|
+
is_discounted:
|
2297
|
+
type: boolean
|
2298
|
+
other:
|
2299
|
+
type: string
|
2300
|
+
format: json
|
2301
|
+
example: |-
|
2302
|
+
{"jan_code":"abc",
|
2303
|
+
"name":"name1",
|
2304
|
+
"unit_price":100,
|
2305
|
+
"price": 100,
|
2306
|
+
"is_discounted": false,
|
2307
|
+
"other":"{}"}
|
2308
|
+
title: '商品情報データ'
|
2309
|
+
description: |-
|
2310
|
+
一つの取引に含まれる商品情報データです。
|
2311
|
+
以下の内容からなるJSONオブジェクトの配列で指定します。
|
2312
|
+
|
2313
|
+
- `jan_code`: JANコード。64字以下の文字列
|
2314
|
+
- `name`: 商品名。256字以下の文字列
|
2315
|
+
- `unit_price`: 商品単価。0以上の数値
|
2316
|
+
- `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
|
2317
|
+
- `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
|
2318
|
+
- `other`: その他商品に関する情報。JSONオブジェクトで指定します。
|
2142
2319
|
request_id:
|
2143
2320
|
type: string
|
2144
2321
|
format: uuid
|
@@ -2163,6 +2340,187 @@ paths:
|
|
2163
2340
|
$ref: '#/components/responses/Forbidden'
|
2164
2341
|
'422':
|
2165
2342
|
$ref: '#/components/responses/UnprocessableEntity'
|
2343
|
+
/transactions/cpm:
|
2344
|
+
post:
|
2345
|
+
tags:
|
2346
|
+
- Transaction
|
2347
|
+
summary: 'CPMトークンによる取引作成'
|
2348
|
+
description: |
|
2349
|
+
CPMトークンにより取引を作成します。
|
2350
|
+
CPMトークンに設定されたスコープの取引を作ることができます。
|
2351
|
+
x-pokepay-operator-name: "CreateCpmTransaction"
|
2352
|
+
x-pokepay-allow-server-side: true
|
2353
|
+
requestBody:
|
2354
|
+
required: true
|
2355
|
+
content:
|
2356
|
+
application/json:
|
2357
|
+
schema:
|
2358
|
+
required: ["cpm_token", "shop_id", "amount"]
|
2359
|
+
properties:
|
2360
|
+
cpm_token:
|
2361
|
+
type: string
|
2362
|
+
minLength: 22
|
2363
|
+
maxLength: 22
|
2364
|
+
title: 'CPMトークン'
|
2365
|
+
description: |-
|
2366
|
+
エンドユーザーによって作られ、アプリなどに表示され、店舗に対して提示される22桁の文字列です。
|
2367
|
+
|
2368
|
+
エンドユーザーによって許可された取引のスコープを持っています。
|
2369
|
+
shop_id:
|
2370
|
+
type: string
|
2371
|
+
format: uuid
|
2372
|
+
title: '店舗ID'
|
2373
|
+
description: |-
|
2374
|
+
店舗IDです。
|
2375
|
+
|
2376
|
+
支払いやチャージを行う店舗を指定します。
|
2377
|
+
amount:
|
2378
|
+
type: number
|
2379
|
+
title: '取引金額'
|
2380
|
+
description: |-
|
2381
|
+
取引金額を指定します。
|
2382
|
+
|
2383
|
+
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
2384
|
+
description:
|
2385
|
+
type: string
|
2386
|
+
maxLength: 200
|
2387
|
+
title: '取引説明文'
|
2388
|
+
description: |-
|
2389
|
+
取引説明文です。
|
2390
|
+
|
2391
|
+
エンドユーザーアプリの取引履歴などに表示されます。
|
2392
|
+
example: たい焼き(小倉)
|
2393
|
+
metadata:
|
2394
|
+
type: string
|
2395
|
+
format: json
|
2396
|
+
title: '店舗側メタデータ'
|
2397
|
+
description: |-
|
2398
|
+
取引作成時に店舗側から指定されるメタデータです。
|
2399
|
+
|
2400
|
+
任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
|
2401
|
+
example: |-
|
2402
|
+
{"key":"value"}
|
2403
|
+
products:
|
2404
|
+
type: array
|
2405
|
+
items:
|
2406
|
+
type: object
|
2407
|
+
properties:
|
2408
|
+
jan_code:
|
2409
|
+
type: string
|
2410
|
+
maxLength: 64
|
2411
|
+
name:
|
2412
|
+
type: string
|
2413
|
+
maxLength: 256
|
2414
|
+
unit_price:
|
2415
|
+
type: number
|
2416
|
+
minimum: 0
|
2417
|
+
price:
|
2418
|
+
type: number
|
2419
|
+
minimum: 0
|
2420
|
+
is_discounted:
|
2421
|
+
type: boolean
|
2422
|
+
other:
|
2423
|
+
type: string
|
2424
|
+
format: json
|
2425
|
+
example: |-
|
2426
|
+
{"jan_code":"abc",
|
2427
|
+
"name":"name1",
|
2428
|
+
"unit_price":100,
|
2429
|
+
"price": 100,
|
2430
|
+
"is_discounted": false,
|
2431
|
+
"other":"{}"}
|
2432
|
+
title: 商品情報データ
|
2433
|
+
description: |-
|
2434
|
+
一つの取引に含まれる商品情報データです。
|
2435
|
+
以下の内容からなるJSONオブジェクトの配列で指定します。
|
2436
|
+
|
2437
|
+
- `jan_code`: JANコード。64字以下の文字列
|
2438
|
+
- `name`: 商品名。256字以下の文字列
|
2439
|
+
- `unit_price`: 商品単価。0以上の数値
|
2440
|
+
- `price`: 全体の金額(例: 商品単価 × 個数)。0以上の数値
|
2441
|
+
- `is_discounted`: 賞味期限が近いなどの理由で商品が値引きされているかどうかのフラグ。boolean
|
2442
|
+
- `other`: その他商品に関する情報。JSONオブジェクトで指定します。
|
2443
|
+
request_id:
|
2444
|
+
type: string
|
2445
|
+
format: uuid
|
2446
|
+
title: 'リクエストID'
|
2447
|
+
description: |-
|
2448
|
+
取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
|
2449
|
+
|
2450
|
+
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
|
2451
|
+
|
2452
|
+
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
|
2453
|
+
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
|
2454
|
+
responses:
|
2455
|
+
'200':
|
2456
|
+
description: OK
|
2457
|
+
content:
|
2458
|
+
application/json:
|
2459
|
+
schema:
|
2460
|
+
$ref: '#/components/schemas/Transaction'
|
2461
|
+
examples:
|
2462
|
+
example-1:
|
2463
|
+
value:
|
2464
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2465
|
+
type: string
|
2466
|
+
is_modified: true
|
2467
|
+
sender:
|
2468
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2469
|
+
name: string
|
2470
|
+
is_merchant: true
|
2471
|
+
sender_account:
|
2472
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2473
|
+
name: string
|
2474
|
+
is_suspended: true
|
2475
|
+
private_money:
|
2476
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2477
|
+
name: string
|
2478
|
+
unit: string
|
2479
|
+
is_exclusive: true
|
2480
|
+
description: string
|
2481
|
+
oneline_message: string
|
2482
|
+
organization:
|
2483
|
+
code: string
|
2484
|
+
name: string
|
2485
|
+
max_balance: 0
|
2486
|
+
transfer_limit: 0
|
2487
|
+
type: own
|
2488
|
+
expiration_type: static
|
2489
|
+
enable_topup_by_member: true
|
2490
|
+
receiver:
|
2491
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2492
|
+
name: string
|
2493
|
+
is_merchant: true
|
2494
|
+
receiver_account:
|
2495
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2496
|
+
name: string
|
2497
|
+
is_suspended: true
|
2498
|
+
private_money:
|
2499
|
+
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
|
2500
|
+
name: string
|
2501
|
+
unit: string
|
2502
|
+
is_exclusive: true
|
2503
|
+
description: string
|
2504
|
+
oneline_message: string
|
2505
|
+
organization:
|
2506
|
+
code: string
|
2507
|
+
name: string
|
2508
|
+
max_balance: 0
|
2509
|
+
transfer_limit: 0
|
2510
|
+
type: own
|
2511
|
+
expiration_type: static
|
2512
|
+
enable_topup_by_member: true
|
2513
|
+
amount: 0
|
2514
|
+
money_amount: 0
|
2515
|
+
point_amount: 0
|
2516
|
+
done_at: '2019-08-24T14:15:22Z'
|
2517
|
+
description: string
|
2518
|
+
'400':
|
2519
|
+
$ref: '#/components/responses/BadRequest'
|
2520
|
+
'403':
|
2521
|
+
$ref: '#/components/responses/Forbidden'
|
2522
|
+
'422':
|
2523
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
2166
2524
|
/transactions/transfer:
|
2167
2525
|
post:
|
2168
2526
|
tags:
|
@@ -2212,6 +2570,16 @@ paths:
|
|
2212
2570
|
マネー額です。
|
2213
2571
|
|
2214
2572
|
送金するマネー額を指定します。
|
2573
|
+
metadata:
|
2574
|
+
type: string
|
2575
|
+
format: json
|
2576
|
+
title: '取引メタデータ'
|
2577
|
+
description: |-
|
2578
|
+
取引作成時に指定されるメタデータです。
|
2579
|
+
|
2580
|
+
任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
|
2581
|
+
example: |-
|
2582
|
+
{"key":"value"}
|
2215
2583
|
description:
|
2216
2584
|
type: string
|
2217
2585
|
maxLength: 200
|
@@ -2404,8 +2772,16 @@ paths:
|
|
2404
2772
|
post:
|
2405
2773
|
tags:
|
2406
2774
|
- Transaction
|
2407
|
-
summary: '
|
2408
|
-
|
2775
|
+
summary: '取引をキャンセルする'
|
2776
|
+
description: |-
|
2777
|
+
取引IDを指定して取引をキャンセルします。
|
2778
|
+
|
2779
|
+
発行体の管理者は自組織の直営店、または発行しているマネーの決済加盟店組織での取引をキャンセルできます。
|
2780
|
+
キャンセル対象の取引に付随するポイント還元キャンペーンやクーポン適用も取り消されます。
|
2781
|
+
|
2782
|
+
チャージ取引のキャンセル時に返金すべき残高が足りないときは `account_balance_not_enough (422)` エラーが返ります。
|
2783
|
+
取引をキャンセルできるのは1回きりです。既にキャンセルされた取引を重ねてキャンセルしようとすると `transaction_already_refunded (422)` エラーが返ります。
|
2784
|
+
x-pokepay-operator-name: RefundTransaction
|
2409
2785
|
x-pokepay-allow-server-side: true
|
2410
2786
|
parameters:
|
2411
2787
|
- in: path
|
@@ -2546,7 +2922,7 @@ paths:
|
|
2546
2922
|
type: string
|
2547
2923
|
maxLength: 32
|
2548
2924
|
title: '新規組織コード'
|
2549
|
-
example:
|
2925
|
+
example: ox-supermarket
|
2550
2926
|
name:
|
2551
2927
|
type: string
|
2552
2928
|
maxLength: 256
|
@@ -2576,7 +2952,7 @@ paths:
|
|
2576
2952
|
type: string
|
2577
2953
|
pattern: '^$|^[0-9]{4}$'
|
2578
2954
|
title: '銀行金融機関コード'
|
2579
|
-
example:
|
2955
|
+
example: '1234'
|
2580
2956
|
bank_branch_name:
|
2581
2957
|
type: string
|
2582
2958
|
maxLength: 64
|
@@ -2586,7 +2962,7 @@ paths:
|
|
2586
2962
|
type: string
|
2587
2963
|
pattern: '^(|[0-9]{3})$'
|
2588
2964
|
title: '銀行支店コード'
|
2589
|
-
example:
|
2965
|
+
example: '123'
|
2590
2966
|
bank_account_type:
|
2591
2967
|
type: string
|
2592
2968
|
enum: [saving, current, other]
|
@@ -2596,7 +2972,7 @@ paths:
|
|
2596
2972
|
maxLength: 7
|
2597
2973
|
pattern: '[0-9]{0,7}'
|
2598
2974
|
title: '銀行口座番号'
|
2599
|
-
example:
|
2975
|
+
example: '1234567'
|
2600
2976
|
bank_account_holder_name:
|
2601
2977
|
# TODO: flico
|
2602
2978
|
type: string
|
@@ -10,11 +10,11 @@ Gem::Specification.new do |spec|
|
|
10
10
|
|
11
11
|
spec.summary = %q{Pokepay Partner API SDK for Ruby}
|
12
12
|
spec.description = %q{Pokepay Partner API SDK for Ruby}
|
13
|
-
spec.homepage = "https://github.com/pokepay/
|
13
|
+
spec.homepage = "https://github.com/pokepay/pokepay_partner_ruby_sdk"
|
14
14
|
|
15
15
|
spec.metadata["homepage_uri"] = spec.homepage
|
16
|
-
spec.metadata["source_code_uri"] = "https://github.com/pokepay/
|
17
|
-
spec.metadata["changelog_uri"] = "https://github.com/pokepay/
|
16
|
+
spec.metadata["source_code_uri"] = "https://github.com/pokepay/pokepay_partner_ruby_sdk"
|
17
|
+
spec.metadata["changelog_uri"] = "https://github.com/pokepay/pokepay_partner_ruby_sdk"
|
18
18
|
|
19
19
|
# Specify which files should be added to the gem when it is released.
|
20
20
|
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|