pokepay_partner_ruby_sdk 0.1.2 → 0.1.8

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 (28) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docs/index.md +1053 -203
  4. data/lib/pokepay_partner_ruby_sdk.rb +35 -19
  5. data/lib/pokepay_partner_ruby_sdk/request/bulk_create_transaction.rb +17 -0
  6. data/lib/pokepay_partner_ruby_sdk/request/create_bill.rb +16 -0
  7. data/lib/pokepay_partner_ruby_sdk/request/create_organization.rb +2 -1
  8. data/lib/pokepay_partner_ruby_sdk/request/create_transfer_transaction.rb +18 -0
  9. data/lib/pokepay_partner_ruby_sdk/request/list_account_expired_balances.rb +15 -0
  10. data/lib/pokepay_partner_ruby_sdk/request/list_bills.rb +15 -0
  11. data/lib/pokepay_partner_ruby_sdk/request/list_customer_transactions.rb +15 -0
  12. data/lib/pokepay_partner_ruby_sdk/request/list_shops.rb +15 -0
  13. data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb +15 -0
  14. data/lib/pokepay_partner_ruby_sdk/request/refund_transaction.rb +15 -0
  15. data/lib/pokepay_partner_ruby_sdk/request/update_account.rb +15 -0
  16. data/lib/pokepay_partner_ruby_sdk/request/update_bill.rb +15 -0
  17. data/lib/pokepay_partner_ruby_sdk/response/bill.rb +26 -0
  18. data/lib/pokepay_partner_ruby_sdk/response/bulk_transaction.rb +21 -0
  19. data/lib/pokepay_partner_ruby_sdk/response/paginated_accounts.rb +16 -0
  20. data/lib/pokepay_partner_ruby_sdk/response/paginated_bills.rb +16 -0
  21. data/lib/pokepay_partner_ruby_sdk/response/paginated_shops.rb +16 -0
  22. data/lib/pokepay_partner_ruby_sdk/response/pong.rb +2 -2
  23. data/lib/pokepay_partner_ruby_sdk/response/shop_with_metadata.rb +25 -0
  24. data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
  25. data/partner.yaml +2387 -0
  26. metadata +23 -7
  27. data/lib/pokepay_partner_ruby_sdk/parameter/product.rb +0 -21
  28. data/lib/pokepay_partner_ruby_sdk/request/create_cpm_transaction.rb +0 -17
@@ -1,28 +1,39 @@
1
1
  # encoding: utf-8
2
+ # DO NOT EDIT: File is generated by code generator.
2
3
 
3
4
  require "pokepay_partner_ruby_sdk/version"
4
5
  require "pokepay_partner_ruby_sdk/client"
5
6
  require "pokepay_partner_ruby_sdk/request/request"
6
7
  require "pokepay_partner_ruby_sdk/response/response"
7
- require "pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries"
8
- require "pokepay_partner_ruby_sdk/request/create_shop"
9
- require "pokepay_partner_ruby_sdk/request/create_organization"
10
- require "pokepay_partner_ruby_sdk/request/list_transfers"
11
- require "pokepay_partner_ruby_sdk/request/create_cpm_transaction"
12
- require "pokepay_partner_ruby_sdk/request/get_transaction"
13
- require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
14
- require "pokepay_partner_ruby_sdk/request/create_payment_transaction"
15
- require "pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check"
16
- require "pokepay_partner_ruby_sdk/request/create_topup_transaction"
17
- require "pokepay_partner_ruby_sdk/request/create_transaction"
18
- require "pokepay_partner_ruby_sdk/request/list_transactions"
19
- require "pokepay_partner_ruby_sdk/request/create_check"
20
- require "pokepay_partner_ruby_sdk/request/create_customer_account"
21
- require "pokepay_partner_ruby_sdk/request/list_account_balances"
22
- require "pokepay_partner_ruby_sdk/request/get_account"
23
- require "pokepay_partner_ruby_sdk/request/get_user"
24
- require "pokepay_partner_ruby_sdk/request/send_echo"
25
8
  require "pokepay_partner_ruby_sdk/request/get_ping"
9
+ require "pokepay_partner_ruby_sdk/request/send_echo"
10
+ require "pokepay_partner_ruby_sdk/request/get_user"
11
+ require "pokepay_partner_ruby_sdk/request/list_user_accounts"
12
+ require "pokepay_partner_ruby_sdk/request/get_account"
13
+ require "pokepay_partner_ruby_sdk/request/update_account"
14
+ require "pokepay_partner_ruby_sdk/request/list_account_balances"
15
+ require "pokepay_partner_ruby_sdk/request/list_account_expired_balances"
16
+ require "pokepay_partner_ruby_sdk/request/create_customer_account"
17
+ require "pokepay_partner_ruby_sdk/request/list_bills"
18
+ require "pokepay_partner_ruby_sdk/request/create_bill"
19
+ require "pokepay_partner_ruby_sdk/request/update_bill"
20
+ require "pokepay_partner_ruby_sdk/request/create_check"
21
+ require "pokepay_partner_ruby_sdk/request/list_transactions"
22
+ require "pokepay_partner_ruby_sdk/request/create_transaction"
23
+ require "pokepay_partner_ruby_sdk/request/create_topup_transaction"
24
+ require "pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check"
25
+ require "pokepay_partner_ruby_sdk/request/create_payment_transaction"
26
+ require "pokepay_partner_ruby_sdk/request/create_transfer_transaction"
27
+ require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
28
+ require "pokepay_partner_ruby_sdk/request/bulk_create_transaction"
29
+ require "pokepay_partner_ruby_sdk/request/get_transaction"
30
+ require "pokepay_partner_ruby_sdk/request/refund_transaction"
31
+ require "pokepay_partner_ruby_sdk/request/list_transfers"
32
+ require "pokepay_partner_ruby_sdk/request/create_organization"
33
+ require "pokepay_partner_ruby_sdk/request/list_shops"
34
+ require "pokepay_partner_ruby_sdk/request/create_shop"
35
+ require "pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries"
36
+ require "pokepay_partner_ruby_sdk/request/list_customer_transactions"
26
37
  require "pokepay_partner_ruby_sdk/response/pong"
27
38
  require "pokepay_partner_ruby_sdk/response/echo"
28
39
  require "pokepay_partner_ruby_sdk/response/pagination"
@@ -31,21 +42,26 @@ require "pokepay_partner_ruby_sdk/response/account"
31
42
  require "pokepay_partner_ruby_sdk/response/account_with_user"
32
43
  require "pokepay_partner_ruby_sdk/response/account_detail"
33
44
  require "pokepay_partner_ruby_sdk/response/account_balance"
45
+ require "pokepay_partner_ruby_sdk/response/bill"
34
46
  require "pokepay_partner_ruby_sdk/response/check"
35
47
  require "pokepay_partner_ruby_sdk/response/user"
36
48
  require "pokepay_partner_ruby_sdk/response/private_money"
37
49
  require "pokepay_partner_ruby_sdk/response/organization"
38
50
  require "pokepay_partner_ruby_sdk/response/transaction"
51
+ require "pokepay_partner_ruby_sdk/response/shop_with_metadata"
39
52
  require "pokepay_partner_ruby_sdk/response/user_transaction"
53
+ require "pokepay_partner_ruby_sdk/response/bulk_transaction"
40
54
  require "pokepay_partner_ruby_sdk/response/account_without_private_money_detail"
41
55
  require "pokepay_partner_ruby_sdk/response/transfer"
42
- require "pokepay_partner_ruby_sdk/parameter/product"
43
56
  require "pokepay_partner_ruby_sdk/response/organization_summary"
44
57
  require "pokepay_partner_ruby_sdk/response/private_money_organization_summary"
45
58
  require "pokepay_partner_ruby_sdk/response/paginated_private_money_organization_summaries"
46
59
  require "pokepay_partner_ruby_sdk/response/paginated_transaction"
47
60
  require "pokepay_partner_ruby_sdk/response/paginated_transfers"
61
+ require "pokepay_partner_ruby_sdk/response/paginated_accounts"
48
62
  require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
63
+ require "pokepay_partner_ruby_sdk/response/paginated_shops"
64
+ require "pokepay_partner_ruby_sdk/response/paginated_bills"
49
65
  require "pokepay_partner_ruby_sdk/response/bad_request"
50
66
  require "pokepay_partner_ruby_sdk/response/partner_client_not_found"
51
67
  require "pokepay_partner_ruby_sdk/response/partner_decryption_failed"
@@ -0,0 +1,17 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/bulk_transaction"
4
+
5
+ module Pokepay::Request
6
+ class BulkCreateTransaction < Request
7
+ def initialize(name, content, request_id, rest_args = {})
8
+ @path = "/transactions" + "/bulk"
9
+ @method = "POST"
10
+ @body_params = { "name" => name,
11
+ "content" => content,
12
+ "request_id" => request_id }.merge(rest_args)
13
+ @response_class = Pokepay::Response::BulkTransaction
14
+ end
15
+ attr_reader :response_class
16
+ end
17
+ end
@@ -0,0 +1,16 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/bill"
4
+
5
+ module Pokepay::Request
6
+ class CreateBill < Request
7
+ def initialize(private_money_id, shop_id, rest_args = {})
8
+ @path = "/bills"
9
+ @method = "POST"
10
+ @body_params = { "private_money_id" => private_money_id,
11
+ "shop_id" => shop_id }.merge(rest_args)
12
+ @response_class = Pokepay::Response::Bill
13
+ end
14
+ attr_reader :response_class
15
+ end
16
+ end
@@ -4,11 +4,12 @@ require "pokepay_partner_ruby_sdk/response/organization"
4
4
 
5
5
  module Pokepay::Request
6
6
  class CreateOrganization < Request
7
- def initialize(code, name, issuer_admin_user_email, member_admin_user_email, rest_args = {})
7
+ def initialize(code, name, private_money_ids, issuer_admin_user_email, member_admin_user_email, rest_args = {})
8
8
  @path = "/organizations"
9
9
  @method = "POST"
10
10
  @body_params = { "code" => code,
11
11
  "name" => name,
12
+ "private_money_ids" => private_money_ids,
12
13
  "issuer_admin_user_email" => issuer_admin_user_email,
13
14
  "member_admin_user_email" => member_admin_user_email }.merge(rest_args)
14
15
  @response_class = Pokepay::Response::Organization
@@ -0,0 +1,18 @@
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 CreateTransferTransaction < Request
7
+ def initialize(sender_id, receiver_id, private_money_id, amount, rest_args = {})
8
+ @path = "/transactions" + "/transfer"
9
+ @method = "POST"
10
+ @body_params = { "sender_id" => sender_id,
11
+ "receiver_id" => receiver_id,
12
+ "private_money_id" => private_money_id,
13
+ "amount" => amount }.merge(rest_args)
14
+ @response_class = Pokepay::Response::Transaction
15
+ end
16
+ attr_reader :response_class
17
+ end
18
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
4
+
5
+ module Pokepay::Request
6
+ class ListAccountExpiredBalances < Request
7
+ def initialize(account_id, rest_args = {})
8
+ @path = "/accounts" + "/" + account_id + "/expired-balances"
9
+ @method = "GET"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::PaginatedAccountBalance
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_bills"
4
+
5
+ module Pokepay::Request
6
+ class ListBills < Request
7
+ def initialize(rest_args = {})
8
+ @path = "/bills"
9
+ @method = "GET"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::PaginatedBills
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_transaction"
4
+
5
+ module Pokepay::Request
6
+ class ListCustomerTransactions < Request
7
+ def initialize(private_money_id, rest_args = {})
8
+ @path = "/customers" + "/transactions"
9
+ @method = "GET"
10
+ @body_params = { "private_money_id" => private_money_id }.merge(rest_args)
11
+ @response_class = Pokepay::Response::PaginatedTransaction
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_shops"
4
+
5
+ module Pokepay::Request
6
+ class ListShops < Request
7
+ def initialize(rest_args = {})
8
+ @path = "/shops"
9
+ @method = "GET"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::PaginatedShops
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/paginated_accounts"
4
+
5
+ module Pokepay::Request
6
+ class ListUserAccounts < Request
7
+ def initialize(user_id)
8
+ @path = "/users" + "/" + user_id + "/accounts"
9
+ @method = "GET"
10
+ @body_params = { }
11
+ @response_class = Pokepay::Response::PaginatedAccounts
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/transfer"
4
+
5
+ module Pokepay::Request
6
+ class RefundTransaction < Request
7
+ def initialize(transaction_id, rest_args = {})
8
+ @path = "/transactions" + "/" + transaction_id + "/refund"
9
+ @method = "POST"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::Transfer
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/account_detail"
4
+
5
+ module Pokepay::Request
6
+ class UpdateAccount < Request
7
+ def initialize(account_id, rest_args = {})
8
+ @path = "/accounts" + "/" + account_id
9
+ @method = "PATCH"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::AccountDetail
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/bill"
4
+
5
+ module Pokepay::Request
6
+ class UpdateBill < Request
7
+ def initialize(bill_id, rest_args = {})
8
+ @path = "/bills" + "/" + bill_id
9
+ @method = "PATCH"
10
+ @body_params = { }.merge(rest_args)
11
+ @response_class = Pokepay::Response::Bill
12
+ end
13
+ attr_reader :response_class
14
+ end
15
+ end
@@ -0,0 +1,26 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/account_with_user"
4
+
5
+ module Pokepay::Response
6
+ class Bill
7
+ def initialize(row)
8
+ @id = row["id"]
9
+ @amount = row["amount"]
10
+ @max_amount = row["max_amount"]
11
+ @min_amount = row["min_amount"]
12
+ @description = row["description"]
13
+ @account = AccountWithUser.new(row["account"])
14
+ @is_disabled = row["is_disabled"]
15
+ @token = row["token"]
16
+ end
17
+ attr_reader :id
18
+ attr_reader :amount
19
+ attr_reader :max_amount
20
+ attr_reader :min_amount
21
+ attr_reader :description
22
+ attr_reader :account
23
+ attr_reader :is_disabled
24
+ attr_reader :token
25
+ end
26
+ end
@@ -0,0 +1,21 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+
4
+ module Pokepay::Response
5
+ class BulkTransaction
6
+ def initialize(row)
7
+ @request_id = row["request_id"]
8
+ @name = row["name"]
9
+ @description = row["description"]
10
+ @status = row["status"]
11
+ @submitted_at = row["submitted_at"]
12
+ @updated_at = row["updated_at"]
13
+ end
14
+ attr_reader :request_id
15
+ attr_reader :name
16
+ attr_reader :description
17
+ attr_reader :status
18
+ attr_reader :submitted_at
19
+ attr_reader :updated_at
20
+ end
21
+ end
@@ -0,0 +1,16 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/pagination"
4
+
5
+ module Pokepay::Response
6
+ class PaginatedAccounts
7
+ def initialize(row)
8
+ @rows = row["rows"]
9
+ @count = row["count"]
10
+ @pagination = Pagination.new(row["pagination"])
11
+ end
12
+ attr_reader :rows
13
+ attr_reader :count
14
+ attr_reader :pagination
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/pagination"
4
+
5
+ module Pokepay::Response
6
+ class PaginatedBills
7
+ def initialize(row)
8
+ @rows = row["rows"]
9
+ @count = row["count"]
10
+ @pagination = Pagination.new(row["pagination"])
11
+ end
12
+ attr_reader :rows
13
+ attr_reader :count
14
+ attr_reader :pagination
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+ require "pokepay_partner_ruby_sdk/response/pagination"
4
+
5
+ module Pokepay::Response
6
+ class PaginatedShops
7
+ def initialize(row)
8
+ @rows = row["rows"]
9
+ @count = row["count"]
10
+ @pagination = Pagination.new(row["pagination"])
11
+ end
12
+ attr_reader :rows
13
+ attr_reader :count
14
+ attr_reader :pagination
15
+ end
16
+ end
@@ -4,8 +4,8 @@
4
4
  module Pokepay::Response
5
5
  class Pong
6
6
  def initialize(row)
7
- @ok = row["ok"]
7
+ @pong = row["pong"]
8
8
  end
9
- attr_reader :ok
9
+ attr_reader :pong
10
10
  end
11
11
  end
@@ -0,0 +1,25 @@
1
+ # DO NOT EDIT: File is generated by code generator.
2
+
3
+
4
+ module Pokepay::Response
5
+ class ShopWithMetadata
6
+ def initialize(row)
7
+ @id = row["id"]
8
+ @name = row["name"]
9
+ @organization_code = row["organization_code"]
10
+ @postal_code = row["postal_code"]
11
+ @address = row["address"]
12
+ @tel = row["tel"]
13
+ @email = row["email"]
14
+ @external_id = row["external_id"]
15
+ end
16
+ attr_reader :id
17
+ attr_reader :name
18
+ attr_reader :organization_code
19
+ attr_reader :postal_code
20
+ attr_reader :address
21
+ attr_reader :tel
22
+ attr_reader :email
23
+ attr_reader :external_id
24
+ end
25
+ end
@@ -1,3 +1,3 @@
1
1
  module Pokepay
2
- VERSION = "0.1.2"
2
+ VERSION = "0.1.8"
3
3
  end
@@ -0,0 +1,2387 @@
1
+ # NOTE:
2
+ # エントリーポイントについて、x-pokepay-allow-server-side: true がついているものはサーバーサイドで正しいことが保証されているが
3
+ # それ以外は存在しないか間違っているので注意
4
+
5
+ openapi: '3.0.1'
6
+
7
+ info:
8
+ description: >-
9
+ Partner APIs
10
+ title: Partner APIs
11
+ version: 0.0.0
12
+
13
+ components:
14
+ schemas:
15
+ Pong:
16
+ x-pokepay-schema-type: "response"
17
+ properties:
18
+ pong:
19
+ type: string
20
+ pattern: '^ok$'
21
+ Echo:
22
+ x-pokepay-schema-type: "response"
23
+ properties:
24
+ status:
25
+ type: string
26
+ pattern: '^ok$'
27
+ message:
28
+ type: string
29
+ Pagination:
30
+ x-pokepay-schema-type: "response"
31
+ properties:
32
+ current:
33
+ type: integer
34
+ per_page:
35
+ type: integer
36
+ minimum: 1
37
+ max_page:
38
+ type: integer
39
+ minimum: 1
40
+ has_prev:
41
+ type: boolean
42
+ has_next:
43
+ type: boolean
44
+ AdminUserWithShopsAndPrivateMoneys:
45
+ x-pokepay-schema-type: "response"
46
+ properties:
47
+ id:
48
+ type: string
49
+ format: uuid
50
+ role:
51
+ type: string
52
+ pattern: '^(SERVICE|ORGANIZATION|SHOP)-(MANAGER|STAFF)$'
53
+ email:
54
+ type: string
55
+ format: email
56
+ name:
57
+ type: string
58
+ is_active:
59
+ type: boolean
60
+ organization:
61
+ $ref: '#/components/schemas/Organization'
62
+ shops:
63
+ type: array
64
+ items:
65
+ $ref: '#/components/schemas/User'
66
+ private_moneys:
67
+ type: array
68
+ items:
69
+ $ref: '#/components/schemas/PrivateMoney'
70
+ Account:
71
+ x-pokepay-schema-type: "response"
72
+ properties:
73
+ id:
74
+ type: string
75
+ format: uuid
76
+ summary: 'ウォレットID'
77
+ name:
78
+ type: string
79
+ summary: 'ウォレット名'
80
+ is_suspended:
81
+ type: boolean
82
+ summary: 'ウォレットが凍結されているかどうか'
83
+ private_money:
84
+ $ref: '#/components/schemas/PrivateMoney'
85
+ summary: '設定マネー情報'
86
+ AccountWithUser:
87
+ x-pokepay-schema-type: "response"
88
+ properties:
89
+ id:
90
+ type: string
91
+ format: uuid
92
+ name:
93
+ type: string
94
+ is_suspended:
95
+ type: boolean
96
+ private_money:
97
+ $ref: '#/components/schemas/PrivateMoney'
98
+ user:
99
+ $ref: '#/components/schemas/User'
100
+ AccountDetail:
101
+ x-pokepay-schema-type: "response"
102
+ properties:
103
+ id:
104
+ type: string
105
+ format: uuid
106
+ name:
107
+ type: string
108
+ is_suspended:
109
+ type: boolean
110
+ balance:
111
+ type: number
112
+ format: decimal
113
+ money_balance:
114
+ type: number
115
+ format: decimal
116
+ point_balance:
117
+ type: number
118
+ format: decimal
119
+ private_money:
120
+ $ref: '#/components/schemas/PrivateMoney'
121
+ AccountBalance:
122
+ x-pokepay-schema-type: "response"
123
+ properties:
124
+ expires_at:
125
+ type: string
126
+ format: date-time
127
+ money_amount:
128
+ type: number
129
+ format: decimal
130
+ point_amount:
131
+ type: number
132
+ format: decimal
133
+ Bill:
134
+ x-pokepay-schema-type: "response"
135
+ properties:
136
+ id:
137
+ type: string
138
+ format: uuid
139
+ summary: 支払いQRコードのID
140
+ amount:
141
+ type: number
142
+ format: decimal
143
+ nullable: true
144
+ summary: 支払い額
145
+ description: 支払い額。支払い額未指定の場合は支払い時に任意金額を入力できます。
146
+ max_amount:
147
+ type: number
148
+ format: decimal
149
+ nullable: true
150
+ summary: 支払い額を範囲指定した場合の上限
151
+ description: 支払い額に任意金額を入力する際の上限です。
152
+ min_amount:
153
+ type: number
154
+ format: decimal
155
+ nullable: true
156
+ summary: 支払い額を範囲指定した場合の下限
157
+ description: 支払い額に任意金額を入力する際の下限です。
158
+ description:
159
+ type: string
160
+ summary: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
161
+ account:
162
+ $ref: '#/components/schemas/AccountWithUser'
163
+ summary: 支払いQRコード発行ウォレット
164
+ description: 支払いQRコードを発行した店舗のウォレットです。ユーザやマネーの情報を含みます。
165
+ is_disabled:
166
+ type: boolean
167
+ summary: 無効化されているかどうか
168
+ token:
169
+ type: string
170
+ description: 支払いQRコードを解析したときに出てくるURL
171
+ Check:
172
+ x-pokepay-schema-type: "response"
173
+ properties:
174
+ id:
175
+ type: string
176
+ format: uuid
177
+ summary: チャージQRコードのID
178
+ amount:
179
+ type: number
180
+ format: decimal
181
+ deprecated: true
182
+ summary: チャージマネー額
183
+ money_amount:
184
+ type: number
185
+ format: decimal
186
+ summary: チャージマネー額
187
+ point_amount:
188
+ type: number
189
+ format: decimal
190
+ summary: チャージポイント額
191
+ description:
192
+ type: string
193
+ summary: チャージQRコードの説明文(アプリ上で取引の説明文として表示される)
194
+ user:
195
+ $ref: '#/components/schemas/User'
196
+ summary: 送金元ユーザ情報
197
+ is_onetime:
198
+ type: boolean
199
+ summary: 使用回数が一回限りかどうか
200
+ is_disabled:
201
+ type: boolean
202
+ summary: 無効化されているかどうか
203
+ expires_at:
204
+ type: string
205
+ format: date-time
206
+ summary: チャージQRコード自体の失効日時
207
+ private_money:
208
+ $ref: '#/components/schemas/PrivateMoney'
209
+ summary: 対象マネー情報
210
+ usage_limit:
211
+ type: integer
212
+ summary: 一回限りでない場合の最大読み取り回数
213
+ usage_count:
214
+ type: number
215
+ summary: 一回限りでない場合の現在までに読み取られた回数
216
+ token:
217
+ type: string
218
+ summary: チャージQRコードを解析したときに出てくるURL
219
+ User:
220
+ x-pokepay-schema-type: "response"
221
+ properties:
222
+ id:
223
+ type: string
224
+ format: uuid
225
+ summary: 'ユーザー (または店舗) ID'
226
+ name:
227
+ type: string
228
+ summary: 'ユーザー (または店舗) 名'
229
+ is_merchant:
230
+ type: boolean
231
+ summary: '店舗ユーザーかどうか'
232
+ PrivateMoney:
233
+ x-pokepay-schema-type: "response"
234
+ properties:
235
+ id:
236
+ type: string
237
+ format: uuid
238
+ summary: 'マネーID'
239
+ name:
240
+ type: string
241
+ maxLength: 256
242
+ summary: 'マネー名'
243
+ unit:
244
+ type: string
245
+ summary: 'マネー単位 (例: 円)'
246
+ is_exclusive:
247
+ type: boolean
248
+ summary: '会員制のマネーかどうか'
249
+ description:
250
+ type: string
251
+ summary: 'マネー説明文'
252
+ oneline_message:
253
+ type: string
254
+ summary: 'マネーの要約'
255
+ organization:
256
+ summary: 'マネーを発行した組織'
257
+ $ref: '#/components/schemas/Organization'
258
+ max_balance:
259
+ type: number
260
+ format: decimal
261
+ summary: 'ウォレットの上限金額'
262
+ transfer_limit:
263
+ type: number
264
+ format: decimal
265
+ summary: 'マネーの取引上限額'
266
+ type:
267
+ type: string
268
+ enum: [own, third-party]
269
+ summary: 'マネー種別 (自家型=own, 第三者型=third-party)'
270
+ expiration_type:
271
+ type: string
272
+ enum: [static, last-update, last-topup-update]
273
+ summary: '有効期限種別 (チャージ日起算=static, 最終利用日起算=last-update, 最終チャージ日起算=last-topup-update)'
274
+ enable_topup_by_member:
275
+ type: boolean
276
+ nullable: true
277
+ summary: '加盟店によるチャージが有効かどうか'
278
+ account_image:
279
+ type: string
280
+ nullable: true
281
+ summary: 'マネーの画像URL'
282
+ Organization:
283
+ x-pokepay-schema-type: "response"
284
+ properties:
285
+ code:
286
+ type: string
287
+ maxLength: 32
288
+ summary: '組織コード'
289
+ name:
290
+ type: string
291
+ maxLength: 256
292
+ summary: '組織名'
293
+ Transaction:
294
+ x-pokepay-schema-type: "response"
295
+ properties:
296
+ id:
297
+ type: string
298
+ format: uuid
299
+ summary: '取引ID'
300
+ type:
301
+ type: string
302
+ summary: '取引種別 (チャージ=topup, 支払い=payment)'
303
+ is_modified:
304
+ type: boolean
305
+ summary: '返金された取引かどうか'
306
+ sender:
307
+ $ref: '#/components/schemas/User'
308
+ summary: '送金者情報'
309
+ sender_account:
310
+ $ref: '#/components/schemas/Account'
311
+ summary: '送金ウォレット情報'
312
+ receiver:
313
+ $ref: '#/components/schemas/User'
314
+ summary: '受取者情報'
315
+ receiver_account:
316
+ $ref: '#/components/schemas/Account'
317
+ summary: '受取ウォレット情報'
318
+ amount:
319
+ type: number
320
+ summary: '決済総額 (マネー額 + ポイント額)'
321
+ money_amount:
322
+ type: number
323
+ summary: '決済マネー額'
324
+ point_amount:
325
+ type: number
326
+ summary: '決済ポイント額'
327
+ done_at:
328
+ type: string
329
+ format: date-time
330
+ summary: '取引日時'
331
+ description:
332
+ type: string
333
+ summary: '取引説明文'
334
+ ShopWithMetadata:
335
+ x-pokepay-schema-type: "response"
336
+ properties:
337
+ id:
338
+ type: string
339
+ format: uuid
340
+ summary: 店舗ID
341
+ name:
342
+ type: string
343
+ summary: 店舗名
344
+ organization_code:
345
+ type: string
346
+ maxLength: 256
347
+ summary: 組織コード
348
+ postal_code:
349
+ type: string
350
+ nullable: true
351
+ summary: '店舗の郵便番号'
352
+ address:
353
+ type: string
354
+ nullable: true
355
+ summary: '店舗の住所'
356
+ tel:
357
+ type: string
358
+ nullable: true
359
+ summary: '店舗の電話番号'
360
+ email:
361
+ type: string
362
+ nullable: true
363
+ format: email
364
+ maxLength: 256
365
+ summary: '店舗のメールアドレス'
366
+ external_id:
367
+ type: string
368
+ nullable: true
369
+ maxLength: 36
370
+ summary: '店舗の外部ID'
371
+ UserTransaction:
372
+ x-pokepay-schema-type: "response"
373
+ properties:
374
+ id:
375
+ type: string
376
+ format: uuid
377
+ user:
378
+ $ref: '#/components/schemas/User'
379
+ balance:
380
+ type: number
381
+ format: decimal
382
+ amount:
383
+ type: number
384
+ format: decimal
385
+ minimum: 0
386
+ money_amount:
387
+ type: number
388
+ format: decimal
389
+ minimum: 0
390
+ point_amount:
391
+ type: number
392
+ format: decimal
393
+ minimum: 0
394
+ account:
395
+ $ref: '#/components/schemas/Account'
396
+ description:
397
+ type: string
398
+ done_at:
399
+ type: string
400
+ format: date-time
401
+ type:
402
+ type: string
403
+ enum: [topup, payment, transfer, exchange]
404
+ is_modified:
405
+ type: boolean
406
+ BulkTransaction:
407
+ x-pokepay-schema-type: "response"
408
+ properties:
409
+ request_id:
410
+ type: string
411
+ summary: リクエストID
412
+ name:
413
+ type: string
414
+ summary: バルクチャージ管理用の名前
415
+ description:
416
+ type: string
417
+ summary: バルクチャージ管理用の説明文
418
+ status:
419
+ type: string
420
+ enum:
421
+ - submitted
422
+ - examining
423
+ - queued
424
+ - processing
425
+ - error
426
+ - done
427
+ summary: バルクチャージの状態
428
+ submitted_at:
429
+ type: string
430
+ format: date-time
431
+ summary: バルクチャージが登録された日時
432
+ updated_at:
433
+ type: string
434
+ format: date-time
435
+ summary: バルクチャージが更新された日時
436
+ AccountWithoutPrivateMoneyDetail:
437
+ x-pokepay-schema-type: "response"
438
+ properties:
439
+ id:
440
+ type: string
441
+ format: uuid
442
+ name:
443
+ type: string
444
+ is_suspended:
445
+ type: boolean
446
+ private_money_id:
447
+ type: string
448
+ format: uuid
449
+ user:
450
+ $ref: '#/components/schemas/User'
451
+ Transfer:
452
+ x-pokepay-schema-type: "response"
453
+ properties:
454
+ id:
455
+ type: string
456
+ format: uuid
457
+ sender_account:
458
+ $ref: '#/components/schemas/AccountWithoutPrivateMoneyDetail'
459
+ receiver_account:
460
+ $ref: '#/components/schemas/AccountWithoutPrivateMoneyDetail'
461
+ amount:
462
+ type: number
463
+ format: decimal
464
+ minimum: 0
465
+ money_amount:
466
+ type: number
467
+ format: decimal
468
+ minimum: 0
469
+ point_amount:
470
+ type: number
471
+ format: decimal
472
+ minimum: 0
473
+ done_at:
474
+ type: string
475
+ format: date-time
476
+ type:
477
+ type: string
478
+ enum: [topup, payment, refund-topup, refund-payment, transfer, exchange-inflow, exchange-outflow]
479
+ description:
480
+ type: string
481
+ transaction_id:
482
+ type: string
483
+ format: uuid
484
+
485
+ OrganizationSummary:
486
+ x-pokepay-schema-type: "response"
487
+ properties:
488
+ count:
489
+ type: integer
490
+ money_amount:
491
+ type: number
492
+ format: decimal
493
+ minimum: 0
494
+ money_count:
495
+ type: integer
496
+ point_amount:
497
+ type: number
498
+ format: decimal
499
+ minimum: 0
500
+ point_count:
501
+ type: integer
502
+ PrivateMoneyOrganizationSummary:
503
+ x-pokepay-schema-type: "response"
504
+ properties:
505
+ organization_code:
506
+ type: string
507
+ pattern: '^[a-zA-Z0-9-]*$'
508
+ maxLength: 32
509
+ topup:
510
+ $ref: '#/components/schemas/OrganizationSummary'
511
+ payment:
512
+ $ref: '#/components/schemas/OrganizationSummary'
513
+ PaginatedPrivateMoneyOrganizationSummaries:
514
+ x-pokepay-schema-type: "response"
515
+ properties:
516
+ rows:
517
+ type: array
518
+ items:
519
+ $ref: '#/components/schemas/PrivateMoneyOrganizationSummary'
520
+ count:
521
+ type: integer
522
+ minimum: 0
523
+ pagination:
524
+ $ref: '#/components/schemas/Pagination'
525
+ PaginatedTransaction:
526
+ x-pokepay-schema-type: "response"
527
+ properties:
528
+ rows:
529
+ type: array
530
+ items:
531
+ $ref: '#/components/schemas/Transaction'
532
+ count:
533
+ type: integer
534
+ minimum: 0
535
+ pagination:
536
+ $ref: '#/components/schemas/Pagination'
537
+ PaginatedTransfers:
538
+ x-pokepay-schema-type: "response"
539
+ properties:
540
+ rows:
541
+ type: array
542
+ items:
543
+ $ref: '#/components/schemas/Transfer'
544
+ count:
545
+ type: integer
546
+ minimum: 0
547
+ pagination:
548
+ $ref: '#/components/schemas/Pagination'
549
+ PaginatedAccounts:
550
+ x-pokepay-schema-type: "response"
551
+ properties:
552
+ rows:
553
+ type: array
554
+ items:
555
+ $ref: '#/components/schemas/Account'
556
+ count:
557
+ type: integer
558
+ minimum: 0
559
+ pagination:
560
+ $ref: '#/components/schemas/Pagination'
561
+ PaginatedAccountBalance:
562
+ x-pokepay-schema-type: "response"
563
+ properties:
564
+ rows:
565
+ type: array
566
+ items:
567
+ $ref: '#/components/schemas/AccountBalance'
568
+ count:
569
+ type: integer
570
+ minimum: 0
571
+ pagination:
572
+ $ref: '#/components/schemas/Pagination'
573
+ PaginatedShops:
574
+ x-pokepay-schema-type: "response"
575
+ properties:
576
+ rows:
577
+ type: array
578
+ items:
579
+ $ref: '#/components/schemas/ShopWithMetadata'
580
+ count:
581
+ type: integer
582
+ minimum: 0
583
+ pagination:
584
+ $ref: '#/components/schemas/Pagination'
585
+ PaginatedBills:
586
+ x-pokepay-schema-type: "response"
587
+ properties:
588
+ rows:
589
+ type: array
590
+ items:
591
+ $ref: '#/components/schemas/Bill'
592
+ count:
593
+ type: integer
594
+ minimum: 0
595
+ pagination:
596
+ $ref: '#/components/schemas/Pagination'
597
+
598
+ BadRequest:
599
+ x-pokepay-schema-type: "response"
600
+ oneOf:
601
+ - $ref: '#/components/schemas/PartnerClientNotFound'
602
+ - $ref: '#/components/schemas/PartnerDecryptionFailed'
603
+ - $ref: '#/components/schemas/PartnerRequestExpired'
604
+ - $ref: '#/components/schemas/PartnerRequestAlreadyDone'
605
+ - $ref: '#/components/schemas/InvalidParameters'
606
+ PartnerClientNotFound:
607
+ x-pokepay-schema-type: "response"
608
+ properties:
609
+ type:
610
+ type: string
611
+ pattern: '^partner_client_not_found$'
612
+ message:
613
+ type: string
614
+ PartnerDecryptionFailed:
615
+ x-pokepay-schema-type: "response"
616
+ properties:
617
+ type:
618
+ type: string
619
+ pattern: '^partner_decryption_failed$'
620
+ message:
621
+ type: string
622
+ PartnerRequestExpired:
623
+ x-pokepay-schema-type: "response"
624
+ properties:
625
+ type:
626
+ type: string
627
+ pattern: '^partner_request_expired$'
628
+ message:
629
+ type: string
630
+ example: 'This request is expired.'
631
+ PartnerRequestAlreadyDone:
632
+ x-pokepay-schema-type: "response"
633
+ properties:
634
+ type:
635
+ type: string
636
+ pattern: '^partner_request_already_done$'
637
+ message:
638
+ type: string
639
+ InvalidParameters:
640
+ x-pokepay-schema-type: "response"
641
+ properties:
642
+ type:
643
+ type: string
644
+ pattern: '^invalid_parameter'
645
+ message:
646
+ type: string
647
+ errors:
648
+ type: object
649
+ properties:
650
+ missing:
651
+ type: array
652
+ nullable: true
653
+ items:
654
+ type: string
655
+ invalid:
656
+ type: array
657
+ nullable: true
658
+ items:
659
+ type: string
660
+ unpermitted:
661
+ type: array
662
+ nullable: true
663
+ items:
664
+ type: string
665
+ Forbidden:
666
+ properties:
667
+ type:
668
+ type: string
669
+ example: forbidden
670
+ message:
671
+ type: string
672
+ example: Forbidden
673
+ NotFound:
674
+ properties:
675
+ type:
676
+ type: string
677
+ example: api_error
678
+ message:
679
+ type: string
680
+ example: Not Found
681
+ UnprocessableEntity:
682
+ properties:
683
+ type:
684
+ type: string
685
+ example: unprocessable
686
+ message:
687
+ type: string
688
+ Conflict:
689
+ properties:
690
+ type:
691
+ type: string
692
+ message:
693
+ type: string
694
+
695
+ responses:
696
+ BadRequest:
697
+ description: Bad Request
698
+ content:
699
+ application/json:
700
+ schema:
701
+ $ref: '#/components/schemas/BadRequest'
702
+ InvalidParameters:
703
+ description: Invalid Parameters
704
+ content:
705
+ application/json:
706
+ schema:
707
+ $ref: '#/components/schemas/InvalidParameters'
708
+ Forbidden:
709
+ description: Forbidden
710
+ content:
711
+ application/json:
712
+ schema:
713
+ $ref: '#/components/schemas/Forbidden'
714
+ NotFound:
715
+ description: Not Found
716
+ content:
717
+ application/json:
718
+ schema:
719
+ $ref: '#/components/schemas/NotFound'
720
+ UnprocessableEntity:
721
+ description: Unprocessable Entity
722
+ content:
723
+ application/json:
724
+ schema:
725
+ $ref: '#/components/schemas/UnprocessableEntity'
726
+ Conflict:
727
+ description: Conflict
728
+ content:
729
+ application/json:
730
+ schema:
731
+ $ref: '#/components/schemas/Conflict'
732
+
733
+ paths:
734
+ /ping:
735
+ get:
736
+ responses:
737
+ '200':
738
+ description: OK
739
+ content:
740
+ application/json:
741
+ schema:
742
+ $ref: '#/components/schemas/Pong'
743
+ /echo:
744
+ post:
745
+ x-pokepay-operator-name: "SendEcho"
746
+ x-pokepay-allow-server-side: true
747
+ requestBody:
748
+ required: true
749
+ content:
750
+ application/json:
751
+ schema:
752
+ required: ["message"]
753
+ properties:
754
+ message:
755
+ type: string
756
+ responses:
757
+ '200':
758
+ description: OK
759
+ content:
760
+ application/json:
761
+ schema:
762
+ $ref: '#/components/schemas/Echo'
763
+ '400':
764
+ $ref: '#/components/responses/BadRequest'
765
+ /user:
766
+ get:
767
+ responses:
768
+ '200':
769
+ description: OK
770
+ content:
771
+ application/json:
772
+ schema:
773
+ $ref: '#/components/schemas/AdminUserWithShopsAndPrivateMoneys'
774
+ /users/{user_id}/accounts:
775
+ get:
776
+ summary: 'エンドユーザー、店舗ユーザーのウォレット一覧を表示する'
777
+ description: ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
778
+ x-pokepay-operator-name: "ListUserAccounts"
779
+ x-pokepay-allow-server-side: true
780
+ parameters:
781
+ - in: path
782
+ name: user_id
783
+ required: true
784
+ schema:
785
+ type: string
786
+ format: uuid
787
+ summary: 'ユーザーID'
788
+ description: |-
789
+ ユーザーIDです。
790
+
791
+ 指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
792
+ responses:
793
+ '200':
794
+ description: OK
795
+ content:
796
+ application/json:
797
+ schema:
798
+ $ref: '#/components/schemas/PaginatedAccounts'
799
+ '400':
800
+ $ref: '#/components/responses/BadRequest'
801
+ '403':
802
+ $ref: '#/components/responses/Forbidden'
803
+ '404':
804
+ $ref: '#/components/responses/NotFound'
805
+ /accounts/{account_id}:
806
+ get:
807
+ summary: 'ウォレット情報を表示する'
808
+ description: ウォレットを取得します。
809
+ x-pokepay-operator-name: "GetAccount"
810
+ x-pokepay-allow-server-side: true
811
+ parameters:
812
+ - in: path
813
+ name: account_id
814
+ required: true
815
+ schema:
816
+ type: string
817
+ format: uuid
818
+ summary: 'ウォレットID'
819
+ description: |-
820
+ ウォレットIDです。
821
+
822
+ フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
823
+ responses:
824
+ '200':
825
+ description: OK
826
+ content:
827
+ application/json:
828
+ schema:
829
+ $ref: '#/components/schemas/AccountDetail'
830
+ '400':
831
+ $ref: '#/components/responses/BadRequest'
832
+ '403':
833
+ $ref: '#/components/responses/Forbidden'
834
+ '404':
835
+ $ref: '#/components/responses/NotFound'
836
+ patch:
837
+ summary: 'ウォレット情報を更新する'
838
+ description: ウォレットの状態を更新します。現在はウォレットの凍結/凍結解除の切り替えにのみ対応しています。
839
+ x-pokepay-operator-name: "UpdateAccount"
840
+ x-pokepay-allow-server-side: true
841
+ parameters:
842
+ - in: path
843
+ name: account_id
844
+ required: true
845
+ schema:
846
+ type: string
847
+ format: uuid
848
+ summary: 'ウォレットID'
849
+ description: |-
850
+ ウォレットIDです。
851
+
852
+ 指定したウォレットIDのウォレットの状態を更新します。
853
+ requestBody:
854
+ required: true
855
+ content:
856
+ application/json:
857
+ schema:
858
+ properties:
859
+ is_suspended:
860
+ type: boolean
861
+ summary: 'ウォレットが凍結されているかどうか'
862
+ description: ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
863
+ responses:
864
+ '200':
865
+ description: OK
866
+ content:
867
+ application/json:
868
+ schema:
869
+ $ref: '#/components/schemas/AccountDetail'
870
+ '400':
871
+ $ref: '#/components/responses/BadRequest'
872
+ '403':
873
+ $ref: '#/components/responses/Forbidden'
874
+ '404':
875
+ $ref: '#/components/responses/NotFound'
876
+ /accounts/{account_id}/balances:
877
+ get:
878
+ summary: 'エンドユーザーの残高内訳を表示する'
879
+ description: エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
880
+ x-pokepay-operator-name: "ListAccountBalances"
881
+ x-pokepay-allow-server-side: true
882
+ parameters:
883
+ - name: account_id
884
+ in: path
885
+ required: true
886
+ schema:
887
+ type: string
888
+ format: uuid
889
+ summary: 'ウォレットID'
890
+ description: |-
891
+ ウォレットIDです。
892
+
893
+ フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
894
+ requestBody:
895
+ required: true
896
+ content:
897
+ application/json:
898
+ schema:
899
+ properties:
900
+ page:
901
+ type: integer
902
+ minimum: 1
903
+ summary: 'ページ番号'
904
+ description: 取得したいページ番号です。デフォルト値は1です。
905
+ per_page:
906
+ type: integer
907
+ minimum: 1
908
+ summary: '1ページ分の取引数'
909
+ description: 1ページ分のウォレット残高数です。デフォルト値は30です。
910
+ expires_at_from:
911
+ type: string
912
+ format: date-time
913
+ summary: '有効期限の期間によるフィルター(開始時点)'
914
+ description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
915
+ expires_at_to:
916
+ type: string
917
+ format: date-time
918
+ summary: '有効期限の期間によるフィルター(終了時点)'
919
+ description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
920
+ direction:
921
+ type: string
922
+ enum: [asc, desc]
923
+ summary: '有効期限によるソート順序'
924
+ description: 有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
925
+ responses:
926
+ '200':
927
+ description: OK
928
+ content:
929
+ application/json:
930
+ schema:
931
+ $ref: '#/components/schemas/PaginatedAccountBalance'
932
+ '400':
933
+ $ref: '#/components/responses/BadRequest'
934
+ '403':
935
+ $ref: '#/components/responses/Forbidden'
936
+ '404':
937
+ $ref: '#/components/responses/NotFound'
938
+ /accounts/{account_id}/expired-balances:
939
+ get:
940
+ summary: 'エンドユーザーの失効済みの残高内訳を表示する'
941
+ description: エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
942
+ x-pokepay-operator-name: "ListAccountExpiredBalances"
943
+ x-pokepay-allow-server-side: true
944
+ parameters:
945
+ - name: account_id
946
+ in: path
947
+ required: true
948
+ schema:
949
+ type: string
950
+ format: uuid
951
+ summary: 'ウォレットID'
952
+ description: |-
953
+ ウォレットIDです。
954
+
955
+ フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
956
+ requestBody:
957
+ required: true
958
+ content:
959
+ application/json:
960
+ schema:
961
+ properties:
962
+ page:
963
+ type: integer
964
+ minimum: 1
965
+ summary: 'ページ番号'
966
+ description: 取得したいページ番号です。デフォルト値は1です。
967
+ per_page:
968
+ type: integer
969
+ minimum: 1
970
+ summary: '1ページ分の取引数'
971
+ description: 1ページ分のウォレット残高数です。デフォルト値は30です。
972
+ expires_at_from:
973
+ type: string
974
+ format: date-time
975
+ summary: '有効期限の期間によるフィルター(開始時点)'
976
+ description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
977
+ expires_at_to:
978
+ type: string
979
+ format: date-time
980
+ summary: '有効期限の期間によるフィルター(終了時点)'
981
+ description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
982
+ direction:
983
+ type: string
984
+ enum: [asc, desc]
985
+ summary: '有効期限によるソート順序'
986
+ description: 有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
987
+ responses:
988
+ '200':
989
+ description: OK
990
+ content:
991
+ application/json:
992
+ schema:
993
+ $ref: '#/components/schemas/PaginatedAccountBalance'
994
+ '400':
995
+ $ref: '#/components/responses/BadRequest'
996
+ '403':
997
+ $ref: '#/components/responses/Forbidden'
998
+ '404':
999
+ $ref: '#/components/responses/NotFound'
1000
+ /accounts/customers:
1001
+ post:
1002
+ summary: '新規エンドユーザーウォレットを追加する'
1003
+ description: |-
1004
+ 指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
1005
+ x-pokepay-operator-name: "CreateCustomerAccount"
1006
+ x-pokepay-allow-server-side: true
1007
+ requestBody:
1008
+ required: true
1009
+ content:
1010
+ application/json:
1011
+ schema:
1012
+ required: ["private_money_id"]
1013
+ properties:
1014
+ private_money_id:
1015
+ summary: 'マネーID'
1016
+ description: |-
1017
+ マネーIDです。
1018
+
1019
+ これによって作成するウォレットのマネーを指定します。
1020
+ type: string
1021
+ format: uuid
1022
+ user_name:
1023
+ summary: 'ユーザー名'
1024
+ description: |-
1025
+ ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
1026
+ type: string
1027
+ maxLength: 256
1028
+ example: ポケペイ太郎
1029
+ account_name:
1030
+ summary: 'アカウント名'
1031
+ description: |-
1032
+ 作成するウォレット名です。省略した場合は空文字となります。
1033
+ type: string
1034
+ maxLength: 256
1035
+ example: ポケペイ太郎のアカウント
1036
+ responses:
1037
+ '200':
1038
+ description: OK
1039
+ content:
1040
+ application/json:
1041
+ schema:
1042
+ $ref: '#/components/schemas/AccountWithUser'
1043
+ '400':
1044
+ $ref: '#/components/responses/BadRequest'
1045
+ '403':
1046
+ $ref: '#/components/responses/Forbidden'
1047
+ '422':
1048
+ $ref: '#/components/responses/UnprocessableEntity'
1049
+ /bills:
1050
+ get:
1051
+ summary: '支払いQRコード一覧を表示する'
1052
+ description: 支払いQRコード一覧を表示します。
1053
+ x-pokepay-operator-name: "ListBills"
1054
+ x-pokepay-allow-server-side: true
1055
+ requestBody:
1056
+ required: true
1057
+ content:
1058
+ application/json:
1059
+ schema:
1060
+ properties:
1061
+ page:
1062
+ type: integer
1063
+ minimum: 1
1064
+ summary: 'ページ番号'
1065
+ description: 取得したいページ番号です。
1066
+ per_page:
1067
+ type: integer
1068
+ minimum: 1
1069
+ summary: '1ページの表示数'
1070
+ description: 1ページに表示する支払いQRコードの数です。
1071
+ bill_id:
1072
+ type: string
1073
+ summary: '支払いQRコードのID'
1074
+ description: 支払いQRコードのIDを指定して検索します。IDは部分一致で検索できます。
1075
+ private_money_id:
1076
+ type: string
1077
+ format: uuid
1078
+ summary: 'マネーID'
1079
+ description: 支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
1080
+ organization_code:
1081
+ type: string
1082
+ pattern: '^[a-zA-Z0-9-]*$'
1083
+ maxLength: 32
1084
+ summary: '組織コード'
1085
+ description: 支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
1086
+ description:
1087
+ type: string
1088
+ maxLength: 200
1089
+ summary: '取引説明文'
1090
+ description: 支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
1091
+ example: 'test bill'
1092
+ created_from:
1093
+ type: string
1094
+ format: date-time
1095
+ summary: '作成日時(起点)'
1096
+ description: |-
1097
+ 支払いQRコードの作成日時でフィルターします。
1098
+
1099
+ これ以降に作成された支払いQRコードのみ一覧に表示されます。
1100
+ created_to:
1101
+ type: string
1102
+ format: date-time
1103
+ summary: '作成日時(終点)'
1104
+ description: |-
1105
+ 支払いQRコードの作成日時でフィルターします。
1106
+
1107
+ これ以前に作成された支払いQRコードのみ一覧に表示されます。
1108
+ shop_name:
1109
+ type: string
1110
+ maxLength: 256
1111
+ summary: '店舗名'
1112
+ description: 支払いQRコードを作成した店舗名でフィルターします。
1113
+ example: 'bill test shop1'
1114
+ shop_id:
1115
+ type: string
1116
+ format: uuid
1117
+ summary: '店舗ID'
1118
+ description: 支払いQRコードを作成した店舗IDでフィルターします。
1119
+ lower_limit_amount:
1120
+ type: integer
1121
+ minimum: 0
1122
+ format: decimal
1123
+ summary: '金額の範囲によるフィルタ(下限)'
1124
+ description: 支払いQRコードの金額の下限を指定してフィルターします。
1125
+ upper_limit_amount:
1126
+ type: integer
1127
+ minimum: 0
1128
+ format: decimal
1129
+ summary: '金額の範囲によるフィルタ(上限)'
1130
+ description: 支払いQRコードの金額の上限を指定してフィルターします。
1131
+ is_disabled:
1132
+ type: boolean
1133
+ summary: '支払いQRコードが無効化されているかどうか'
1134
+ description: 支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
1135
+ responses:
1136
+ '200':
1137
+ description: OK
1138
+ content:
1139
+ application/json:
1140
+ schema:
1141
+ $ref: '#/components/schemas/PaginatedBills'
1142
+ '400':
1143
+ $ref: '#/components/responses/BadRequest'
1144
+ '403':
1145
+ $ref: '#/components/responses/Forbidden'
1146
+ post:
1147
+ summary: '支払いQRコードの発行'
1148
+ description: 支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
1149
+ x-pokepay-operator-name: "CreateBill"
1150
+ x-pokepay-allow-server-side: true
1151
+ requestBody:
1152
+ required: true
1153
+ content:
1154
+ application/json:
1155
+ schema:
1156
+ required: ["private_money_id", "shop_id"]
1157
+ properties:
1158
+ amount:
1159
+ type: number
1160
+ minimum: 0
1161
+ nullable: true
1162
+ format: decimal
1163
+ summary: '支払い額'
1164
+ description: 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
1165
+ private_money_id:
1166
+ type: string
1167
+ format: uuid
1168
+ summary: '支払いマネーのマネーID'
1169
+ shop_id:
1170
+ type: string
1171
+ format: uuid
1172
+ summary: '支払い先(受け取り人)の店舗ID'
1173
+ description:
1174
+ type: string
1175
+ maxLength: 200
1176
+ summary: '説明文(アプリ上で取引の説明文として表示される)'
1177
+ example: 'test bill'
1178
+ responses:
1179
+ '200':
1180
+ description: OK
1181
+ content:
1182
+ application/json:
1183
+ schema:
1184
+ $ref: '#/components/schemas/Bill'
1185
+ '400':
1186
+ $ref: '#/components/responses/BadRequest'
1187
+ '403':
1188
+ $ref: '#/components/responses/Forbidden'
1189
+ '422':
1190
+ $ref: '#/components/responses/UnprocessableEntity'
1191
+
1192
+ /bills/{bill_id}:
1193
+ patch:
1194
+ summary: '支払いQRコードの更新'
1195
+ description: 支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
1196
+ x-pokepay-operator-name: "UpdateBill"
1197
+ x-pokepay-allow-server-side: true
1198
+ parameters:
1199
+ - in: path
1200
+ name: bill_id
1201
+ required: true
1202
+ schema:
1203
+ type: string
1204
+ format: uuid
1205
+ summary: '支払いQRコードのID'
1206
+ description: |-
1207
+ 更新対象の支払いQRコードのIDです。
1208
+ requestBody:
1209
+ required: true
1210
+ content:
1211
+ application/json:
1212
+ schema:
1213
+ properties:
1214
+ amount:
1215
+ type: number
1216
+ minimum: 0
1217
+ nullable: true
1218
+ format: decimal
1219
+ summary: '支払い額'
1220
+ description: 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
1221
+ description:
1222
+ type: string
1223
+ maxLength: 200
1224
+ summary: '説明文'
1225
+ description: 支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
1226
+ example: 'test bill'
1227
+ is_disabled:
1228
+ type: boolean
1229
+ summary: '無効化されているかどうか'
1230
+ description: 支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
1231
+ responses:
1232
+ '200':
1233
+ description: OK
1234
+ content:
1235
+ application/json:
1236
+ schema:
1237
+ $ref: '#/components/schemas/Bill'
1238
+ '400':
1239
+ $ref: '#/components/responses/BadRequest'
1240
+ '403':
1241
+ $ref: '#/components/responses/Forbidden'
1242
+ '404':
1243
+ $ref: '#/components/responses/NotFound'
1244
+ /checks:
1245
+ post:
1246
+ summary: 'チャージQRコードの発行'
1247
+ x-pokepay-operator-name: "CreateCheck"
1248
+ requestBody:
1249
+ required: true
1250
+ content:
1251
+ application/json:
1252
+ schema:
1253
+ required: ["account_id"]
1254
+ x-pokepay-conditional-parameters: {or: [money_amount, point_amount]}
1255
+ properties:
1256
+ money_amount:
1257
+ type: number
1258
+ minimum: 0
1259
+ format: decimal
1260
+ summary: '付与マネー額'
1261
+ point_amount:
1262
+ type: number
1263
+ minimum: 0
1264
+ format: decimal
1265
+ summary: '付与ポイント額'
1266
+ account_id:
1267
+ type: string
1268
+ format: uuid
1269
+ summary: '送金元の店舗アカウントID'
1270
+ description:
1271
+ type: string
1272
+ maxLength: 200
1273
+ summary: '説明文(アプリ上で取引の説明文として表示される)'
1274
+ example: 'test check'
1275
+ is_onetime:
1276
+ type: boolean
1277
+ summary: 'ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)'
1278
+ description: |
1279
+ チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
1280
+ `false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
1281
+ usage_limit:
1282
+ type: integer
1283
+ nullable: true
1284
+ summary: 'ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数'
1285
+ description: |
1286
+ 複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
1287
+ 省略すると無制限に読み取り可能なチャージQRコードになります。
1288
+ チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
1289
+ expires_at:
1290
+ type: string
1291
+ format: date-time
1292
+ summary: 'チャージQR自体の失効日時'
1293
+ point_expires_at:
1294
+ type: string
1295
+ format: date-time
1296
+ summary: 'チャージQRによって付与されるポイントの失効日時'
1297
+ point_expires_in_days:
1298
+ type: integer
1299
+ minimum: 1
1300
+ summary: 'チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)'
1301
+ example: 60
1302
+ bear_point_account:
1303
+ type: string
1304
+ format: uuid
1305
+ summary: 'ポイント額を負担する店舗アカウントのID'
1306
+ responses:
1307
+ '200':
1308
+ description: OK
1309
+ content:
1310
+ application/json:
1311
+ schema:
1312
+ $ref: '#/components/schemas/Check'
1313
+ '400':
1314
+ $ref: '#/components/responses/InvalidParameters'
1315
+ /transactions:
1316
+ get:
1317
+ summary: '取引履歴を取得する'
1318
+ description: 取引一覧を返します。
1319
+ x-pokepay-operator-name: "ListTransactions"
1320
+ x-pokepay-allow-server-side: true
1321
+ requestBody:
1322
+ required: true
1323
+ content:
1324
+ application/json:
1325
+ schema:
1326
+ properties:
1327
+ from:
1328
+ type: string
1329
+ format: date-time
1330
+ summary: '開始日時'
1331
+ description: |-
1332
+ 抽出期間の開始日時です。
1333
+
1334
+ フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
1335
+ to:
1336
+ type: string
1337
+ format: date-time
1338
+ summary: '終了日時'
1339
+ description: |-
1340
+ 抽出期間の終了日時です。
1341
+
1342
+ フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
1343
+ page:
1344
+ type: integer
1345
+ minimum: 1
1346
+ summary: 'ページ番号'
1347
+ description: 取得したいページ番号です。
1348
+ example: 1
1349
+ per_page:
1350
+ type: integer
1351
+ minimum: 1
1352
+ summary: '1ページ分の取引数'
1353
+ description: 1ページ分の取引数です。
1354
+ example: 50
1355
+ shop_id:
1356
+ type: string
1357
+ format: uuid
1358
+ summary: '店舗ID'
1359
+ description: |-
1360
+ 店舗IDです。
1361
+
1362
+ フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
1363
+ customer_id:
1364
+ type: string
1365
+ format: uuid
1366
+ summary: 'エンドユーザーID'
1367
+ description: |-
1368
+ エンドユーザーIDです。
1369
+
1370
+ フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
1371
+ customer_name:
1372
+ type: string
1373
+ maxLength: 256
1374
+ summary: 'エンドユーザー名'
1375
+ description: |-
1376
+ エンドユーザー名です。
1377
+
1378
+ フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
1379
+ example: 太郎
1380
+ terminal_id:
1381
+ type: string
1382
+ format: uuid
1383
+ summary: '端末ID'
1384
+ description: |-
1385
+ 端末IDです。
1386
+
1387
+ フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
1388
+ transaction_id:
1389
+ type: string
1390
+ format: uuid
1391
+ summary: '取引ID'
1392
+ description: |-
1393
+ 取引IDです。
1394
+
1395
+ フィルターとして使われ、指定された取引のみ一覧に表示されます。
1396
+ organization_code:
1397
+ type: string
1398
+ pattern: '^[a-zA-Z0-9-]*$'
1399
+ maxLength: 32
1400
+ summary: '組織コード'
1401
+ description: |-
1402
+ 組織コードです。
1403
+
1404
+ フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
1405
+ example: 'pocketchange'
1406
+ private_money_id:
1407
+ type: string
1408
+ format: uuid
1409
+ summary: 'マネーID'
1410
+ description: |-
1411
+ マネーIDです。
1412
+
1413
+ フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
1414
+ is_modified:
1415
+ type: boolean
1416
+ summary: 'キャンセルフラグ'
1417
+ description: |-
1418
+ キャンセルフラグです。
1419
+
1420
+ これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
1421
+ デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
1422
+ types:
1423
+ type: array
1424
+ summary: '取引種別 (複数指定可)、チャージ=topup、支払い=payment'
1425
+ example: '["topup", "payment"]'
1426
+ description: |-
1427
+ 取引の種類でフィルターします。
1428
+
1429
+ 以下の種類を指定できます。
1430
+
1431
+ 1. topup
1432
+ 店舗からエンドユーザーへの送金取引(チャージ)
1433
+
1434
+ 2. payment
1435
+ エンドユーザーから店舗への送金取引(支払い)
1436
+
1437
+ 3. exchange-outflow
1438
+   他マネーへの流出
1439
+
1440
+ 4. exchange-inflow
1441
+ 他マネーからの流入
1442
+ items:
1443
+ type: string
1444
+ enum: [topup, payment, exchange_outflow, exchange_inflow]
1445
+ responses:
1446
+ '200':
1447
+ description: OK
1448
+ content:
1449
+ application/json:
1450
+ schema:
1451
+ $ref: '#/components/schemas/PaginatedTransaction'
1452
+ '400':
1453
+ $ref: '#/components/responses/InvalidParameters'
1454
+ post:
1455
+ x-pokepay-operator-name: "CreateTransaction"
1456
+ x-pokepay-allow-server-side: true
1457
+ deprecated: true
1458
+ requestBody:
1459
+ required: true
1460
+ content:
1461
+ application/json:
1462
+ schema:
1463
+ required: ["private_money_id", "shop_id", "customer_id"]
1464
+ properties:
1465
+ shop_id:
1466
+ type: string
1467
+ format: uuid
1468
+ customer_id:
1469
+ type: string
1470
+ format: uuid
1471
+ private_money_id:
1472
+ type: string
1473
+ format: uuid
1474
+ money_amount:
1475
+ type: integer
1476
+ format: decimal
1477
+ minimum: 0
1478
+ point_amount:
1479
+ type: integer
1480
+ format: decimal
1481
+ minimum: 0
1482
+ description:
1483
+ type: string
1484
+ maxLength: 200
1485
+ responses:
1486
+ '200':
1487
+ description: OK
1488
+ content:
1489
+ application/json:
1490
+ schema:
1491
+ $ref: '#/components/schemas/Transaction'
1492
+ '400':
1493
+ $ref: '#/components/responses/BadRequest'
1494
+ '403':
1495
+ $ref: '#/components/responses/Forbidden'
1496
+ '422':
1497
+ $ref: '#/components/responses/UnprocessableEntity'
1498
+ /transactions/topup:
1499
+ post:
1500
+ summary: 'チャージする'
1501
+ description: チャージ取引を作成します。
1502
+ x-pokepay-operator-name: "CreateTopupTransaction"
1503
+ x-pokepay-allow-server-side: true
1504
+ requestBody:
1505
+ required: true
1506
+ content:
1507
+ application/json:
1508
+ schema:
1509
+ required: ["private_money_id", "shop_id", "customer_id"]
1510
+ properties:
1511
+ shop_id:
1512
+ type: string
1513
+ format: uuid
1514
+ summary: '店舗ID'
1515
+ description: |-
1516
+ 店舗IDです。
1517
+
1518
+ 送金元の店舗を指定します。
1519
+ customer_id:
1520
+ type: string
1521
+ format: uuid
1522
+ summary: 'エンドユーザーのID'
1523
+ description: |-
1524
+ エンドユーザーIDです。
1525
+
1526
+ 送金先のエンドユーザーを指定します。
1527
+ private_money_id:
1528
+ type: string
1529
+ format: uuid
1530
+ summary: 'マネーID'
1531
+ description: |-
1532
+ マネーIDです。
1533
+
1534
+ マネーを指定します。
1535
+ bear_point_shop_id:
1536
+ type: string
1537
+ format: uuid
1538
+ summary: 'ポイント支払時の負担店舗ID'
1539
+ description: |-
1540
+ ポイント支払時の負担店舗IDです。
1541
+
1542
+ ポイント支払い時に実際お金を負担する店舗を指定します。
1543
+ money_amount:
1544
+ type: number
1545
+ minimum: 0
1546
+ summary: 'マネー額'
1547
+ description: |-
1548
+ マネー額です。
1549
+
1550
+ 送金するマネー額を指定します。
1551
+ point_amount:
1552
+ type: number
1553
+ minimum: 0
1554
+ summary: 'ポイント額'
1555
+ description: |-
1556
+ ポイント額です。
1557
+
1558
+ 送金するポイント額を指定します。
1559
+ description:
1560
+ type: string
1561
+ maxLength: 200
1562
+ summary: '取引履歴に表示する説明文'
1563
+ description: |-
1564
+ 取引説明文です。
1565
+
1566
+ 任意入力で、取引履歴に表示される説明文です。
1567
+ example: 初夏のチャージキャンペーン
1568
+ responses:
1569
+ '200':
1570
+ description: OK
1571
+ content:
1572
+ application/json:
1573
+ schema:
1574
+ $ref: '#/components/schemas/Transaction'
1575
+ '400':
1576
+ $ref: '#/components/responses/BadRequest'
1577
+ '403':
1578
+ $ref: '#/components/responses/Forbidden'
1579
+ '422':
1580
+ $ref: '#/components/responses/UnprocessableEntity'
1581
+ /transactions/topup/check:
1582
+ post:
1583
+ summary: 'チャージQRコードを読み取ることでチャージする'
1584
+ description: |
1585
+ 通常チャージQRコードはエンドユーザのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
1586
+
1587
+ エンドユーザから受け取ったチャージ用QRコードのIDをエンドユーザIDと共に渡すことでチャージ取引が作られます。
1588
+ x-pokepay-operator-name: "CreateTopupTransactionWithCheck"
1589
+ x-pokepay-allow-server-side: true
1590
+ requestBody:
1591
+ required: true
1592
+ content:
1593
+ application/json:
1594
+ schema:
1595
+ required: ["check_id", "customer_id"]
1596
+ properties:
1597
+ check_id:
1598
+ type: string
1599
+ format: uuid
1600
+ summary: 'チャージ用QRコードのID'
1601
+ description: |-
1602
+ チャージ用QRコードのIDです。
1603
+
1604
+ QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
1605
+ customer_id:
1606
+ type: string
1607
+ format: uuid
1608
+ summary: 'エンドユーザーのID'
1609
+ description: |-
1610
+ エンドユーザーIDです。
1611
+
1612
+ 送金先のエンドユーザーを指定します。
1613
+ responses:
1614
+ '200':
1615
+ description: OK
1616
+ content:
1617
+ application/json:
1618
+ schema:
1619
+ $ref: '#/components/schemas/Transaction'
1620
+ '400':
1621
+ $ref: '#/components/responses/BadRequest'
1622
+ '403':
1623
+ $ref: '#/components/responses/Forbidden'
1624
+ '404':
1625
+ $ref: '#/components/responses/NotFound'
1626
+ '422':
1627
+ $ref: '#/components/responses/UnprocessableEntity'
1628
+ /transactions/payment:
1629
+ post:
1630
+ summary: '支払いする'
1631
+ description: |
1632
+ 支払取引を作成します。
1633
+ 支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
1634
+ x-pokepay-operator-name: "CreatePaymentTransaction"
1635
+ x-pokepay-allow-server-side: true
1636
+ requestBody:
1637
+ required: true
1638
+ content:
1639
+ application/json:
1640
+ schema:
1641
+ required: ["private_money_id", "shop_id", "customer_id", "amount"]
1642
+ properties:
1643
+ shop_id:
1644
+ type: string
1645
+ format: uuid
1646
+ summary: '店舗ID'
1647
+ description: |-
1648
+ 店舗IDです。
1649
+
1650
+ 送金先の店舗を指定します。
1651
+ customer_id:
1652
+ type: string
1653
+ format: uuid
1654
+ summary: 'エンドユーザーID'
1655
+ description: |-
1656
+ エンドユーザーIDです。
1657
+
1658
+ 送金元のエンドユーザーを指定します。
1659
+ private_money_id:
1660
+ type: string
1661
+ format: uuid
1662
+ summary: 'マネーID'
1663
+ description: |-
1664
+ マネーIDです。
1665
+
1666
+ マネーを指定します。
1667
+ amount:
1668
+ type: number
1669
+ minimum: 0
1670
+ summary: '支払い額'
1671
+ description: |-
1672
+ マネー額です。
1673
+
1674
+ 送金するマネー額を指定します。
1675
+ description:
1676
+ type: string
1677
+ maxLength: 200
1678
+ summary: '取引履歴に表示する説明文'
1679
+ description: |-
1680
+ 取引説明文です。
1681
+
1682
+ 任意入力で、取引履歴に表示される説明文です。
1683
+ example: たい焼き(小倉)
1684
+ responses:
1685
+ '200':
1686
+ description: OK
1687
+ content:
1688
+ application/json:
1689
+ schema:
1690
+ $ref: '#/components/schemas/Transaction'
1691
+ '400':
1692
+ $ref: '#/components/responses/BadRequest'
1693
+ '403':
1694
+ $ref: '#/components/responses/Forbidden'
1695
+ '422':
1696
+ $ref: '#/components/responses/UnprocessableEntity'
1697
+ /transactions/transfer:
1698
+ post:
1699
+ summary: '個人間送金'
1700
+ description: |
1701
+ エンドユーザー間での送金取引(個人間送金)を作成します。
1702
+ 個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
1703
+ x-pokepay-operator-name: "CreateTransferTransaction"
1704
+ x-pokepay-allow-server-side: true
1705
+ requestBody:
1706
+ required: true
1707
+ content:
1708
+ application/json:
1709
+ schema:
1710
+ required: ["private_money_id", "sender_id", "receiver_id", "amount"]
1711
+ properties:
1712
+ sender_id:
1713
+ type: string
1714
+ format: uuid
1715
+ summary: '送金元ユーザーID'
1716
+ description: |-
1717
+ エンドユーザーIDです。
1718
+
1719
+ 送金元のエンドユーザー(送り主)を指定します。
1720
+ receiver_id:
1721
+ type: string
1722
+ format: uuid
1723
+ summary: '受取ユーザーID'
1724
+ description: |-
1725
+ エンドユーザーIDです。
1726
+
1727
+ 送金先のエンドユーザー(受け取り人)を指定します。
1728
+ private_money_id:
1729
+ type: string
1730
+ format: uuid
1731
+ summary: 'マネーID'
1732
+ description: |-
1733
+ マネーIDです。
1734
+
1735
+ マネーを指定します。
1736
+ amount:
1737
+ type: number
1738
+ minimum: 0
1739
+ summary: '送金額'
1740
+ description: |-
1741
+ マネー額です。
1742
+
1743
+ 送金するマネー額を指定します。
1744
+ description:
1745
+ type: string
1746
+ maxLength: 200
1747
+ summary: '取引履歴に表示する説明文'
1748
+ description: |-
1749
+ 取引説明文です。
1750
+
1751
+ 任意入力で、取引履歴に表示される説明文です。
1752
+ example: たい焼き(小倉)
1753
+ responses:
1754
+ '200':
1755
+ description: OK
1756
+ content:
1757
+ application/json:
1758
+ schema:
1759
+ $ref: '#/components/schemas/Transaction'
1760
+ '400':
1761
+ $ref: '#/components/responses/BadRequest'
1762
+ '403':
1763
+ $ref: '#/components/responses/Forbidden'
1764
+ '422':
1765
+ $ref: '#/components/responses/UnprocessableEntity'
1766
+ /transactions/exchange:
1767
+ post:
1768
+ x-pokepay-allow-server-side: true
1769
+ requestBody:
1770
+ required: true
1771
+ content:
1772
+ application/json:
1773
+ schema:
1774
+ required: ["user_id", "sender_private_money_id", "receiver_private_money_id", "amount"]
1775
+ properties:
1776
+ user_id:
1777
+ type: string
1778
+ format: uuid
1779
+ sender_private_money_id:
1780
+ type: string
1781
+ format: uuid
1782
+ receiver_private_money_id:
1783
+ type: string
1784
+ format: uuid
1785
+ amount:
1786
+ type: number
1787
+ minimum: 1
1788
+ description:
1789
+ type: string
1790
+ maxLength: 200
1791
+ responses:
1792
+ '200':
1793
+ description: OK
1794
+ content:
1795
+ application/json:
1796
+ schema:
1797
+ $ref: '#/components/schemas/Transaction'
1798
+ '400':
1799
+ $ref: '#/components/responses/BadRequest'
1800
+ '422':
1801
+ $ref: '#/components/responses/UnprocessableEntity'
1802
+ /transactions/bulk:
1803
+ post:
1804
+ summary: CSVファイル一括取引
1805
+ description: CSVファイルから一括取引をします。
1806
+ x-pokepay-operator-name: "BulkCreateTransaction"
1807
+ x-pokepay-allow-server-side: true
1808
+ requestBody:
1809
+ required: true
1810
+ content:
1811
+ application/json:
1812
+ schema:
1813
+ required: ["name", "content", "request_id"]
1814
+ properties:
1815
+ name:
1816
+ type: string
1817
+ maxLength: 32
1818
+ summary: 一括取引タスク名
1819
+ description: |-
1820
+ 一括取引タスクの管理用の名前です。
1821
+ description:
1822
+ type: string
1823
+ maxLength: 128
1824
+ summary: 一括取引の説明
1825
+ description: |-
1826
+ 一括取引タスクの管理用の説明文です。
1827
+ content:
1828
+ type: string
1829
+ summary: 取引する情報のCSV
1830
+ description: |-
1831
+ 一括取引する情報を書いたCSVの文字列です。
1832
+ 1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
1833
+ カラムは以下の7つです。任意のカラムには空文字を指定します。
1834
+
1835
+ - `type`: 取引種別
1836
+ - 必須。'topup' または 'payment'
1837
+ - `sender_account_id`: 送金ウォレットID
1838
+ - 必須。UUID
1839
+ - `receiver_account_id`: 受取ウォレットID
1840
+ - 必須。UUID
1841
+ - `money_amount`: マネー額
1842
+ - 任意。ただし `point_amount` といずれかが必須。0以上の数字
1843
+ - `point_amount`: ポイント額
1844
+ - 任意。ただし `money_amount` といずれかが必須。0以上の数字
1845
+ - `bear_account_id`: ポイント負担ウォレットID
1846
+ - `point_amount` があるときは必須。UUID
1847
+ - `point_expires_at`: ポイントの有効期限
1848
+ - 任意。指定がないときはマネーに設定された有効期限を適用
1849
+ request_id:
1850
+ type: string
1851
+ minLength: 36
1852
+ maxLength: 36
1853
+ summary: リクエストID
1854
+ description: |-
1855
+ 重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
1856
+ responses:
1857
+ '200':
1858
+ description: OK
1859
+ content:
1860
+ application/json:
1861
+ schema:
1862
+ $ref: '#/components/schemas/BulkTransaction'
1863
+ '400':
1864
+ $ref: '#/components/responses/BadRequest'
1865
+ '403':
1866
+ $ref: '#/components/responses/Forbidden'
1867
+ '409':
1868
+ $ref: '#/components/responses/Conflict'
1869
+ /transactions/{transaction_id}:
1870
+ get:
1871
+ summary: '取引情報を取得する'
1872
+ description: 取引を取得します。
1873
+ x-pokepay-operator-name: "GetTransaction"
1874
+ x-pokepay-allow-server-side: true
1875
+ parameters:
1876
+ - in: path
1877
+ name: transaction_id
1878
+ required: true
1879
+ schema:
1880
+ type: string
1881
+ format: uuid
1882
+ summary: '取引ID'
1883
+ description: |-
1884
+ 取引IDです。
1885
+
1886
+ フィルターとして使われ、指定した取引IDの取引を取得します。
1887
+ responses:
1888
+ '200':
1889
+ description: OK
1890
+ content:
1891
+ application/json:
1892
+ schema:
1893
+ $ref: '#/components/schemas/Transaction'
1894
+ '400':
1895
+ $ref: '#/components/responses/InvalidParameters'
1896
+ '403':
1897
+ $ref: '#/components/responses/Forbidden'
1898
+ '404':
1899
+ $ref: '#/components/responses/NotFound'
1900
+ /transactions/{transaction_id}/refund:
1901
+ post:
1902
+ summary: 返金する
1903
+ x-pokepay-operator-name: RefundTransaction
1904
+ parameters:
1905
+ - in: path
1906
+ name: transaction_id
1907
+ required: true
1908
+ schema:
1909
+ type: string
1910
+ format: uuid
1911
+ summary: '取引ID'
1912
+ requestBody:
1913
+ required: true
1914
+ content:
1915
+ application/json:
1916
+ schema:
1917
+ properties:
1918
+ description:
1919
+ type: string
1920
+ maxLength: 200
1921
+ summary: '取引履歴に表示する返金事由'
1922
+ example: '返品対応のため'
1923
+ responses:
1924
+ '200':
1925
+ description: OK
1926
+ content:
1927
+ application/json:
1928
+ schema:
1929
+ $ref: '#/components/schemas/Transfer'
1930
+ '403':
1931
+ $ref: '#/components/responses/Forbidden'
1932
+ '404':
1933
+ $ref: '#/components/responses/NotFound'
1934
+ '422':
1935
+ $ref: '#/components/responses/UnprocessableEntity'
1936
+ /transfers:
1937
+ get:
1938
+ x-pokepay-operator-name: "ListTransfers"
1939
+ x-pokepay-allow-server-side: true
1940
+ requestBody:
1941
+ required: true
1942
+ content:
1943
+ application/json:
1944
+ schema:
1945
+ properties:
1946
+ from:
1947
+ type: string
1948
+ format: date-time
1949
+ to:
1950
+ type: string
1951
+ format: date-time
1952
+ page:
1953
+ type: integer
1954
+ minimum: 1
1955
+ per_page:
1956
+ type: integer
1957
+ minimum: 1
1958
+ shop_id:
1959
+ type: string
1960
+ format: uuid
1961
+ shop_name:
1962
+ type: string
1963
+ maxLength: 256
1964
+ customer_id:
1965
+ type: string
1966
+ format: uuid
1967
+ customer_name:
1968
+ type: string
1969
+ maxLength: 256
1970
+ transaction_id:
1971
+ type: string
1972
+ format: uuid
1973
+ private_money_id:
1974
+ type: string
1975
+ format: uuid
1976
+ is_modified:
1977
+ type: boolean
1978
+ transaction_types:
1979
+ type: array
1980
+ items:
1981
+ type: string
1982
+ enum: [topup, payment, transfer, exchange]
1983
+ transfer_types:
1984
+ type: array
1985
+ items:
1986
+ type: string
1987
+ enum: [topup, payment, exchange, transfer]
1988
+ responses:
1989
+ '200':
1990
+ description: OK
1991
+ content:
1992
+ application/json:
1993
+ schema:
1994
+ $ref: '#/components/schemas/PaginatedTransfers'
1995
+ '400':
1996
+ $ref: '#/components/responses/InvalidParameters'
1997
+
1998
+ /organizations:
1999
+ post:
2000
+ summary: '新規加盟店組織を追加する'
2001
+ x-pokepay-operator-name: "CreateOrganization"
2002
+ requestBody:
2003
+ required: true
2004
+ content:
2005
+ application/json:
2006
+ schema:
2007
+ required: ["code", "name", "private_money_ids", "issuer_admin_user_email", "member_admin_user_email"]
2008
+ properties:
2009
+ code:
2010
+ type: string
2011
+ maxLength: 32
2012
+ summary: '新規組織コード'
2013
+ example: ox_supermarket
2014
+ name:
2015
+ type: string
2016
+ maxLength: 256
2017
+ summary: '新規組織名'
2018
+ example: oxスーパー
2019
+ private_money_ids:
2020
+ type: array
2021
+ items:
2022
+ type: string
2023
+ format: uuid
2024
+ minItems: 1
2025
+ summary: '加盟店組織で有効にするマネーIDの配列'
2026
+ issuer_admin_user_email:
2027
+ type: string
2028
+ format: email
2029
+ summary: '発行体担当者メールアドレス'
2030
+ member_admin_user_email:
2031
+ type: string
2032
+ format: email
2033
+ summary: '新規組織担当者メールアドレス'
2034
+ bank_name:
2035
+ type: string
2036
+ maxLength: 64
2037
+ summary: '銀行名'
2038
+ example: XYZ銀行
2039
+ bank_code:
2040
+ type: string
2041
+ pattern: '^$|^[0-9]{4}$'
2042
+ summary: '銀行金融機関コード'
2043
+ example: 99X
2044
+ bank_branch_name:
2045
+ type: string
2046
+ maxLength: 64
2047
+ summary: '銀行支店名'
2048
+ example: ABC支店
2049
+ bank_branch_code:
2050
+ type: string
2051
+ pattern: '^(|[0-9]{3})$'
2052
+ summary: '銀行支店コード'
2053
+ example: 99X
2054
+ bank_account_type:
2055
+ type: string
2056
+ enum: [saving, current, other]
2057
+ summary: '銀行口座種別 (普通=saving, 当座=current, その他=other)'
2058
+ bank_account:
2059
+ type: string
2060
+ maxLength: 7
2061
+ pattern: '[0-9]{0,7}'
2062
+ summary: '銀行口座番号'
2063
+ example: 9999999
2064
+ bank_account_holder_name:
2065
+ # TODO: flico
2066
+ type: string
2067
+ maxLength: 30
2068
+ pattern: '^[0-9A-Zヲア-゚ (-),-/\\「-」]$'
2069
+ summary: '口座名義人名'
2070
+ example: フクザワユキチ
2071
+ contact_name:
2072
+ type: string
2073
+ maxLength: 256
2074
+ summary: '担当者名'
2075
+ example: 佐藤清
2076
+ responses:
2077
+ '200':
2078
+ description: OK
2079
+ content:
2080
+ application/json:
2081
+ schema:
2082
+ $ref: '#/components/schemas/Organization'
2083
+ /shops:
2084
+ get:
2085
+ summary: '店舗一覧を取得する'
2086
+ x-pokepay-operator-name: "ListShops"
2087
+ x-pokepay-allow-server-side: true
2088
+ requestBody:
2089
+ required: true
2090
+ content:
2091
+ application/json:
2092
+ schema:
2093
+ properties:
2094
+ organization_code:
2095
+ type: string
2096
+ pattern: '^[a-zA-Z0-9-]*$'
2097
+ maxLength: 32
2098
+ summary: '組織コード'
2099
+ description: |
2100
+ このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
2101
+ example: 'pocketchange'
2102
+ private_money_id:
2103
+ type: string
2104
+ format: uuid
2105
+ summary: 'マネーID'
2106
+ description: |
2107
+ このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
2108
+ name:
2109
+ type: string
2110
+ minLength: 1
2111
+ maxLength: 256
2112
+ summary: '店舗名'
2113
+ example: 'oxスーパー三田店'
2114
+ description: |
2115
+ このパラメータを渡すとその名前の店舗のみが返されます。
2116
+ postal_code:
2117
+ type: string
2118
+ pattern: '^[0-9]{3}-?[0-9]{4}$'
2119
+ summary: '店舗の郵便番号'
2120
+ description: |
2121
+ このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
2122
+ address:
2123
+ type: string
2124
+ maxLength: 256
2125
+ summary: '店舗の住所'
2126
+ example: '東京都港区芝...'
2127
+ description: |
2128
+ このパラメータを渡すとその住所が登録された店舗のみが返されます。
2129
+ tel:
2130
+ type: string
2131
+ pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
2132
+ summary: '店舗の電話番号'
2133
+ description: |
2134
+ このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
2135
+ email:
2136
+ type: string
2137
+ format: email
2138
+ maxLength: 256
2139
+ summary: '店舗のメールアドレス'
2140
+ description: |
2141
+ このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
2142
+ external_id:
2143
+ type: string
2144
+ maxLength: 36
2145
+ summary: '店舗の外部ID'
2146
+ description: |
2147
+ このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
2148
+ page:
2149
+ type: integer
2150
+ minimum: 1
2151
+ summary: 'ページ番号'
2152
+ description: 取得したいページ番号です。
2153
+ example: 1
2154
+ per_page:
2155
+ type: integer
2156
+ minimum: 1
2157
+ summary: '1ページ分の取引数'
2158
+ description: 1ページ分の取引数です。
2159
+ example: 50
2160
+ responses:
2161
+ '200':
2162
+ description: OK
2163
+ content:
2164
+ application/json:
2165
+ schema:
2166
+ $ref: '#/components/schemas/PaginatedShops'
2167
+ '400':
2168
+ $ref: '#/components/responses/BadRequest'
2169
+ '403':
2170
+ $ref: '#/components/responses/Forbidden'
2171
+ '404':
2172
+ $ref: '#/components/responses/NotFound'
2173
+ '422':
2174
+ $ref: '#/components/responses/UnprocessableEntity'
2175
+ post:
2176
+ summary: '新規店舗を追加する'
2177
+ x-pokepay-operator-name: "CreateShop"
2178
+ x-pokepay-allow-server-side: true
2179
+ requestBody:
2180
+ required: true
2181
+ content:
2182
+ application/json:
2183
+ schema:
2184
+ required: ["shop_name"]
2185
+ properties:
2186
+ shop_name:
2187
+ type: string
2188
+ minLength: 1
2189
+ maxLength: 256
2190
+ summary: '店舗名'
2191
+ example: 'oxスーパー三田店'
2192
+ shop_postal_code:
2193
+ type: string
2194
+ pattern: '^[0-9]{3}-?[0-9]{4}$'
2195
+ summary: '店舗の郵便番号'
2196
+ shop_address:
2197
+ type: string
2198
+ maxLength: 256
2199
+ summary: '店舗の住所'
2200
+ example: '東京都港区芝...'
2201
+ shop_tel:
2202
+ type: string
2203
+ pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
2204
+ summary: '店舗の電話番号'
2205
+ shop_email:
2206
+ type: string
2207
+ format: email
2208
+ maxLength: 256
2209
+ summary: '店舗のメールアドレス'
2210
+ shop_external_id:
2211
+ type: string
2212
+ maxLength: 36
2213
+ summary: '店舗の外部ID'
2214
+ organization_code:
2215
+ type: string
2216
+ pattern: '^[a-zA-Z0-9-]*$'
2217
+ maxLength: 32
2218
+ summary: '組織コード'
2219
+ example: 'ox-supermarket'
2220
+ responses:
2221
+ '200':
2222
+ description: OK
2223
+ content:
2224
+ application/json:
2225
+ schema:
2226
+ $ref: '#/components/schemas/User'
2227
+ '400':
2228
+ $ref: '#/components/responses/InvalidParameters'
2229
+ '403':
2230
+ $ref: '#/components/responses/Forbidden'
2231
+ '409':
2232
+ $ref: '#/components/responses/Conflict'
2233
+ '422':
2234
+ $ref: '#/components/responses/UnprocessableEntity'
2235
+ /private-moneys/{private_money_id}/organization-summaries:
2236
+ get:
2237
+ summary: 決済加盟店の取引サマリを取得する
2238
+ x-pokepay-operator-name: "GetPrivateMoneyOrganizationSummaries"
2239
+ x-pokepay-allow-server-side: true
2240
+ requestBody:
2241
+ required: true
2242
+ content:
2243
+ application/json:
2244
+ schema:
2245
+ x-pokepay-conditional-parameters: {xnor: [from, to]}
2246
+ properties:
2247
+ from:
2248
+ type: string
2249
+ format: date-time
2250
+ summary: '開始日時(toと同時に指定する必要有)'
2251
+ to:
2252
+ type: string
2253
+ format: date-time
2254
+ summary: '終了日時(fromと同時に指定する必要有)'
2255
+ page:
2256
+ type: integer
2257
+ minimum: 1
2258
+ summary: 'ページ番号'
2259
+ example: 1
2260
+ per_page:
2261
+ type: integer
2262
+ minimum: 1
2263
+ summary: '1ページ分の取引数'
2264
+ example: 50
2265
+ parameters:
2266
+ - in: path
2267
+ name: private_money_id
2268
+ required: true
2269
+ schema:
2270
+ type: string
2271
+ format: uuid
2272
+ summary: マネーID
2273
+ responses:
2274
+ '200':
2275
+ description: OK
2276
+ content:
2277
+ application/json:
2278
+ schema:
2279
+ $ref: '#/components/schemas/PaginatedPrivateMoneyOrganizationSummaries'
2280
+ '400':
2281
+ $ref: '#/components/responses/InvalidParameters'
2282
+ '403':
2283
+ $ref: '#/components/responses/Forbidden'
2284
+ '404':
2285
+ $ref: '#/components/responses/NotFound'
2286
+ /customers/transactions:
2287
+ get:
2288
+ summary: '取引履歴を取得する'
2289
+ description: '取引一覧を返します。'
2290
+ x-pokepay-operator-name: "ListCustomerTransactions"
2291
+ x-pokepay-allow-server-side: true
2292
+ requestBody:
2293
+ required: true
2294
+ content:
2295
+ application/json:
2296
+ schema:
2297
+ required: ["private_money_id"]
2298
+ properties:
2299
+ private_money_id:
2300
+ type: string
2301
+ format: uuid
2302
+ summary: 'マネーID'
2303
+ description: |-
2304
+ マネーIDです。
2305
+ フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
2306
+ sender_customer_id:
2307
+ type: string
2308
+ format: uuid
2309
+ summary: '送金エンドユーザーID'
2310
+ description: |-
2311
+ 送金ユーザーIDです。
2312
+
2313
+ フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
2314
+ receiver_customer_id:
2315
+ type: string
2316
+ format: uuid
2317
+ summary: '受取エンドユーザーID'
2318
+ description: |-
2319
+ 受取ユーザーIDです。
2320
+
2321
+ フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
2322
+ type:
2323
+ type: string
2324
+ summary: '取引種別、チャージ=topup、支払い=payment、個人間送金=transfer'
2325
+ description: |-
2326
+ 取引の種類でフィルターします。
2327
+
2328
+ 以下の種類を指定できます。
2329
+
2330
+ 1. topup
2331
+ 店舗からエンドユーザーへの送金取引(チャージ)
2332
+ 2. payment
2333
+ エンドユーザーから店舗への送金取引(支払い)
2334
+ 3. exchange
2335
+ 他マネーへの流出(outflow)/他マネーからの流入(inflow)
2336
+ 4. transfer
2337
+ 個人間送金
2338
+ is_modified:
2339
+ type: boolean
2340
+ summary: 'キャンセル済みかどうか'
2341
+ description: |-
2342
+ キャンセル済みかどうかを判定するフラグです。
2343
+
2344
+ これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
2345
+ falseを指定するとキャンセルされていない取引のみ一覧に表示されます
2346
+ 何も指定しなければキャンセルの有無にかかわらず一覧に表示されます。
2347
+ from:
2348
+ type: string
2349
+ format: date-time
2350
+ summary: '開始日時'
2351
+ description: |-
2352
+ 抽出期間の開始日時です。
2353
+
2354
+ フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
2355
+ to:
2356
+ type: string
2357
+ format: date-time
2358
+ summary: '終了日時'
2359
+ description: |-
2360
+ 抽出期間の終了日時です。
2361
+
2362
+ フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
2363
+ page:
2364
+ type: integer
2365
+ minimum: 1
2366
+ summary: 'ページ番号'
2367
+ description: 取得したいページ番号です。
2368
+ example: 1
2369
+ per_page:
2370
+ type: integer
2371
+ minimum: 1
2372
+ summary: '1ページ分の取引数'
2373
+ description: 1ページ分の取引数です。
2374
+ example: 50
2375
+ responses:
2376
+ '200':
2377
+ description: OK
2378
+ content:
2379
+ application/json:
2380
+ schema:
2381
+ $ref: '#/components/schemas/PaginatedTransaction'
2382
+ '400':
2383
+ $ref: '#/components/responses/InvalidParameters'
2384
+ '403':
2385
+ $ref: '#/components/responses/Forbidden'
2386
+ '422':
2387
+ $ref: '#/components/responses/UnprocessableEntity'