pokepay_partner_ruby_sdk 0.1.7 → 0.1.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/docs/index.md +1752 -347
- data/lib/pokepay_partner_ruby_sdk.rb +20 -0
- data/lib/pokepay_partner_ruby_sdk/client.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/request/bulk_create_transaction.rb +17 -0
- data/lib/pokepay_partner_ruby_sdk/request/cancel_cashtray.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_cashtray.rb +17 -0
- data/lib/pokepay_partner_ruby_sdk/request/create_shop_v2.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_cashtray.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_customer_accounts.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_private_moneys.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_shop.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/get_shop_accounts.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/update_cashtray.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/request/update_shop.rb +15 -0
- data/lib/pokepay_partner_ruby_sdk/response/bulk_transaction.rb +27 -0
- data/lib/pokepay_partner_ruby_sdk/response/cashtray.rb +24 -0
- data/lib/pokepay_partner_ruby_sdk/response/cashtray_attempt.rb +20 -0
- data/lib/pokepay_partner_ruby_sdk/response/cashtray_with_result.rb +30 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/paginated_private_moneys.rb +16 -0
- data/lib/pokepay_partner_ruby_sdk/response/private_money.rb +0 -2
- data/lib/pokepay_partner_ruby_sdk/response/shop_account.rb +20 -0
- data/lib/pokepay_partner_ruby_sdk/response/shop_with_accounts.rb +27 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/partner.yaml +1333 -206
- metadata +26 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0df7b536381fe94cea6bae221c87207b84efcbde62a2a8dcab3d52d75afcf753
|
|
4
|
+
data.tar.gz: cc91f0a961f1833231ad906070d695b4aace35364efc670f3675e5d8db9c2940
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 78a1d7c51afa48c63decb05c583fad6b43ed846cb22d3c8c86c62c3244b4a166079588da3cfb553808426f459949b6f552ecdb2ab84b80e7e42c8c7ca6542cd0
|
|
7
|
+
data.tar.gz: 35b7973c40848c9ec93a10d63d19f2144fd2f2d136cc40cebe7c4325808aec4affd718a8cf5df225bb648994279a804588c259586ae2042663a9eaf0c0d4eb44
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
pokepay_partner_ruby_sdk (0.1.
|
|
4
|
+
pokepay_partner_ruby_sdk (0.1.11)
|
|
5
5
|
inifile (~> 3.0.0)
|
|
6
6
|
json (~> 2.3.0)
|
|
7
7
|
openssl (~> 2.1.2)
|
|
@@ -11,8 +11,8 @@ GEM
|
|
|
11
11
|
specs:
|
|
12
12
|
inifile (3.0.0)
|
|
13
13
|
ipaddr (1.2.2)
|
|
14
|
-
json (2.3.
|
|
15
|
-
minitest (5.14.
|
|
14
|
+
json (2.3.1)
|
|
15
|
+
minitest (5.14.4)
|
|
16
16
|
openssl (2.1.2)
|
|
17
17
|
ipaddr
|
|
18
18
|
rake (13.0.1)
|
|
@@ -27,4 +27,4 @@ DEPENDENCIES
|
|
|
27
27
|
rake (~> 13.0)
|
|
28
28
|
|
|
29
29
|
BUNDLED WITH
|
|
30
|
-
2.
|
|
30
|
+
2.2.3
|
data/docs/index.md
CHANGED
|
@@ -142,662 +142,1583 @@ response.body
|
|
|
142
142
|
<a name="api-operations"></a>
|
|
143
143
|
## API Operations
|
|
144
144
|
|
|
145
|
+
- [ListTransactions](#list-transactions): 取引履歴を取得する
|
|
146
|
+
- [CreateTransaction](#create-transaction): チャージする(廃止予定)
|
|
147
|
+
- [CreateTopupTransaction](#create-topup-transaction): チャージする
|
|
148
|
+
- [CreatePaymentTransaction](#create-payment-transaction): 支払いする
|
|
149
|
+
- [CreateTransferTransaction](#create-transfer-transaction): 個人間送金
|
|
150
|
+
- [CreateExchangeTransaction](#create-exchange-transaction):
|
|
151
|
+
- [GetTransaction](#get-transaction): 取引情報を取得する
|
|
152
|
+
- [ListTransfers](#list-transfers):
|
|
153
|
+
- [CreateTopupTransactionWithCheck](#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
|
|
154
|
+
- [ListBills](#list-bills): 支払いQRコード一覧を表示する
|
|
155
|
+
- [CreateBill](#create-bill): 支払いQRコードの発行
|
|
156
|
+
- [UpdateBill](#update-bill): 支払いQRコードの更新
|
|
157
|
+
- [CreateCashtray](#create-cashtray): Cashtrayを作る
|
|
158
|
+
- [GetCashtray](#get-cashtray): Cashtrayの情報を取得する
|
|
159
|
+
- [CancelCashtray](#cancel-cashtray): Cashtrayを無効化する
|
|
160
|
+
- [UpdateCashtray](#update-cashtray): Cashtrayの情報を更新する
|
|
161
|
+
- [GetAccount](#get-account): ウォレット情報を表示する
|
|
162
|
+
- [UpdateAccount](#update-account): ウォレット情報を更新する
|
|
163
|
+
- [ListAccountBalances](#list-account-balances): エンドユーザーの残高内訳を表示する
|
|
164
|
+
- [ListAccountExpiredBalances](#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
|
|
165
|
+
- [GetCustomerAccounts](#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
|
|
166
|
+
- [CreateCustomerAccount](#create-customer-account): 新規エンドユーザーウォレットを追加する
|
|
167
|
+
- [GetShopAccounts](#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
|
|
168
|
+
- [ListCustomerTransactions](#list-customer-transactions): 取引履歴を取得する
|
|
169
|
+
- [ListShops](#list-shops): 店舗一覧を取得する
|
|
170
|
+
- [CreateShop](#create-shop): 新規店舗を追加する(廃止予定)
|
|
171
|
+
- [CreateShopV2](#create-shop-v2): 新規店舗を追加する
|
|
172
|
+
- [GetShop](#get-shop): 店舗情報を表示する
|
|
173
|
+
- [UpdateShop](#update-shop): 店舗情報を更新する
|
|
174
|
+
- [ListUserAccounts](#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
|
|
175
|
+
- [GetPrivateMoneys](#get-private-moneys): マネー一覧を取得する
|
|
176
|
+
- [GetPrivateMoneyOrganizationSummaries](#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
|
|
177
|
+
- [BulkCreateTransaction](#bulk-create-transaction): CSVファイル一括取引
|
|
145
178
|
### Transaction
|
|
146
|
-
|
|
147
|
-
####
|
|
148
|
-
|
|
179
|
+
<a name="list-transactions"></a>
|
|
180
|
+
#### 取引履歴を取得する
|
|
181
|
+
取引一覧を返します。
|
|
149
182
|
```ruby
|
|
150
|
-
response = $client.send(Pokepay::Request::
|
|
151
|
-
"
|
|
183
|
+
response = $client.send(Pokepay::Request::ListTransactions.new(
|
|
184
|
+
from: "2018-03-23T13:18:22.000000+09:00", # 開始日時
|
|
185
|
+
to: "2021-07-09T00:39:57.000000+09:00", # 終了日時
|
|
186
|
+
page: 1, # ページ番号
|
|
187
|
+
per_page: 50, # 1ページ分の取引数
|
|
188
|
+
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
189
|
+
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # エンドユーザーID
|
|
190
|
+
customer_name: "太郎", # エンドユーザー名
|
|
191
|
+
terminal_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 端末ID
|
|
192
|
+
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 取引ID
|
|
193
|
+
organization_code: "pocketchange", # 組織コード
|
|
194
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
195
|
+
is_modified: true, # キャンセルフラグ
|
|
196
|
+
types: ["topup", "payment"], # 取引種別 (複数指定可)、チャージ=topup、支払い=payment
|
|
197
|
+
description: "店頭QRコードによる支払い" # 取引説明文
|
|
152
198
|
))
|
|
153
199
|
```
|
|
154
200
|
|
|
201
|
+
---
|
|
202
|
+
`from`
|
|
203
|
+
```json
|
|
204
|
+
{
|
|
205
|
+
"type": "string",
|
|
206
|
+
"format": "date-time"
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
抽出期間の開始日時です。
|
|
210
|
+
|
|
211
|
+
フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
`to`
|
|
215
|
+
```json
|
|
216
|
+
{
|
|
217
|
+
"type": "string",
|
|
218
|
+
"format": "date-time"
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
抽出期間の終了日時です。
|
|
222
|
+
|
|
223
|
+
フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
`page`
|
|
227
|
+
```json
|
|
228
|
+
{
|
|
229
|
+
"type": "integer",
|
|
230
|
+
"minimum": 1
|
|
231
|
+
}
|
|
232
|
+
```
|
|
233
|
+
取得したいページ番号です。
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
`per_page`
|
|
237
|
+
```json
|
|
238
|
+
{
|
|
239
|
+
"type": "integer",
|
|
240
|
+
"minimum": 1
|
|
241
|
+
}
|
|
242
|
+
```
|
|
243
|
+
1ページ分の取引数です。
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
`shop_id`
|
|
247
|
+
```json
|
|
248
|
+
{
|
|
249
|
+
"type": "string",
|
|
250
|
+
"format": "uuid"
|
|
251
|
+
}
|
|
252
|
+
```
|
|
253
|
+
店舗IDです。
|
|
254
|
+
|
|
255
|
+
フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
`customer_id`
|
|
259
|
+
```json
|
|
260
|
+
{
|
|
261
|
+
"type": "string",
|
|
262
|
+
"format": "uuid"
|
|
263
|
+
}
|
|
264
|
+
```
|
|
265
|
+
エンドユーザーIDです。
|
|
266
|
+
|
|
267
|
+
フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
`customer_name`
|
|
271
|
+
```json
|
|
272
|
+
{
|
|
273
|
+
"type": "string",
|
|
274
|
+
"maxLength": 256
|
|
275
|
+
}
|
|
276
|
+
```
|
|
277
|
+
エンドユーザー名です。
|
|
278
|
+
|
|
279
|
+
フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
`terminal_id`
|
|
283
|
+
```json
|
|
284
|
+
{
|
|
285
|
+
"type": "string",
|
|
286
|
+
"format": "uuid"
|
|
287
|
+
}
|
|
288
|
+
```
|
|
289
|
+
端末IDです。
|
|
290
|
+
|
|
291
|
+
フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
|
|
292
|
+
|
|
155
293
|
---
|
|
156
294
|
`transaction_id`
|
|
295
|
+
```json
|
|
296
|
+
{
|
|
297
|
+
"type": "string",
|
|
298
|
+
"format": "uuid"
|
|
299
|
+
}
|
|
300
|
+
```
|
|
157
301
|
取引IDです。
|
|
158
302
|
|
|
159
|
-
|
|
303
|
+
フィルターとして使われ、指定された取引のみ一覧に表示されます。
|
|
160
304
|
|
|
161
305
|
---
|
|
162
|
-
|
|
306
|
+
`organization_code`
|
|
307
|
+
```json
|
|
308
|
+
{
|
|
309
|
+
"type": "string",
|
|
310
|
+
"maxLength": 32,
|
|
311
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
|
312
|
+
}
|
|
313
|
+
```
|
|
314
|
+
組織コードです。
|
|
315
|
+
|
|
316
|
+
フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
`private_money_id`
|
|
320
|
+
```json
|
|
321
|
+
{
|
|
322
|
+
"type": "string",
|
|
323
|
+
"format": "uuid"
|
|
324
|
+
}
|
|
325
|
+
```
|
|
326
|
+
マネーIDです。
|
|
327
|
+
|
|
328
|
+
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
|
329
|
+
|
|
330
|
+
---
|
|
331
|
+
`is_modified`
|
|
332
|
+
```json
|
|
333
|
+
{ "type": "boolean" }
|
|
334
|
+
```
|
|
335
|
+
キャンセルフラグです。
|
|
336
|
+
|
|
337
|
+
これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
|
|
338
|
+
デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
`types`
|
|
342
|
+
```json
|
|
343
|
+
{
|
|
344
|
+
"type": "array",
|
|
345
|
+
"items": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"enum": {
|
|
348
|
+
"topup": "payment",
|
|
349
|
+
"exchange_outflow": "exchange_inflow"
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
```
|
|
354
|
+
取引の種類でフィルターします。
|
|
163
355
|
|
|
356
|
+
以下の種類を指定できます。
|
|
357
|
+
|
|
358
|
+
1. topup
|
|
359
|
+
店舗からエンドユーザーへの送金取引(チャージ)
|
|
360
|
+
|
|
361
|
+
2. payment
|
|
362
|
+
エンドユーザーから店舗への送金取引(支払い)
|
|
363
|
+
|
|
364
|
+
3. exchange-outflow
|
|
365
|
+
他マネーへの流出
|
|
366
|
+
|
|
367
|
+
4. exchange-inflow
|
|
368
|
+
他マネーからの流入
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
`description`
|
|
372
|
+
```json
|
|
373
|
+
{
|
|
374
|
+
"type": "string",
|
|
375
|
+
"maxLength": 200
|
|
376
|
+
}
|
|
377
|
+
```
|
|
378
|
+
取引を指定の取引説明文でフィルターします。
|
|
379
|
+
|
|
380
|
+
取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
|
|
381
|
+
|
|
382
|
+
---
|
|
383
|
+
成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
|
|
384
|
+
<a name="create-transaction"></a>
|
|
385
|
+
#### チャージする(廃止予定)
|
|
386
|
+
チャージ取引を作成します。このAPIは廃止予定です。以降は `CreateTopupTransaction` を使用してください。
|
|
387
|
+
```ruby
|
|
388
|
+
response = $client.send(Pokepay::Request::CreateTransaction.new(
|
|
389
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
390
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
391
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
392
|
+
money_amount: 7618,
|
|
393
|
+
point_amount: 7525,
|
|
394
|
+
point_expires_at: "2023-08-25T23:56:49.000000+09:00", # ポイント有効期限
|
|
395
|
+
description: "Y4wthFo0glXBErIUB1p7aPMzXnAdDrY96Gn0OAQ9xSN0zfKx7ivixiVqjgvBNcsQLQxAtJmVTcXWtKUzkNd35gyuBKlwozbM8BIp6WWFtoNM3mKKWyblmmAHRS"
|
|
396
|
+
))
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
---
|
|
400
|
+
`point_expires_at`
|
|
401
|
+
```json
|
|
402
|
+
{
|
|
403
|
+
"type": "string",
|
|
404
|
+
"format": "date-time"
|
|
405
|
+
}
|
|
406
|
+
```
|
|
407
|
+
ポイントをチャージした場合の、付与されるポイントの有効期限です。
|
|
408
|
+
省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
|
|
409
|
+
|
|
410
|
+
---
|
|
411
|
+
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
412
|
+
<a name="create-topup-transaction"></a>
|
|
164
413
|
#### チャージする
|
|
165
414
|
チャージ取引を作成します。
|
|
166
415
|
```ruby
|
|
167
416
|
response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
|
|
168
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
169
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
170
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
171
|
-
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
172
|
-
money_amount:
|
|
173
|
-
point_amount:
|
|
174
|
-
|
|
417
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
418
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーのID
|
|
419
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
420
|
+
bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # ポイント支払時の負担店舗ID
|
|
421
|
+
money_amount: 4950, # マネー額
|
|
422
|
+
point_amount: 8112, # ポイント額
|
|
423
|
+
point_expires_at: "2021-01-08T04:46:28.000000+09:00", # ポイント有効期限
|
|
424
|
+
description: "初夏のチャージキャンペーン" # 取引履歴に表示する説明文
|
|
175
425
|
))
|
|
176
426
|
```
|
|
177
427
|
|
|
178
428
|
---
|
|
179
429
|
`shop_id`
|
|
430
|
+
```json
|
|
431
|
+
{
|
|
432
|
+
"type": "string",
|
|
433
|
+
"format": "uuid"
|
|
434
|
+
}
|
|
435
|
+
```
|
|
180
436
|
店舗IDです。
|
|
181
437
|
|
|
182
438
|
送金元の店舗を指定します。
|
|
183
439
|
|
|
184
440
|
---
|
|
185
441
|
`customer_id`
|
|
442
|
+
```json
|
|
443
|
+
{
|
|
444
|
+
"type": "string",
|
|
445
|
+
"format": "uuid"
|
|
446
|
+
}
|
|
447
|
+
```
|
|
186
448
|
エンドユーザーIDです。
|
|
187
449
|
|
|
188
450
|
送金先のエンドユーザーを指定します。
|
|
189
451
|
|
|
190
452
|
---
|
|
191
453
|
`private_money_id`
|
|
454
|
+
```json
|
|
455
|
+
{
|
|
456
|
+
"type": "string",
|
|
457
|
+
"format": "uuid"
|
|
458
|
+
}
|
|
459
|
+
```
|
|
192
460
|
マネーIDです。
|
|
193
461
|
|
|
194
462
|
マネーを指定します。
|
|
195
463
|
|
|
196
464
|
---
|
|
197
465
|
`bear_point_shop_id`
|
|
466
|
+
```json
|
|
467
|
+
{
|
|
468
|
+
"type": "string",
|
|
469
|
+
"format": "uuid"
|
|
470
|
+
}
|
|
471
|
+
```
|
|
198
472
|
ポイント支払時の負担店舗IDです。
|
|
199
473
|
|
|
200
474
|
ポイント支払い時に実際お金を負担する店舗を指定します。
|
|
201
475
|
|
|
202
476
|
---
|
|
203
477
|
`money_amount`
|
|
478
|
+
```json
|
|
479
|
+
{
|
|
480
|
+
"type": "number",
|
|
481
|
+
"minimum": 0
|
|
482
|
+
}
|
|
483
|
+
```
|
|
204
484
|
マネー額です。
|
|
205
485
|
|
|
206
486
|
送金するマネー額を指定します。
|
|
207
487
|
|
|
208
488
|
---
|
|
209
489
|
`point_amount`
|
|
490
|
+
```json
|
|
491
|
+
{
|
|
492
|
+
"type": "number",
|
|
493
|
+
"minimum": 0
|
|
494
|
+
}
|
|
495
|
+
```
|
|
210
496
|
ポイント額です。
|
|
211
497
|
|
|
212
498
|
送金するポイント額を指定します。
|
|
213
499
|
|
|
500
|
+
---
|
|
501
|
+
`point_expires_at`
|
|
502
|
+
```json
|
|
503
|
+
{
|
|
504
|
+
"type": "string",
|
|
505
|
+
"format": "date-time"
|
|
506
|
+
}
|
|
507
|
+
```
|
|
508
|
+
ポイントをチャージした場合の、付与されるポイントの有効期限です。
|
|
509
|
+
省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
|
|
510
|
+
|
|
214
511
|
---
|
|
215
512
|
`description`
|
|
513
|
+
```json
|
|
514
|
+
{
|
|
515
|
+
"type": "string",
|
|
516
|
+
"maxLength": 200
|
|
517
|
+
}
|
|
518
|
+
```
|
|
216
519
|
取引説明文です。
|
|
217
520
|
|
|
218
521
|
任意入力で、取引履歴に表示される説明文です。
|
|
219
522
|
|
|
220
523
|
---
|
|
221
524
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
222
|
-
|
|
525
|
+
<a name="create-payment-transaction"></a>
|
|
223
526
|
#### 支払いする
|
|
224
527
|
支払取引を作成します。
|
|
225
528
|
支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
|
|
226
529
|
|
|
227
530
|
```ruby
|
|
228
531
|
response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
|
|
229
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
230
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
231
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
232
|
-
|
|
233
|
-
description: "たい焼き(小倉)"
|
|
532
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ID
|
|
533
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # customer_id: エンドユーザーID
|
|
534
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
535
|
+
4421, # amount: 支払い額
|
|
536
|
+
description: "たい焼き(小倉)" # 取引履歴に表示する説明文
|
|
234
537
|
))
|
|
235
538
|
```
|
|
236
539
|
|
|
237
540
|
---
|
|
238
541
|
`shop_id`
|
|
542
|
+
```json
|
|
543
|
+
{
|
|
544
|
+
"type": "string",
|
|
545
|
+
"format": "uuid"
|
|
546
|
+
}
|
|
547
|
+
```
|
|
239
548
|
店舗IDです。
|
|
240
549
|
|
|
241
550
|
送金先の店舗を指定します。
|
|
242
551
|
|
|
243
552
|
---
|
|
244
553
|
`customer_id`
|
|
554
|
+
```json
|
|
555
|
+
{
|
|
556
|
+
"type": "string",
|
|
557
|
+
"format": "uuid"
|
|
558
|
+
}
|
|
559
|
+
```
|
|
245
560
|
エンドユーザーIDです。
|
|
246
561
|
|
|
247
562
|
送金元のエンドユーザーを指定します。
|
|
248
563
|
|
|
249
564
|
---
|
|
250
565
|
`private_money_id`
|
|
566
|
+
```json
|
|
567
|
+
{
|
|
568
|
+
"type": "string",
|
|
569
|
+
"format": "uuid"
|
|
570
|
+
}
|
|
571
|
+
```
|
|
251
572
|
マネーIDです。
|
|
252
573
|
|
|
253
574
|
マネーを指定します。
|
|
254
575
|
|
|
255
576
|
---
|
|
256
577
|
`amount`
|
|
578
|
+
```json
|
|
579
|
+
{
|
|
580
|
+
"type": "number",
|
|
581
|
+
"minimum": 0
|
|
582
|
+
}
|
|
583
|
+
```
|
|
257
584
|
マネー額です。
|
|
258
585
|
|
|
259
586
|
送金するマネー額を指定します。
|
|
260
587
|
|
|
261
588
|
---
|
|
262
589
|
`description`
|
|
590
|
+
```json
|
|
591
|
+
{
|
|
592
|
+
"type": "string",
|
|
593
|
+
"maxLength": 200
|
|
594
|
+
}
|
|
595
|
+
```
|
|
263
596
|
取引説明文です。
|
|
264
597
|
|
|
265
598
|
任意入力で、取引履歴に表示される説明文です。
|
|
266
599
|
|
|
267
600
|
---
|
|
268
601
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
269
|
-
|
|
602
|
+
<a name="create-transfer-transaction"></a>
|
|
270
603
|
#### 個人間送金
|
|
271
604
|
エンドユーザー間での送金取引(個人間送金)を作成します。
|
|
272
605
|
個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
|
|
273
606
|
|
|
274
607
|
```ruby
|
|
275
608
|
response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
|
|
276
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
277
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
278
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
279
|
-
|
|
280
|
-
description: "たい焼き(小倉)"
|
|
609
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # sender_id: 送金元ユーザーID
|
|
610
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # receiver_id: 受取ユーザーID
|
|
611
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
612
|
+
5572, # amount: 送金額
|
|
613
|
+
description: "たい焼き(小倉)" # 取引履歴に表示する説明文
|
|
281
614
|
))
|
|
282
615
|
```
|
|
283
616
|
|
|
284
617
|
---
|
|
285
618
|
`sender_id`
|
|
619
|
+
```json
|
|
620
|
+
{
|
|
621
|
+
"type": "string",
|
|
622
|
+
"format": "uuid"
|
|
623
|
+
}
|
|
624
|
+
```
|
|
286
625
|
エンドユーザーIDです。
|
|
287
626
|
|
|
288
627
|
送金元のエンドユーザー(送り主)を指定します。
|
|
289
628
|
|
|
290
629
|
---
|
|
291
630
|
`receiver_id`
|
|
631
|
+
```json
|
|
632
|
+
{
|
|
633
|
+
"type": "string",
|
|
634
|
+
"format": "uuid"
|
|
635
|
+
}
|
|
636
|
+
```
|
|
292
637
|
エンドユーザーIDです。
|
|
293
638
|
|
|
294
639
|
送金先のエンドユーザー(受け取り人)を指定します。
|
|
295
640
|
|
|
296
641
|
---
|
|
297
642
|
`private_money_id`
|
|
643
|
+
```json
|
|
644
|
+
{
|
|
645
|
+
"type": "string",
|
|
646
|
+
"format": "uuid"
|
|
647
|
+
}
|
|
648
|
+
```
|
|
298
649
|
マネーIDです。
|
|
299
650
|
|
|
300
651
|
マネーを指定します。
|
|
301
652
|
|
|
302
653
|
---
|
|
303
654
|
`amount`
|
|
655
|
+
```json
|
|
656
|
+
{
|
|
657
|
+
"type": "number",
|
|
658
|
+
"minimum": 0
|
|
659
|
+
}
|
|
660
|
+
```
|
|
304
661
|
マネー額です。
|
|
305
662
|
|
|
306
663
|
送金するマネー額を指定します。
|
|
307
664
|
|
|
308
665
|
---
|
|
309
666
|
`description`
|
|
667
|
+
```json
|
|
668
|
+
{
|
|
669
|
+
"type": "string",
|
|
670
|
+
"maxLength": 200
|
|
671
|
+
}
|
|
672
|
+
```
|
|
310
673
|
取引説明文です。
|
|
311
674
|
|
|
312
675
|
任意入力で、取引履歴に表示される説明文です。
|
|
313
676
|
|
|
314
677
|
---
|
|
315
678
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
316
|
-
|
|
317
|
-
####
|
|
318
|
-
取引一覧を返します。
|
|
679
|
+
<a name="create-exchange-transaction"></a>
|
|
680
|
+
####
|
|
319
681
|
```ruby
|
|
320
|
-
response = $client.send(Pokepay::Request::
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
682
|
+
response = $client.send(Pokepay::Request::CreateExchangeTransaction.new(
|
|
683
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
684
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
685
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
686
|
+
2336,
|
|
687
|
+
description: "w10SY48ZoA8oj9alrEKYDjBWPKCwbirzvScUvjsqVkcSInvOjFPIL9qlVMwg0ANEHCj5eM805Swtsg2NkJBDvuxWoqdLq3QmHRbZpwbPRidVG7B6hajGJrCJBxTKH0YUW8iwJJuJPCjlaztijN3vebjT86"
|
|
688
|
+
))
|
|
689
|
+
```
|
|
690
|
+
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
691
|
+
<a name="get-transaction"></a>
|
|
692
|
+
#### 取引情報を取得する
|
|
693
|
+
取引を取得します。
|
|
694
|
+
```ruby
|
|
695
|
+
response = $client.send(Pokepay::Request::GetTransaction.new(
|
|
696
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # transaction_id: 取引ID
|
|
334
697
|
))
|
|
335
698
|
```
|
|
336
|
-
|
|
337
|
-
---
|
|
338
|
-
`from`
|
|
339
|
-
抽出期間の開始日時です。
|
|
340
|
-
|
|
341
|
-
フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
|
|
342
|
-
|
|
343
|
-
---
|
|
344
|
-
`to`
|
|
345
|
-
抽出期間の終了日時です。
|
|
346
|
-
|
|
347
|
-
フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
|
|
348
|
-
|
|
349
|
-
---
|
|
350
|
-
`page`
|
|
351
|
-
取得したいページ番号です。
|
|
352
|
-
|
|
353
|
-
---
|
|
354
|
-
`per_page`
|
|
355
|
-
1ページ分の取引数です。
|
|
356
|
-
|
|
357
|
-
---
|
|
358
|
-
`shop_id`
|
|
359
|
-
店舗IDです。
|
|
360
|
-
|
|
361
|
-
フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
|
|
362
|
-
|
|
363
|
-
---
|
|
364
|
-
`customer_id`
|
|
365
|
-
エンドユーザーIDです。
|
|
366
|
-
|
|
367
|
-
フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
|
|
368
|
-
|
|
369
|
-
---
|
|
370
|
-
`customer_name`
|
|
371
|
-
エンドユーザー名です。
|
|
372
|
-
|
|
373
|
-
フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
|
|
374
|
-
|
|
375
|
-
---
|
|
376
|
-
`terminal_id`
|
|
377
|
-
端末IDです。
|
|
378
|
-
|
|
379
|
-
フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
|
|
380
699
|
|
|
381
700
|
---
|
|
382
701
|
`transaction_id`
|
|
702
|
+
```json
|
|
703
|
+
{
|
|
704
|
+
"type": "string",
|
|
705
|
+
"format": "uuid"
|
|
706
|
+
}
|
|
707
|
+
```
|
|
383
708
|
取引IDです。
|
|
384
709
|
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
---
|
|
388
|
-
`organization_code`
|
|
389
|
-
組織コードです。
|
|
390
|
-
|
|
391
|
-
フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
|
|
392
|
-
|
|
393
|
-
---
|
|
394
|
-
`private_money_id`
|
|
395
|
-
マネーIDです。
|
|
396
|
-
|
|
397
|
-
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
|
398
|
-
|
|
399
|
-
---
|
|
400
|
-
`is_modified`
|
|
401
|
-
キャンセルフラグです。
|
|
402
|
-
|
|
403
|
-
これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
|
|
404
|
-
デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
|
|
405
|
-
|
|
406
|
-
---
|
|
407
|
-
`types`
|
|
408
|
-
取引の種類でフィルターします。
|
|
409
|
-
|
|
410
|
-
以下の種類を指定できます。
|
|
411
|
-
|
|
412
|
-
1. topup
|
|
413
|
-
店舗からエンドユーザーへの送金取引(チャージ)
|
|
414
|
-
|
|
415
|
-
2. payment
|
|
416
|
-
エンドユーザーから店舗への送金取引(支払い)
|
|
417
|
-
|
|
418
|
-
3. exchange-outflow
|
|
419
|
-
他マネーへの流出
|
|
420
|
-
|
|
421
|
-
4. exchange-inflow
|
|
422
|
-
他マネーからの流入
|
|
710
|
+
フィルターとして使われ、指定した取引IDの取引を取得します。
|
|
423
711
|
|
|
424
712
|
---
|
|
425
|
-
成功したときは[
|
|
426
|
-
|
|
427
|
-
####
|
|
713
|
+
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
714
|
+
<a name="list-transfers"></a>
|
|
715
|
+
####
|
|
428
716
|
```ruby
|
|
429
|
-
response = $client.send(Pokepay::Request::
|
|
430
|
-
"
|
|
431
|
-
|
|
717
|
+
response = $client.send(Pokepay::Request::ListTransfers.new(
|
|
718
|
+
from: "2018-07-06T01:18:47.000000+09:00",
|
|
719
|
+
to: "2018-05-01T15:56:14.000000+09:00",
|
|
720
|
+
page: 7002,
|
|
721
|
+
per_page: 8147,
|
|
722
|
+
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
723
|
+
shop_name: "CqvnZ1YzdrhGH7XKNoGDpqqjYUa42NN7jWbTA8sT9CjYdhYyR9ZtWhMAKSZHQ2Tjahc0hASAcEibjku1f",
|
|
724
|
+
customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
725
|
+
customer_name: "QetgL0O7DlAFrkXVihIdQWu7J4NYirXryPP6taqbm6hsnA9hELkacVB4dzDqQ1LbTyVIgVP7fIz1xemnrDx9P7HPwLX5lwWZKuWWf4n5wNPq2rjN28QfQLnQ9Qr2gs4rAyEVt2ws7WkJzpgGUX4mtxobZ9ZCpNJGZG6LzTWIbd8ZNVrafdiivNn4NbNLXIdoiqtrelImUNmLeKEfXUc2dQExu22E4bXnTsrAu",
|
|
726
|
+
transaction_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
727
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
728
|
+
is_modified: true,
|
|
729
|
+
transaction_types: ["exchange", "payment", "transfer", "topup"],
|
|
730
|
+
transfer_types: ["topup", "transfer"],
|
|
731
|
+
description: "店頭QRコードによる支払い" # 取引詳細説明文
|
|
432
732
|
))
|
|
433
733
|
```
|
|
434
|
-
成功したときは[Transfer](#transfer)オブジェクトを返します
|
|
435
|
-
|
|
436
|
-
### チャージQRコード
|
|
437
734
|
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
#### チャージQRコードの発行
|
|
447
|
-
```ruby
|
|
448
|
-
response = $client.send(Pokepay::Request::CreateCheck.new(
|
|
449
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // account_id: 送金元の店舗アカウントID
|
|
450
|
-
money_amount: 8455, // 付与マネー額
|
|
451
|
-
point_amount: 6119, // 付与ポイント額
|
|
452
|
-
description: "test check", // 説明文(アプリ上で取引の説明文として表示される)
|
|
453
|
-
is_onetime: true, // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
|
|
454
|
-
usage_limit: 4746, // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
|
|
455
|
-
expires_at: "2018-04-09T08:22:29.000000+09:00", // チャージQR自体の失効日時
|
|
456
|
-
point_expires_at: "2016-10-24T09:19:20.000000+09:00", // チャージQRによって付与されるポイントの失効日時
|
|
457
|
-
point_expires_in_days: 60, // チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
|
|
458
|
-
bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ポイント額を負担する店舗アカウントのID
|
|
459
|
-
))
|
|
735
|
+
---
|
|
736
|
+
`description`
|
|
737
|
+
```json
|
|
738
|
+
{
|
|
739
|
+
"type": "string",
|
|
740
|
+
"maxLength": 200
|
|
741
|
+
}
|
|
460
742
|
```
|
|
461
|
-
|
|
743
|
+
取引詳細を指定の取引詳細説明文でフィルターします。
|
|
462
744
|
|
|
745
|
+
取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
|
|
463
746
|
|
|
464
747
|
---
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
748
|
+
成功したときは[PaginatedTransfers](#paginated-transfers)オブジェクトを返します
|
|
749
|
+
### Check
|
|
750
|
+
店舗ユーザが発行し、エンドユーザーがポケペイアプリから読み取ることでチャージ取引が発生するQRコードです。
|
|
468
751
|
|
|
752
|
+
チャージQRコードを解析すると次のようなURLになります(URLは環境によって異なります)。
|
|
469
753
|
|
|
470
|
-
|
|
471
|
-
`usage_limit`
|
|
472
|
-
複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
|
|
473
|
-
省略すると無制限に読み取り可能なチャージQRコードになります。
|
|
474
|
-
チャージQRコードは管理画面からいつでも無効化(有効化)することができます。
|
|
475
|
-
|
|
754
|
+
`https://www-sandbox.pokepay.jp/checks/xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx`
|
|
476
755
|
|
|
477
|
-
|
|
478
|
-
成功したときは[Check](#check)オブジェクトを返します
|
|
756
|
+
QRコードを読み取る方法以外にも、このURLリンクを直接スマートフォン(iOS/Android)上で開くことによりアプリが起動して取引が行われます。(注意: 上記URLはsandbox環境であるため、アプリもsandbox環境のものである必要があります) 上記URL中の `xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx` の部分がチャージQRコードのIDです。
|
|
479
757
|
|
|
758
|
+
<a name="create-topup-transaction-with-check"></a>
|
|
480
759
|
#### チャージQRコードを読み取ることでチャージする
|
|
481
|
-
通常チャージQR
|
|
760
|
+
通常チャージQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがチャージQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
|
|
482
761
|
|
|
483
|
-
|
|
762
|
+
エンドユーザーから受け取ったチャージ用QRコードのIDをエンドユーザーIDと共に渡すことでチャージ取引が作られます。
|
|
484
763
|
|
|
485
764
|
```ruby
|
|
486
765
|
response = $client.send(Pokepay::Request::CreateTopupTransactionWithCheck.new(
|
|
487
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
488
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
766
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # check_id: チャージ用QRコードのID
|
|
767
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # customer_id: エンドユーザーのID
|
|
489
768
|
))
|
|
490
769
|
```
|
|
491
770
|
|
|
492
771
|
---
|
|
493
772
|
`check_id`
|
|
773
|
+
```json
|
|
774
|
+
{
|
|
775
|
+
"type": "string",
|
|
776
|
+
"format": "uuid"
|
|
777
|
+
}
|
|
778
|
+
```
|
|
494
779
|
チャージ用QRコードのIDです。
|
|
495
780
|
|
|
496
781
|
QRコード生成時に送金元店舗のウォレット情報や、送金額などが登録されています。
|
|
497
782
|
|
|
498
783
|
---
|
|
499
784
|
`customer_id`
|
|
785
|
+
```json
|
|
786
|
+
{
|
|
787
|
+
"type": "string",
|
|
788
|
+
"format": "uuid"
|
|
789
|
+
}
|
|
790
|
+
```
|
|
500
791
|
エンドユーザーIDです。
|
|
501
792
|
|
|
502
793
|
送金先のエンドユーザーを指定します。
|
|
503
794
|
|
|
504
795
|
---
|
|
505
796
|
成功したときは[Transaction](#transaction)オブジェクトを返します
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
797
|
+
### Bill
|
|
798
|
+
支払いQRコード
|
|
799
|
+
<a name="list-bills"></a>
|
|
509
800
|
#### 支払いQRコード一覧を表示する
|
|
510
801
|
支払いQRコード一覧を表示します。
|
|
511
802
|
```ruby
|
|
512
803
|
response = $client.send(Pokepay::Request::ListBills.new(
|
|
513
|
-
page:
|
|
514
|
-
per_page:
|
|
515
|
-
bill_id: "
|
|
516
|
-
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
517
|
-
organization_code: "
|
|
518
|
-
description: "test bill",
|
|
519
|
-
created_from: "
|
|
520
|
-
created_to: "
|
|
521
|
-
shop_name: "bill test shop1",
|
|
522
|
-
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
523
|
-
lower_limit_amount:
|
|
524
|
-
upper_limit_amount:
|
|
525
|
-
is_disabled:
|
|
804
|
+
page: 59, # ページ番号
|
|
805
|
+
per_page: 5729, # 1ページの表示数
|
|
806
|
+
bill_id: "cjpDc", # 支払いQRコードのID
|
|
807
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
808
|
+
organization_code: "lZ4-35-cw-jqbxQoX9vZ-pMg8z5-", # 組織コード
|
|
809
|
+
description: "test bill", # 取引説明文
|
|
810
|
+
created_from: "2022-08-24T20:55:10.000000+09:00", # 作成日時(起点)
|
|
811
|
+
created_to: "2017-10-17T12:55:14.000000+09:00", # 作成日時(終点)
|
|
812
|
+
shop_name: "bill test shop1", # 店舗名
|
|
813
|
+
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
|
|
814
|
+
lower_limit_amount: 1024, # 金額の範囲によるフィルタ(下限)
|
|
815
|
+
upper_limit_amount: 3342, # 金額の範囲によるフィルタ(上限)
|
|
816
|
+
is_disabled: false # 支払いQRコードが無効化されているかどうか
|
|
526
817
|
))
|
|
527
818
|
```
|
|
528
819
|
|
|
529
820
|
---
|
|
530
821
|
`page`
|
|
822
|
+
```json
|
|
823
|
+
{
|
|
824
|
+
"type": "integer",
|
|
825
|
+
"minimum": 1
|
|
826
|
+
}
|
|
827
|
+
```
|
|
531
828
|
取得したいページ番号です。
|
|
532
829
|
|
|
533
830
|
---
|
|
534
831
|
`per_page`
|
|
832
|
+
```json
|
|
833
|
+
{
|
|
834
|
+
"type": "integer",
|
|
835
|
+
"minimum": 1
|
|
836
|
+
}
|
|
837
|
+
```
|
|
535
838
|
1ページに表示する支払いQRコードの数です。
|
|
536
839
|
|
|
537
840
|
---
|
|
538
841
|
`bill_id`
|
|
539
|
-
|
|
842
|
+
```json
|
|
843
|
+
{ "type": "string" }
|
|
844
|
+
```
|
|
845
|
+
支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
|
|
540
846
|
|
|
541
847
|
---
|
|
542
848
|
`private_money_id`
|
|
849
|
+
```json
|
|
850
|
+
{
|
|
851
|
+
"type": "string",
|
|
852
|
+
"format": "uuid"
|
|
853
|
+
}
|
|
854
|
+
```
|
|
543
855
|
支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
|
|
544
856
|
|
|
545
857
|
---
|
|
546
858
|
`organization_code`
|
|
859
|
+
```json
|
|
860
|
+
{
|
|
861
|
+
"type": "string",
|
|
862
|
+
"maxLength": 32,
|
|
863
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
|
864
|
+
}
|
|
865
|
+
```
|
|
547
866
|
支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
|
|
548
867
|
|
|
549
868
|
---
|
|
550
869
|
`description`
|
|
870
|
+
```json
|
|
871
|
+
{
|
|
872
|
+
"type": "string",
|
|
873
|
+
"maxLength": 200
|
|
874
|
+
}
|
|
875
|
+
```
|
|
551
876
|
支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
|
|
552
877
|
|
|
553
878
|
---
|
|
554
879
|
`created_from`
|
|
880
|
+
```json
|
|
881
|
+
{
|
|
882
|
+
"type": "string",
|
|
883
|
+
"format": "date-time"
|
|
884
|
+
}
|
|
885
|
+
```
|
|
555
886
|
支払いQRコードの作成日時でフィルターします。
|
|
556
887
|
|
|
557
888
|
これ以降に作成された支払いQRコードのみ一覧に表示されます。
|
|
558
889
|
|
|
559
890
|
---
|
|
560
891
|
`created_to`
|
|
892
|
+
```json
|
|
893
|
+
{
|
|
894
|
+
"type": "string",
|
|
895
|
+
"format": "date-time"
|
|
896
|
+
}
|
|
897
|
+
```
|
|
561
898
|
支払いQRコードの作成日時でフィルターします。
|
|
562
899
|
|
|
563
900
|
これ以前に作成された支払いQRコードのみ一覧に表示されます。
|
|
564
901
|
|
|
565
902
|
---
|
|
566
903
|
`shop_name`
|
|
567
|
-
|
|
904
|
+
```json
|
|
905
|
+
{
|
|
906
|
+
"type": "string",
|
|
907
|
+
"maxLength": 256
|
|
908
|
+
}
|
|
909
|
+
```
|
|
910
|
+
支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
|
|
568
911
|
|
|
569
912
|
---
|
|
570
913
|
`shop_id`
|
|
914
|
+
```json
|
|
915
|
+
{
|
|
916
|
+
"type": "string",
|
|
917
|
+
"format": "uuid"
|
|
918
|
+
}
|
|
919
|
+
```
|
|
571
920
|
支払いQRコードを作成した店舗IDでフィルターします。
|
|
572
921
|
|
|
573
922
|
---
|
|
574
923
|
`lower_limit_amount`
|
|
924
|
+
```json
|
|
925
|
+
{
|
|
926
|
+
"type": "integer",
|
|
927
|
+
"format": "decimal",
|
|
928
|
+
"minimum": 0
|
|
929
|
+
}
|
|
930
|
+
```
|
|
575
931
|
支払いQRコードの金額の下限を指定してフィルターします。
|
|
576
932
|
|
|
577
933
|
---
|
|
578
934
|
`upper_limit_amount`
|
|
935
|
+
```json
|
|
936
|
+
{
|
|
937
|
+
"type": "integer",
|
|
938
|
+
"format": "decimal",
|
|
939
|
+
"minimum": 0
|
|
940
|
+
}
|
|
941
|
+
```
|
|
579
942
|
支払いQRコードの金額の上限を指定してフィルターします。
|
|
580
943
|
|
|
581
944
|
---
|
|
582
945
|
`is_disabled`
|
|
946
|
+
```json
|
|
947
|
+
{ "type": "boolean" }
|
|
948
|
+
```
|
|
583
949
|
支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
|
|
584
950
|
|
|
585
951
|
---
|
|
586
952
|
成功したときは[PaginatedBills](#paginated-bills)オブジェクトを返します
|
|
587
|
-
|
|
953
|
+
<a name="create-bill"></a>
|
|
588
954
|
#### 支払いQRコードの発行
|
|
589
955
|
支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
|
|
590
956
|
```ruby
|
|
591
957
|
response = $client.send(Pokepay::Request::CreateBill.new(
|
|
592
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
593
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
594
|
-
amount:
|
|
595
|
-
description: "test bill"
|
|
958
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
|
|
959
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
|
|
960
|
+
amount: 7131, # 支払い額
|
|
961
|
+
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
|
|
596
962
|
))
|
|
597
963
|
```
|
|
598
964
|
|
|
599
965
|
---
|
|
600
966
|
`amount`
|
|
967
|
+
```json
|
|
968
|
+
{
|
|
969
|
+
"type": "number",
|
|
970
|
+
"format": "decimal",
|
|
971
|
+
"minimum": 0
|
|
972
|
+
}
|
|
973
|
+
```
|
|
601
974
|
支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
|
|
602
975
|
|
|
603
976
|
---
|
|
604
977
|
成功したときは[Bill](#bill)オブジェクトを返します
|
|
605
|
-
|
|
978
|
+
<a name="update-bill"></a>
|
|
606
979
|
#### 支払いQRコードの更新
|
|
607
980
|
支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
|
|
608
981
|
```ruby
|
|
609
982
|
response = $client.send(Pokepay::Request::UpdateBill.new(
|
|
610
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
611
|
-
amount:
|
|
612
|
-
description: "test bill",
|
|
613
|
-
is_disabled: true
|
|
983
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
|
|
984
|
+
amount: 6026, # 支払い額
|
|
985
|
+
description: "test bill", # 説明文
|
|
986
|
+
is_disabled: true # 無効化されているかどうか
|
|
614
987
|
))
|
|
615
988
|
```
|
|
616
989
|
|
|
617
990
|
---
|
|
618
991
|
`bill_id`
|
|
992
|
+
```json
|
|
993
|
+
{
|
|
994
|
+
"type": "string",
|
|
995
|
+
"format": "uuid"
|
|
996
|
+
}
|
|
997
|
+
```
|
|
619
998
|
更新対象の支払いQRコードのIDです。
|
|
620
999
|
|
|
621
1000
|
---
|
|
622
1001
|
`amount`
|
|
1002
|
+
```json
|
|
1003
|
+
{
|
|
1004
|
+
"type": "number",
|
|
1005
|
+
"format": "decimal",
|
|
1006
|
+
"minimum": 0
|
|
1007
|
+
}
|
|
1008
|
+
```
|
|
623
1009
|
支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
|
|
624
1010
|
|
|
625
1011
|
---
|
|
626
1012
|
`description`
|
|
1013
|
+
```json
|
|
1014
|
+
{
|
|
1015
|
+
"type": "string",
|
|
1016
|
+
"maxLength": 200
|
|
1017
|
+
}
|
|
1018
|
+
```
|
|
627
1019
|
支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
|
|
628
1020
|
|
|
629
1021
|
---
|
|
630
1022
|
`is_disabled`
|
|
1023
|
+
```json
|
|
1024
|
+
{ "type": "boolean" }
|
|
1025
|
+
```
|
|
631
1026
|
支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
|
|
632
1027
|
|
|
633
1028
|
---
|
|
634
1029
|
成功したときは[Bill](#bill)オブジェクトを返します
|
|
1030
|
+
### Cashtray
|
|
1031
|
+
Cashtrayは支払いとチャージ両方に使えるQRコードで、店舗ユーザとエンドユーザーの間の主に店頭などでの取引のために用いられます。
|
|
1032
|
+
Cashtrayによる取引では、エンドユーザーがQRコードを読み取った時点で即時取引が作られ、ユーザに対して受け取り確認画面は表示されません。
|
|
1033
|
+
Cashtrayはワンタイムで、一度読み取りに成功するか、取引エラーになると失効します。
|
|
1034
|
+
また、Cashtrayには有効期限があり、デフォルトでは30分で失効します。
|
|
635
1035
|
|
|
636
|
-
|
|
1036
|
+
<a name="create-cashtray"></a>
|
|
1037
|
+
#### Cashtrayを作る
|
|
1038
|
+
Cashtrayを作成します。
|
|
1039
|
+
|
|
1040
|
+
エンドユーザーに対して支払いまたはチャージを行う店舗の情報(店舗ユーザーIDとマネーID)と、取引金額が必須項目です。
|
|
1041
|
+
店舗ユーザーIDとマネーIDから店舗ウォレットを特定します。
|
|
1042
|
+
|
|
1043
|
+
その他に、Cashtrayから作られる取引に対する説明文や失効時間を指定できます。
|
|
637
1044
|
|
|
638
|
-
#### 新規エンドユーザーウォレットを追加する
|
|
639
|
-
指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
|
|
640
1045
|
```ruby
|
|
641
|
-
response = $client.send(Pokepay::Request::
|
|
642
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
643
|
-
|
|
644
|
-
|
|
1046
|
+
response = $client.send(Pokepay::Request::CreateCashtray.new(
|
|
1047
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1048
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
1049
|
+
2980, # amount: 金額
|
|
1050
|
+
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1051
|
+
expires_in: 673 # 失効時間(秒)
|
|
645
1052
|
))
|
|
646
1053
|
```
|
|
647
1054
|
|
|
648
1055
|
---
|
|
649
1056
|
`private_money_id`
|
|
650
|
-
|
|
1057
|
+
```json
|
|
1058
|
+
{
|
|
1059
|
+
"type": "string",
|
|
1060
|
+
"format": "uuid"
|
|
1061
|
+
}
|
|
1062
|
+
```
|
|
1063
|
+
取引対象のマネーのIDです(必須項目)。
|
|
651
1064
|
|
|
652
|
-
|
|
1065
|
+
---
|
|
1066
|
+
`shop_id`
|
|
1067
|
+
```json
|
|
1068
|
+
{
|
|
1069
|
+
"type": "string",
|
|
1070
|
+
"format": "uuid"
|
|
1071
|
+
}
|
|
1072
|
+
```
|
|
1073
|
+
店舗のユーザーIDです(必須項目)。
|
|
653
1074
|
|
|
654
1075
|
---
|
|
655
|
-
`
|
|
656
|
-
|
|
1076
|
+
`amount`
|
|
1077
|
+
```json
|
|
1078
|
+
{ "type": "number" }
|
|
1079
|
+
```
|
|
1080
|
+
マネー額です(必須項目)。
|
|
1081
|
+
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
|
657
1082
|
|
|
658
1083
|
---
|
|
659
|
-
`
|
|
660
|
-
|
|
1084
|
+
`description`
|
|
1085
|
+
```json
|
|
1086
|
+
{
|
|
1087
|
+
"type": "string",
|
|
1088
|
+
"maxLength": 200
|
|
1089
|
+
}
|
|
1090
|
+
```
|
|
1091
|
+
Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
|
|
1092
|
+
アプリや管理画面などの取引履歴に表示されます。デフォルトでは空文字になります。
|
|
661
1093
|
|
|
662
1094
|
---
|
|
663
|
-
|
|
1095
|
+
`expires_in`
|
|
1096
|
+
```json
|
|
1097
|
+
{
|
|
1098
|
+
"type": "integer",
|
|
1099
|
+
"minimum": 1
|
|
1100
|
+
}
|
|
1101
|
+
```
|
|
1102
|
+
Cashtrayが失効するまでの時間を秒単位で指定します(任意項目、デフォルト値は1800秒(30分))。
|
|
1103
|
+
|
|
1104
|
+
---
|
|
1105
|
+
成功したときは[Cashtray](#cashtray)オブジェクトを返します
|
|
1106
|
+
<a name="get-cashtray"></a>
|
|
1107
|
+
#### Cashtrayの情報を取得する
|
|
1108
|
+
Cashtrayの情報を取得します。
|
|
1109
|
+
|
|
1110
|
+
Cashtrayの現在の状態に加え、エンドユーザーのCashtray読み取りの試行結果、Cashtray読み取りによって作られた取引情報が取得できます。
|
|
1111
|
+
|
|
1112
|
+
レスポンス中の `attempt` には、このCashtrayをエンドユーザーが読み取った試行結果が入ります。
|
|
1113
|
+
`account` はエンドユーザーのウォレット情報です。
|
|
1114
|
+
成功時には `attempt` 内の `status_code` に200が入ります。
|
|
1115
|
+
|
|
1116
|
+
まだCashtrayが読み取られていない場合は `attempt` の内容は `NULL` になります。
|
|
1117
|
+
エンドユーザーのCashtray読み取りの際には、様々なエラーが起き得ます。
|
|
1118
|
+
エラーの詳細は `attempt` 中の `error_type` と `error_message` にあります。主なエラー型と対応するステータスコードを以下に列挙します。
|
|
1119
|
+
|
|
1120
|
+
- `cashtray_already_proceed (422)`
|
|
1121
|
+
- 既に処理済みのCashtrayをエンドユーザーが再び読み取ったときに返されます
|
|
1122
|
+
- `cashtray_expired (422)`
|
|
1123
|
+
- 読み取り時点でCashtray自体の有効期限が切れているときに返されます。Cashtrayが失効する時刻はレスポンス中の `expires_at` にあります
|
|
1124
|
+
- `cashtray_already_canceled (422)`
|
|
1125
|
+
- 読み取り時点でCashtrayが無効化されているときに返されます
|
|
1126
|
+
- `account_balance_not_enough (422)`
|
|
1127
|
+
- 支払い時に、エンドユーザーの残高が不足していて取引が完了できなかったときに返されます
|
|
1128
|
+
- `account_balance_exceeded`
|
|
1129
|
+
- チャージ時に、エンドユーザーのウォレット上限を超えて取引が完了できなかったときに返されます
|
|
1130
|
+
- `account_transfer_limit_exceeded (422)`
|
|
1131
|
+
- マネーに設定されている一度の取引金額の上限を超えたため、取引が完了できなかったときに返されます
|
|
1132
|
+
- `account_not_found (422)`
|
|
1133
|
+
- Cashtrayに設定されたマネーのウォレットをエンドユーザーが持っていなかったときに返されます
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
レスポンス中の `transaction` には、このCashtrayをエンドユーザーが読み取ることによって作られる取引データが入ります。まだCashtrayが読み取られていない場合は `NULL` になります。
|
|
1137
|
+
|
|
1138
|
+
以上をまとめると、Cashtrayの状態は以下のようになります。
|
|
1139
|
+
|
|
1140
|
+
- エンドユーザーのCashtray読み取りによって取引が成功した場合
|
|
1141
|
+
- レスポンス中の `attempt` と `transaction` にそれぞれ値が入ります
|
|
1142
|
+
- 何らかの理由で取引が失敗した場合
|
|
1143
|
+
- レスポンス中の `attempt` にエラー内容が入り、 `transaction` には `NULL` が入ります
|
|
1144
|
+
- まだCashtrayが読み取られていない場合
|
|
1145
|
+
- レスポンス中の `attempt` と `transaction` にそれぞれ `NULL` が入ります。Cashtrayの `expires_at` が現在時刻より前の場合は有効期限切れ状態です。
|
|
1146
|
+
|
|
1147
|
+
Cashtrayの取り得る全ての状態を擬似コードで記述すると以下のようになります。
|
|
1148
|
+
```
|
|
1149
|
+
if (attempt == null) {
|
|
1150
|
+
// 状態は未確定
|
|
1151
|
+
if (canceled_at != null) {
|
|
1152
|
+
// 無効化済み
|
|
1153
|
+
} else if (expires_at < now) {
|
|
1154
|
+
// 失効済み
|
|
1155
|
+
} else {
|
|
1156
|
+
// まだ有効で読み取られていない
|
|
1157
|
+
}
|
|
1158
|
+
} else if (transaction != null) {
|
|
1159
|
+
// 取引成功確定。attempt で読み取ったユーザなどが分かる
|
|
1160
|
+
} else {
|
|
1161
|
+
// 取引失敗確定。attempt で失敗理由などが分かる
|
|
1162
|
+
}
|
|
1163
|
+
```
|
|
1164
|
+
```ruby
|
|
1165
|
+
response = $client.send(Pokepay::Request::GetCashtray.new(
|
|
1166
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # cashtray_id: CashtrayのID
|
|
1167
|
+
))
|
|
1168
|
+
```
|
|
1169
|
+
|
|
1170
|
+
---
|
|
1171
|
+
`cashtray_id`
|
|
1172
|
+
```json
|
|
1173
|
+
{
|
|
1174
|
+
"type": "string",
|
|
1175
|
+
"format": "uuid"
|
|
1176
|
+
}
|
|
1177
|
+
```
|
|
1178
|
+
情報を取得するCashtrayのIDです。
|
|
664
1179
|
|
|
1180
|
+
---
|
|
1181
|
+
成功したときは[CashtrayWithResult](#cashtray-with-result)オブジェクトを返します
|
|
1182
|
+
<a name="cancel-cashtray"></a>
|
|
1183
|
+
#### Cashtrayを無効化する
|
|
1184
|
+
Cashtrayを無効化します。
|
|
1185
|
+
|
|
1186
|
+
これにより、 `GetCashtray` のレスポンス中の `canceled_at` に無効化時点での現在時刻が入るようになります。
|
|
1187
|
+
エンドユーザーが無効化されたQRコードを読み取ると `cashtray_already_canceled` エラーとなり、取引は失敗します。
|
|
1188
|
+
```ruby
|
|
1189
|
+
response = $client.send(Pokepay::Request::CancelCashtray.new(
|
|
1190
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # cashtray_id: CashtrayのID
|
|
1191
|
+
))
|
|
1192
|
+
```
|
|
1193
|
+
|
|
1194
|
+
---
|
|
1195
|
+
`cashtray_id`
|
|
1196
|
+
```json
|
|
1197
|
+
{
|
|
1198
|
+
"type": "string",
|
|
1199
|
+
"format": "uuid"
|
|
1200
|
+
}
|
|
1201
|
+
```
|
|
1202
|
+
無効化するCashtrayのIDです。
|
|
1203
|
+
|
|
1204
|
+
---
|
|
1205
|
+
成功したときは[Cashtray](#cashtray)オブジェクトを返します
|
|
1206
|
+
<a name="update-cashtray"></a>
|
|
1207
|
+
#### Cashtrayの情報を更新する
|
|
1208
|
+
Cashtrayの内容を更新します。bodyパラメーターは全て省略可能で、指定したもののみ更新されます。
|
|
1209
|
+
```ruby
|
|
1210
|
+
response = $client.send(Pokepay::Request::UpdateCashtray.new(
|
|
1211
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # cashtray_id: CashtrayのID
|
|
1212
|
+
amount: 7982, # 金額
|
|
1213
|
+
description: "たい焼き(小倉)", # 取引履歴に表示する説明文
|
|
1214
|
+
expires_in: 6739 # 失効時間(秒)
|
|
1215
|
+
))
|
|
1216
|
+
```
|
|
1217
|
+
|
|
1218
|
+
---
|
|
1219
|
+
`cashtray_id`
|
|
1220
|
+
```json
|
|
1221
|
+
{
|
|
1222
|
+
"type": "string",
|
|
1223
|
+
"format": "uuid"
|
|
1224
|
+
}
|
|
1225
|
+
```
|
|
1226
|
+
更新対象のCashtrayのIDです。
|
|
1227
|
+
|
|
1228
|
+
---
|
|
1229
|
+
`amount`
|
|
1230
|
+
```json
|
|
1231
|
+
{ "type": "number" }
|
|
1232
|
+
```
|
|
1233
|
+
マネー額です(任意項目)。
|
|
1234
|
+
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
|
1235
|
+
|
|
1236
|
+
---
|
|
1237
|
+
`description`
|
|
1238
|
+
```json
|
|
1239
|
+
{
|
|
1240
|
+
"type": "string",
|
|
1241
|
+
"maxLength": 200
|
|
1242
|
+
}
|
|
1243
|
+
```
|
|
1244
|
+
Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
|
|
1245
|
+
アプリや管理画面などの取引履歴に表示されます。
|
|
1246
|
+
|
|
1247
|
+
---
|
|
1248
|
+
`expires_in`
|
|
1249
|
+
```json
|
|
1250
|
+
{
|
|
1251
|
+
"type": "integer",
|
|
1252
|
+
"minimum": 1
|
|
1253
|
+
}
|
|
1254
|
+
```
|
|
1255
|
+
Cashtrayが失効するまでの時間を秒で指定します(任意項目、デフォルト値は1800秒(30分))。
|
|
1256
|
+
|
|
1257
|
+
---
|
|
1258
|
+
成功したときは[Cashtray](#cashtray)オブジェクトを返します
|
|
1259
|
+
### Customer
|
|
1260
|
+
<a name="get-account"></a>
|
|
665
1261
|
#### ウォレット情報を表示する
|
|
666
1262
|
ウォレットを取得します。
|
|
667
1263
|
```ruby
|
|
668
1264
|
response = $client.send(Pokepay::Request::GetAccount.new(
|
|
669
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
1265
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # account_id: ウォレットID
|
|
670
1266
|
))
|
|
671
1267
|
```
|
|
672
1268
|
|
|
673
1269
|
---
|
|
674
1270
|
`account_id`
|
|
1271
|
+
```json
|
|
1272
|
+
{
|
|
1273
|
+
"type": "string",
|
|
1274
|
+
"format": "uuid"
|
|
1275
|
+
}
|
|
1276
|
+
```
|
|
675
1277
|
ウォレットIDです。
|
|
676
1278
|
|
|
677
1279
|
フィルターとして使われ、指定したウォレットIDのウォレットを取得します。
|
|
678
1280
|
|
|
679
1281
|
---
|
|
680
1282
|
成功したときは[AccountDetail](#account-detail)オブジェクトを返します
|
|
1283
|
+
<a name="update-account"></a>
|
|
1284
|
+
#### ウォレット情報を更新する
|
|
1285
|
+
ウォレットの状態を更新します。現在はウォレットの凍結/凍結解除の切り替えにのみ対応しています。
|
|
1286
|
+
```ruby
|
|
1287
|
+
response = $client.send(Pokepay::Request::UpdateAccount.new(
|
|
1288
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1289
|
+
is_suspended: true # ウォレットが凍結されているかどうか
|
|
1290
|
+
))
|
|
1291
|
+
```
|
|
681
1292
|
|
|
1293
|
+
---
|
|
1294
|
+
`account_id`
|
|
1295
|
+
```json
|
|
1296
|
+
{
|
|
1297
|
+
"type": "string",
|
|
1298
|
+
"format": "uuid"
|
|
1299
|
+
}
|
|
1300
|
+
```
|
|
1301
|
+
ウォレットIDです。
|
|
1302
|
+
|
|
1303
|
+
指定したウォレットIDのウォレットの状態を更新します。
|
|
1304
|
+
|
|
1305
|
+
---
|
|
1306
|
+
`is_suspended`
|
|
1307
|
+
```json
|
|
1308
|
+
{ "type": "boolean" }
|
|
1309
|
+
```
|
|
1310
|
+
ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
|
|
1311
|
+
|
|
1312
|
+
---
|
|
1313
|
+
成功したときは[AccountDetail](#account-detail)オブジェクトを返します
|
|
1314
|
+
<a name="list-account-balances"></a>
|
|
682
1315
|
#### エンドユーザーの残高内訳を表示する
|
|
683
1316
|
エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
|
|
684
1317
|
```ruby
|
|
685
1318
|
response = $client.send(Pokepay::Request::ListAccountBalances.new(
|
|
686
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
687
|
-
page:
|
|
688
|
-
per_page:
|
|
689
|
-
expires_at_from: "2024-
|
|
690
|
-
expires_at_to: "
|
|
691
|
-
direction: "
|
|
1319
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1320
|
+
page: 1825, # ページ番号
|
|
1321
|
+
per_page: 1938, # 1ページ分の取引数
|
|
1322
|
+
expires_at_from: "2024-10-20T12:50:56.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1323
|
+
expires_at_to: "2023-10-13T12:55:10.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1324
|
+
direction: "desc" # 有効期限によるソート順序
|
|
692
1325
|
))
|
|
693
1326
|
```
|
|
694
1327
|
|
|
695
1328
|
---
|
|
696
1329
|
`account_id`
|
|
1330
|
+
```json
|
|
1331
|
+
{
|
|
1332
|
+
"type": "string",
|
|
1333
|
+
"format": "uuid"
|
|
1334
|
+
}
|
|
1335
|
+
```
|
|
697
1336
|
ウォレットIDです。
|
|
698
1337
|
|
|
699
1338
|
フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
|
|
700
1339
|
|
|
701
1340
|
---
|
|
702
1341
|
`page`
|
|
1342
|
+
```json
|
|
1343
|
+
{
|
|
1344
|
+
"type": "integer",
|
|
1345
|
+
"minimum": 1
|
|
1346
|
+
}
|
|
1347
|
+
```
|
|
703
1348
|
取得したいページ番号です。デフォルト値は1です。
|
|
704
1349
|
|
|
705
1350
|
---
|
|
706
1351
|
`per_page`
|
|
1352
|
+
```json
|
|
1353
|
+
{
|
|
1354
|
+
"type": "integer",
|
|
1355
|
+
"minimum": 1
|
|
1356
|
+
}
|
|
1357
|
+
```
|
|
707
1358
|
1ページ分のウォレット残高数です。デフォルト値は30です。
|
|
708
1359
|
|
|
709
1360
|
---
|
|
710
1361
|
`expires_at_from`
|
|
1362
|
+
```json
|
|
1363
|
+
{
|
|
1364
|
+
"type": "string",
|
|
1365
|
+
"format": "date-time"
|
|
1366
|
+
}
|
|
1367
|
+
```
|
|
711
1368
|
有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
712
1369
|
|
|
713
1370
|
---
|
|
714
1371
|
`expires_at_to`
|
|
1372
|
+
```json
|
|
1373
|
+
{
|
|
1374
|
+
"type": "string",
|
|
1375
|
+
"format": "date-time"
|
|
1376
|
+
}
|
|
1377
|
+
```
|
|
715
1378
|
有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
716
1379
|
|
|
717
1380
|
---
|
|
718
1381
|
`direction`
|
|
1382
|
+
```json
|
|
1383
|
+
{
|
|
1384
|
+
"type": "string",
|
|
1385
|
+
"enum": { "asc": "desc" }
|
|
1386
|
+
}
|
|
1387
|
+
```
|
|
719
1388
|
有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
|
|
720
1389
|
|
|
721
1390
|
---
|
|
722
|
-
成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
|
|
723
|
-
|
|
724
|
-
#### エンドユーザーの失効済みの残高内訳を表示する
|
|
725
|
-
エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
|
|
1391
|
+
成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
|
|
1392
|
+
<a name="list-account-expired-balances"></a>
|
|
1393
|
+
#### エンドユーザーの失効済みの残高内訳を表示する
|
|
1394
|
+
エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
|
|
1395
|
+
```ruby
|
|
1396
|
+
response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
|
|
1397
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # account_id: ウォレットID
|
|
1398
|
+
page: 1574, # ページ番号
|
|
1399
|
+
per_page: 565, # 1ページ分の取引数
|
|
1400
|
+
expires_at_from: "2024-07-16T03:15:02.000000+09:00", # 有効期限の期間によるフィルター(開始時点)
|
|
1401
|
+
expires_at_to: "2020-04-13T18:19:06.000000+09:00", # 有効期限の期間によるフィルター(終了時点)
|
|
1402
|
+
direction: "desc" # 有効期限によるソート順序
|
|
1403
|
+
))
|
|
1404
|
+
```
|
|
1405
|
+
|
|
1406
|
+
---
|
|
1407
|
+
`account_id`
|
|
1408
|
+
```json
|
|
1409
|
+
{
|
|
1410
|
+
"type": "string",
|
|
1411
|
+
"format": "uuid"
|
|
1412
|
+
}
|
|
1413
|
+
```
|
|
1414
|
+
ウォレットIDです。
|
|
1415
|
+
|
|
1416
|
+
フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
|
|
1417
|
+
|
|
1418
|
+
---
|
|
1419
|
+
`page`
|
|
1420
|
+
```json
|
|
1421
|
+
{
|
|
1422
|
+
"type": "integer",
|
|
1423
|
+
"minimum": 1
|
|
1424
|
+
}
|
|
1425
|
+
```
|
|
1426
|
+
取得したいページ番号です。デフォルト値は1です。
|
|
1427
|
+
|
|
1428
|
+
---
|
|
1429
|
+
`per_page`
|
|
1430
|
+
```json
|
|
1431
|
+
{
|
|
1432
|
+
"type": "integer",
|
|
1433
|
+
"minimum": 1
|
|
1434
|
+
}
|
|
1435
|
+
```
|
|
1436
|
+
1ページ分のウォレット残高数です。デフォルト値は30です。
|
|
1437
|
+
|
|
1438
|
+
---
|
|
1439
|
+
`expires_at_from`
|
|
1440
|
+
```json
|
|
1441
|
+
{
|
|
1442
|
+
"type": "string",
|
|
1443
|
+
"format": "date-time"
|
|
1444
|
+
}
|
|
1445
|
+
```
|
|
1446
|
+
有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1447
|
+
|
|
1448
|
+
---
|
|
1449
|
+
`expires_at_to`
|
|
1450
|
+
```json
|
|
1451
|
+
{
|
|
1452
|
+
"type": "string",
|
|
1453
|
+
"format": "date-time"
|
|
1454
|
+
}
|
|
1455
|
+
```
|
|
1456
|
+
有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1457
|
+
|
|
1458
|
+
---
|
|
1459
|
+
`direction`
|
|
1460
|
+
```json
|
|
1461
|
+
{
|
|
1462
|
+
"type": "string",
|
|
1463
|
+
"enum": { "asc": "desc" }
|
|
1464
|
+
}
|
|
1465
|
+
```
|
|
1466
|
+
有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
|
|
1467
|
+
|
|
1468
|
+
---
|
|
1469
|
+
成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
|
|
1470
|
+
<a name="get-customer-accounts"></a>
|
|
1471
|
+
#### エンドユーザーのウォレット一覧を表示する
|
|
1472
|
+
マネーを指定してエンドユーザーのウォレット一覧を取得します。
|
|
1473
|
+
```ruby
|
|
1474
|
+
response = $client.send(Pokepay::Request::GetCustomerAccounts.new(
|
|
1475
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1476
|
+
page: 7367, # ページ番号
|
|
1477
|
+
per_page: 2729, # 1ページ分のウォレット数
|
|
1478
|
+
created_at_from: "2023-05-31T00:35:38.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1479
|
+
created_at_to: "2020-09-03T19:56:38.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1480
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
|
1481
|
+
))
|
|
1482
|
+
```
|
|
1483
|
+
|
|
1484
|
+
---
|
|
1485
|
+
`private_money_id`
|
|
1486
|
+
```json
|
|
1487
|
+
{
|
|
1488
|
+
"type": "string",
|
|
1489
|
+
"format": "uuid"
|
|
1490
|
+
}
|
|
1491
|
+
```
|
|
1492
|
+
マネーIDです。
|
|
1493
|
+
|
|
1494
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
1495
|
+
|
|
1496
|
+
---
|
|
1497
|
+
`page`
|
|
1498
|
+
```json
|
|
1499
|
+
{
|
|
1500
|
+
"type": "integer",
|
|
1501
|
+
"minimum": 1
|
|
1502
|
+
}
|
|
1503
|
+
```
|
|
1504
|
+
取得したいページ番号です。デフォルト値は1です。
|
|
1505
|
+
|
|
1506
|
+
---
|
|
1507
|
+
`per_page`
|
|
1508
|
+
```json
|
|
1509
|
+
{
|
|
1510
|
+
"type": "integer",
|
|
1511
|
+
"minimum": 1
|
|
1512
|
+
}
|
|
1513
|
+
```
|
|
1514
|
+
1ページ分のウォレット数です。デフォルト値は30です。
|
|
1515
|
+
|
|
1516
|
+
---
|
|
1517
|
+
`created_at_from`
|
|
1518
|
+
```json
|
|
1519
|
+
{
|
|
1520
|
+
"type": "string",
|
|
1521
|
+
"format": "date-time"
|
|
1522
|
+
}
|
|
1523
|
+
```
|
|
1524
|
+
ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1525
|
+
|
|
1526
|
+
---
|
|
1527
|
+
`created_at_to`
|
|
1528
|
+
```json
|
|
1529
|
+
{
|
|
1530
|
+
"type": "string",
|
|
1531
|
+
"format": "date-time"
|
|
1532
|
+
}
|
|
1533
|
+
```
|
|
1534
|
+
ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
1535
|
+
|
|
1536
|
+
---
|
|
1537
|
+
`is_suspended`
|
|
1538
|
+
```json
|
|
1539
|
+
{ "type": "boolean" }
|
|
1540
|
+
```
|
|
1541
|
+
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
1542
|
+
|
|
1543
|
+
---
|
|
1544
|
+
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1545
|
+
<a name="create-customer-account"></a>
|
|
1546
|
+
#### 新規エンドユーザーウォレットを追加する
|
|
1547
|
+
指定したマネーのウォレットを作成し、同時にそのウォレットを保有するユーザも作成します。
|
|
1548
|
+
```ruby
|
|
1549
|
+
response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
|
|
1550
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1551
|
+
user_name: "ポケペイ太郎", # ユーザー名
|
|
1552
|
+
account_name: "ポケペイ太郎のアカウント" # アカウント名
|
|
1553
|
+
))
|
|
1554
|
+
```
|
|
1555
|
+
|
|
1556
|
+
---
|
|
1557
|
+
`private_money_id`
|
|
1558
|
+
```json
|
|
1559
|
+
{
|
|
1560
|
+
"type": "string",
|
|
1561
|
+
"format": "uuid"
|
|
1562
|
+
}
|
|
1563
|
+
```
|
|
1564
|
+
マネーIDです。
|
|
1565
|
+
|
|
1566
|
+
これによって作成するウォレットのマネーを指定します。
|
|
1567
|
+
|
|
1568
|
+
---
|
|
1569
|
+
`user_name`
|
|
1570
|
+
```json
|
|
1571
|
+
{
|
|
1572
|
+
"type": "string",
|
|
1573
|
+
"maxLength": 256
|
|
1574
|
+
}
|
|
1575
|
+
```
|
|
1576
|
+
ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
|
|
1577
|
+
|
|
1578
|
+
---
|
|
1579
|
+
`account_name`
|
|
1580
|
+
```json
|
|
1581
|
+
{
|
|
1582
|
+
"type": "string",
|
|
1583
|
+
"maxLength": 256
|
|
1584
|
+
}
|
|
1585
|
+
```
|
|
1586
|
+
作成するウォレット名です。省略した場合は空文字となります。
|
|
1587
|
+
|
|
1588
|
+
---
|
|
1589
|
+
成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
|
|
1590
|
+
<a name="get-shop-accounts"></a>
|
|
1591
|
+
#### 店舗ユーザーのウォレット一覧を表示する
|
|
1592
|
+
マネーを指定して店舗ユーザーのウォレット一覧を取得します。
|
|
726
1593
|
```ruby
|
|
727
|
-
response = $client.send(Pokepay::Request::
|
|
728
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
729
|
-
page:
|
|
730
|
-
per_page:
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
1594
|
+
response = $client.send(Pokepay::Request::GetShopAccounts.new(
|
|
1595
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1596
|
+
page: 9407, # ページ番号
|
|
1597
|
+
per_page: 8985, # 1ページ分のウォレット数
|
|
1598
|
+
created_at_from: "2025-01-28T18:22:53.000000+09:00", # ウォレット作成日によるフィルター(開始時点)
|
|
1599
|
+
created_at_to: "2019-06-08T22:34:01.000000+09:00", # ウォレット作成日によるフィルター(終了時点)
|
|
1600
|
+
is_suspended: true # ウォレットが凍結状態かどうかでフィルターする
|
|
734
1601
|
))
|
|
735
1602
|
```
|
|
736
1603
|
|
|
737
1604
|
---
|
|
738
|
-
`
|
|
739
|
-
|
|
1605
|
+
`private_money_id`
|
|
1606
|
+
```json
|
|
1607
|
+
{
|
|
1608
|
+
"type": "string",
|
|
1609
|
+
"format": "uuid"
|
|
1610
|
+
}
|
|
1611
|
+
```
|
|
1612
|
+
マネーIDです。
|
|
740
1613
|
|
|
741
|
-
|
|
1614
|
+
一覧するウォレットのマネーを指定します。このパラメータは必須です。
|
|
742
1615
|
|
|
743
1616
|
---
|
|
744
1617
|
`page`
|
|
1618
|
+
```json
|
|
1619
|
+
{
|
|
1620
|
+
"type": "integer",
|
|
1621
|
+
"minimum": 1
|
|
1622
|
+
}
|
|
1623
|
+
```
|
|
745
1624
|
取得したいページ番号です。デフォルト値は1です。
|
|
746
1625
|
|
|
747
1626
|
---
|
|
748
1627
|
`per_page`
|
|
749
|
-
|
|
1628
|
+
```json
|
|
1629
|
+
{
|
|
1630
|
+
"type": "integer",
|
|
1631
|
+
"minimum": 1
|
|
1632
|
+
}
|
|
1633
|
+
```
|
|
1634
|
+
1ページ分のウォレット数です。デフォルト値は30です。
|
|
750
1635
|
|
|
751
1636
|
---
|
|
752
|
-
`
|
|
753
|
-
|
|
1637
|
+
`created_at_from`
|
|
1638
|
+
```json
|
|
1639
|
+
{
|
|
1640
|
+
"type": "string",
|
|
1641
|
+
"format": "date-time"
|
|
1642
|
+
}
|
|
1643
|
+
```
|
|
1644
|
+
ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
|
754
1645
|
|
|
755
1646
|
---
|
|
756
|
-
`
|
|
757
|
-
|
|
1647
|
+
`created_at_to`
|
|
1648
|
+
```json
|
|
1649
|
+
{
|
|
1650
|
+
"type": "string",
|
|
1651
|
+
"format": "date-time"
|
|
1652
|
+
}
|
|
1653
|
+
```
|
|
1654
|
+
ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
|
758
1655
|
|
|
759
1656
|
---
|
|
760
|
-
`
|
|
761
|
-
|
|
1657
|
+
`is_suspended`
|
|
1658
|
+
```json
|
|
1659
|
+
{ "type": "boolean" }
|
|
1660
|
+
```
|
|
1661
|
+
このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
|
|
762
1662
|
|
|
763
1663
|
---
|
|
764
|
-
成功したときは[
|
|
765
|
-
|
|
1664
|
+
成功したときは[PaginatedAccountWithUsers](#paginated-account-with-users)オブジェクトを返します
|
|
1665
|
+
<a name="list-customer-transactions"></a>
|
|
766
1666
|
#### 取引履歴を取得する
|
|
767
1667
|
取引一覧を返します。
|
|
768
1668
|
```ruby
|
|
769
1669
|
response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
770
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
771
|
-
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
772
|
-
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
773
|
-
type: "
|
|
774
|
-
is_modified:
|
|
775
|
-
from: "
|
|
776
|
-
to: "
|
|
777
|
-
page: 1,
|
|
778
|
-
per_page: 50
|
|
1670
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
1671
|
+
sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 送金エンドユーザーID
|
|
1672
|
+
receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 受取エンドユーザーID
|
|
1673
|
+
type: "4", # 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
|
|
1674
|
+
is_modified: false, # キャンセル済みかどうか
|
|
1675
|
+
from: "2018-07-21T00:36:24.000000+09:00", # 開始日時
|
|
1676
|
+
to: "2020-07-01T13:28:22.000000+09:00", # 終了日時
|
|
1677
|
+
page: 1, # ページ番号
|
|
1678
|
+
per_page: 50 # 1ページ分の取引数
|
|
779
1679
|
))
|
|
780
1680
|
```
|
|
781
1681
|
|
|
782
1682
|
---
|
|
783
1683
|
`private_money_id`
|
|
1684
|
+
```json
|
|
1685
|
+
{
|
|
1686
|
+
"type": "string",
|
|
1687
|
+
"format": "uuid"
|
|
1688
|
+
}
|
|
1689
|
+
```
|
|
784
1690
|
マネーIDです。
|
|
785
1691
|
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
|
786
1692
|
|
|
787
1693
|
---
|
|
788
1694
|
`sender_customer_id`
|
|
1695
|
+
```json
|
|
1696
|
+
{
|
|
1697
|
+
"type": "string",
|
|
1698
|
+
"format": "uuid"
|
|
1699
|
+
}
|
|
1700
|
+
```
|
|
789
1701
|
送金ユーザーIDです。
|
|
790
1702
|
|
|
791
1703
|
フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
|
|
792
1704
|
|
|
793
1705
|
---
|
|
794
1706
|
`receiver_customer_id`
|
|
1707
|
+
```json
|
|
1708
|
+
{
|
|
1709
|
+
"type": "string",
|
|
1710
|
+
"format": "uuid"
|
|
1711
|
+
}
|
|
1712
|
+
```
|
|
795
1713
|
受取ユーザーIDです。
|
|
796
1714
|
|
|
797
1715
|
フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
|
|
798
1716
|
|
|
799
1717
|
---
|
|
800
1718
|
`type`
|
|
1719
|
+
```json
|
|
1720
|
+
{ "type": "string" }
|
|
1721
|
+
```
|
|
801
1722
|
取引の種類でフィルターします。
|
|
802
1723
|
|
|
803
1724
|
以下の種類を指定できます。
|
|
@@ -813,6 +1734,9 @@ response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
|
|
|
813
1734
|
|
|
814
1735
|
---
|
|
815
1736
|
`is_modified`
|
|
1737
|
+
```json
|
|
1738
|
+
{ "type": "boolean" }
|
|
1739
|
+
```
|
|
816
1740
|
キャンセル済みかどうかを判定するフラグです。
|
|
817
1741
|
|
|
818
1742
|
これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
|
|
@@ -821,131 +1745,519 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
|
|
|
821
1745
|
|
|
822
1746
|
---
|
|
823
1747
|
`from`
|
|
1748
|
+
```json
|
|
1749
|
+
{
|
|
1750
|
+
"type": "string",
|
|
1751
|
+
"format": "date-time"
|
|
1752
|
+
}
|
|
1753
|
+
```
|
|
824
1754
|
抽出期間の開始日時です。
|
|
825
1755
|
|
|
826
1756
|
フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
|
|
827
1757
|
|
|
828
1758
|
---
|
|
829
1759
|
`to`
|
|
1760
|
+
```json
|
|
1761
|
+
{
|
|
1762
|
+
"type": "string",
|
|
1763
|
+
"format": "date-time"
|
|
1764
|
+
}
|
|
1765
|
+
```
|
|
830
1766
|
抽出期間の終了日時です。
|
|
831
1767
|
|
|
832
1768
|
フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
|
|
833
1769
|
|
|
834
1770
|
---
|
|
835
1771
|
`page`
|
|
1772
|
+
```json
|
|
1773
|
+
{
|
|
1774
|
+
"type": "integer",
|
|
1775
|
+
"minimum": 1
|
|
1776
|
+
}
|
|
1777
|
+
```
|
|
836
1778
|
取得したいページ番号です。
|
|
837
1779
|
|
|
838
1780
|
---
|
|
839
1781
|
`per_page`
|
|
1782
|
+
```json
|
|
1783
|
+
{
|
|
1784
|
+
"type": "integer",
|
|
1785
|
+
"minimum": 1
|
|
1786
|
+
}
|
|
1787
|
+
```
|
|
840
1788
|
1ページ分の取引数です。
|
|
841
1789
|
|
|
842
1790
|
---
|
|
843
1791
|
成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
|
|
844
|
-
|
|
845
1792
|
### Organization
|
|
846
|
-
|
|
847
|
-
#### 新規加盟店組織を追加する
|
|
848
|
-
```ruby
|
|
849
|
-
response = $client.send(Pokepay::Request::CreateOrganization.new(
|
|
850
|
-
"ox_supermarket", // code: 新規組織コード
|
|
851
|
-
"oxスーパー", // name: 新規組織名
|
|
852
|
-
["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], // private_money_ids: 加盟店組織で有効にするマネーIDの配列
|
|
853
|
-
"Kkoz4u4vqN@tkYj.com", // issuer_admin_user_email: 発行体担当者メールアドレス
|
|
854
|
-
"PXUyJ1V0r5@CHRN.com", // member_admin_user_email: 新規組織担当者メールアドレス
|
|
855
|
-
bank_name: "XYZ銀行", // 銀行名
|
|
856
|
-
bank_code: "99X", // 銀行金融機関コード
|
|
857
|
-
bank_branch_name: "ABC支店", // 銀行支店名
|
|
858
|
-
bank_branch_code: "99X", // 銀行支店コード
|
|
859
|
-
bank_account_type: "saving", // 銀行口座種別 (普通=saving, 当座=current, その他=other)
|
|
860
|
-
bank_account: 9999999, // 銀行口座番号
|
|
861
|
-
bank_account_holder_name: "ﾌｸｻﾞﾜﾕｷﾁ", // 口座名義人名
|
|
862
|
-
contact_name: "佐藤清" // 担当者名
|
|
863
|
-
))
|
|
864
|
-
```
|
|
865
|
-
成功したときは[Organization](#organization)オブジェクトを返します
|
|
866
|
-
|
|
867
1793
|
### Shop
|
|
868
|
-
|
|
869
|
-
#### 新規店舗を追加する
|
|
870
|
-
```ruby
|
|
871
|
-
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
872
|
-
"oxスーパー三田店", // shop_name: 店舗名
|
|
873
|
-
shop_postal_code: "422-5364", // 店舗の郵便番号
|
|
874
|
-
shop_address: "東京都港区芝...", // 店舗の住所
|
|
875
|
-
shop_tel: "083-33-947", // 店舗の電話番号
|
|
876
|
-
shop_email: "pSCBGnb27K@I1Ko.com", // 店舗のメールアドレス
|
|
877
|
-
shop_external_id: "9Ro9P2UOPHKc", // 店舗の外部ID
|
|
878
|
-
organization_code: "ox-supermarket" // 組織コード
|
|
879
|
-
))
|
|
880
|
-
```
|
|
881
|
-
成功したときは[User](#user)オブジェクトを返します
|
|
882
|
-
|
|
1794
|
+
<a name="list-shops"></a>
|
|
883
1795
|
#### 店舗一覧を取得する
|
|
884
1796
|
```ruby
|
|
885
1797
|
response = $client.send(Pokepay::Request::ListShops.new(
|
|
886
|
-
organization_code: "pocketchange",
|
|
887
|
-
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
888
|
-
|
|
889
|
-
|
|
1798
|
+
organization_code: "pocketchange", # 組織コード
|
|
1799
|
+
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
|
|
1800
|
+
name: "oxスーパー三田店", # 店舗名
|
|
1801
|
+
postal_code: "431-5371", # 店舗の郵便番号
|
|
1802
|
+
address: "東京都港区芝...", # 店舗の住所
|
|
1803
|
+
tel: "079852808", # 店舗の電話番号
|
|
1804
|
+
email: "RgnqYnUlh4@JbOr.com", # 店舗のメールアドレス
|
|
1805
|
+
external_id: "j5jFwrAdcz57ZO", # 店舗の外部ID
|
|
1806
|
+
page: 1, # ページ番号
|
|
1807
|
+
per_page: 50 # 1ページ分の取引数
|
|
890
1808
|
))
|
|
891
1809
|
```
|
|
892
1810
|
|
|
893
1811
|
---
|
|
894
1812
|
`organization_code`
|
|
1813
|
+
```json
|
|
1814
|
+
{
|
|
1815
|
+
"type": "string",
|
|
1816
|
+
"maxLength": 32,
|
|
1817
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
|
1818
|
+
}
|
|
1819
|
+
```
|
|
895
1820
|
このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
|
|
896
1821
|
|
|
897
1822
|
|
|
898
1823
|
---
|
|
899
1824
|
`private_money_id`
|
|
1825
|
+
```json
|
|
1826
|
+
{
|
|
1827
|
+
"type": "string",
|
|
1828
|
+
"format": "uuid"
|
|
1829
|
+
}
|
|
1830
|
+
```
|
|
900
1831
|
このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
|
|
901
1832
|
|
|
902
1833
|
|
|
1834
|
+
---
|
|
1835
|
+
`name`
|
|
1836
|
+
```json
|
|
1837
|
+
{
|
|
1838
|
+
"type": "string",
|
|
1839
|
+
"minLength": 1,
|
|
1840
|
+
"maxLength": 256
|
|
1841
|
+
}
|
|
1842
|
+
```
|
|
1843
|
+
このパラメータを渡すとその名前の店舗のみが返されます。
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
---
|
|
1847
|
+
`postal_code`
|
|
1848
|
+
```json
|
|
1849
|
+
{
|
|
1850
|
+
"type": "string",
|
|
1851
|
+
"pattern": "^[0-9]{3}-?[0-9]{4}$"
|
|
1852
|
+
}
|
|
1853
|
+
```
|
|
1854
|
+
このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
---
|
|
1858
|
+
`address`
|
|
1859
|
+
```json
|
|
1860
|
+
{
|
|
1861
|
+
"type": "string",
|
|
1862
|
+
"maxLength": 256
|
|
1863
|
+
}
|
|
1864
|
+
```
|
|
1865
|
+
このパラメータを渡すとその住所が登録された店舗のみが返されます。
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
---
|
|
1869
|
+
`tel`
|
|
1870
|
+
```json
|
|
1871
|
+
{
|
|
1872
|
+
"type": "string",
|
|
1873
|
+
"pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
|
|
1874
|
+
}
|
|
1875
|
+
```
|
|
1876
|
+
このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
---
|
|
1880
|
+
`email`
|
|
1881
|
+
```json
|
|
1882
|
+
{
|
|
1883
|
+
"type": "string",
|
|
1884
|
+
"format": "email",
|
|
1885
|
+
"maxLength": 256
|
|
1886
|
+
}
|
|
1887
|
+
```
|
|
1888
|
+
このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
---
|
|
1892
|
+
`external_id`
|
|
1893
|
+
```json
|
|
1894
|
+
{
|
|
1895
|
+
"type": "string",
|
|
1896
|
+
"maxLength": 36
|
|
1897
|
+
}
|
|
1898
|
+
```
|
|
1899
|
+
このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
|
|
1900
|
+
|
|
1901
|
+
|
|
903
1902
|
---
|
|
904
1903
|
`page`
|
|
1904
|
+
```json
|
|
1905
|
+
{
|
|
1906
|
+
"type": "integer",
|
|
1907
|
+
"minimum": 1
|
|
1908
|
+
}
|
|
1909
|
+
```
|
|
905
1910
|
取得したいページ番号です。
|
|
906
1911
|
|
|
907
1912
|
---
|
|
908
1913
|
`per_page`
|
|
1914
|
+
```json
|
|
1915
|
+
{
|
|
1916
|
+
"type": "integer",
|
|
1917
|
+
"minimum": 1
|
|
1918
|
+
}
|
|
1919
|
+
```
|
|
909
1920
|
1ページ分の取引数です。
|
|
910
1921
|
|
|
911
1922
|
---
|
|
912
1923
|
成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
|
|
1924
|
+
<a name="create-shop"></a>
|
|
1925
|
+
#### 新規店舗を追加する(廃止予定)
|
|
1926
|
+
新規店舗を追加します。このAPIは廃止予定です。以降は `CreateShopV2` を使用してください。
|
|
1927
|
+
```ruby
|
|
1928
|
+
response = $client.send(Pokepay::Request::CreateShop.new(
|
|
1929
|
+
"oxスーパー三田店", # shop_name: 店舗名
|
|
1930
|
+
shop_postal_code: "7934204", # 店舗の郵便番号
|
|
1931
|
+
shop_address: "東京都港区芝...", # 店舗の住所
|
|
1932
|
+
shop_tel: "024-611-002", # 店舗の電話番号
|
|
1933
|
+
shop_email: "Ono1AcjM96@oftC.com", # 店舗のメールアドレス
|
|
1934
|
+
shop_external_id: "hiSDgXKvV", # 店舗の外部ID
|
|
1935
|
+
organization_code: "ox-supermarket" # 組織コード
|
|
1936
|
+
))
|
|
1937
|
+
```
|
|
1938
|
+
成功したときは[User](#user)オブジェクトを返します
|
|
1939
|
+
<a name="create-shop-v2"></a>
|
|
1940
|
+
#### 新規店舗を追加する
|
|
1941
|
+
```ruby
|
|
1942
|
+
response = $client.send(Pokepay::Request::CreateShopV2.new(
|
|
1943
|
+
"oxスーパー三田店", # name: 店舗名
|
|
1944
|
+
postal_code: "950-0366", # 店舗の郵便番号
|
|
1945
|
+
address: "東京都港区芝...", # 店舗の住所
|
|
1946
|
+
tel: "0443-379", # 店舗の電話番号
|
|
1947
|
+
email: "Mo26iqol80@j1t4.com", # 店舗のメールアドレス
|
|
1948
|
+
external_id: "lpnoezO", # 店舗の外部ID
|
|
1949
|
+
organization_code: "ox-supermarket", # 組織コード
|
|
1950
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
1951
|
+
can_topup_private_money_ids: [] # 店舗でチャージ可能にするマネーIDの配列
|
|
1952
|
+
))
|
|
1953
|
+
```
|
|
913
1954
|
|
|
914
|
-
|
|
1955
|
+
---
|
|
1956
|
+
`name`
|
|
1957
|
+
```json
|
|
1958
|
+
{
|
|
1959
|
+
"type": "string",
|
|
1960
|
+
"minLength": 1,
|
|
1961
|
+
"maxLength": 256
|
|
1962
|
+
}
|
|
1963
|
+
```
|
|
1964
|
+
店舗名です。
|
|
1965
|
+
|
|
1966
|
+
同一組織内に同名の店舗があった場合は`name_conflict`エラーが返ります。
|
|
1967
|
+
|
|
1968
|
+
---
|
|
1969
|
+
`private_money_ids`
|
|
1970
|
+
```json
|
|
1971
|
+
{
|
|
1972
|
+
"type": "array",
|
|
1973
|
+
"minItems": 1,
|
|
1974
|
+
"items": {
|
|
1975
|
+
"type": "string",
|
|
1976
|
+
"format": "uuid"
|
|
1977
|
+
}
|
|
1978
|
+
}
|
|
1979
|
+
```
|
|
1980
|
+
店舗で有効にするマネーIDの配列を指定します。
|
|
1981
|
+
|
|
1982
|
+
店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
|
|
1983
|
+
このパラメータを省略したときは、店舗が所属する組織が発行または加盟している全てのマネーのウォレットができます。
|
|
1984
|
+
|
|
1985
|
+
---
|
|
1986
|
+
`can_topup_private_money_ids`
|
|
1987
|
+
```json
|
|
1988
|
+
{
|
|
1989
|
+
"type": "array",
|
|
1990
|
+
"minItems": 0,
|
|
1991
|
+
"items": {
|
|
1992
|
+
"type": "string",
|
|
1993
|
+
"format": "uuid"
|
|
1994
|
+
}
|
|
1995
|
+
}
|
|
1996
|
+
```
|
|
1997
|
+
店舗でチャージ可能にするマネーIDの配列を指定します。
|
|
915
1998
|
|
|
1999
|
+
このパラメータは発行体のみが指定でき、自身が発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
|
|
2000
|
+
省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
|
|
2001
|
+
|
|
2002
|
+
---
|
|
2003
|
+
成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
|
|
2004
|
+
<a name="get-shop"></a>
|
|
2005
|
+
#### 店舗情報を表示する
|
|
2006
|
+
店舗情報を表示します。
|
|
2007
|
+
|
|
2008
|
+
権限に関わらず自組織の店舗情報は表示可能です。それに加え、発行体は自組織の発行しているマネーの加盟店組織の店舗情報を表示できます。
|
|
2009
|
+
```ruby
|
|
2010
|
+
response = $client.send(Pokepay::Request::GetShop.new(
|
|
2011
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # shop_id: 店舗ユーザーID
|
|
2012
|
+
))
|
|
2013
|
+
```
|
|
2014
|
+
成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
|
|
2015
|
+
<a name="update-shop"></a>
|
|
2016
|
+
#### 店舗情報を更新する
|
|
2017
|
+
店舗情報を更新します。bodyパラメーターは全て省略可能で、指定したもののみ更新されます。
|
|
2018
|
+
```ruby
|
|
2019
|
+
response = $client.send(Pokepay::Request::UpdateShop.new(
|
|
2020
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 店舗ユーザーID
|
|
2021
|
+
name: "oxスーパー三田店", # 店舗名
|
|
2022
|
+
postal_code: "3489665", # 店舗の郵便番号
|
|
2023
|
+
address: "東京都港区芝...", # 店舗の住所
|
|
2024
|
+
tel: "01-3271-444", # 店舗の電話番号
|
|
2025
|
+
email: "QnDY4S9N4H@hJ5r.com", # 店舗のメールアドレス
|
|
2026
|
+
external_id: "CsXRcUZY47cpIh03B", # 店舗の外部ID
|
|
2027
|
+
private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 店舗で有効にするマネーIDの配列
|
|
2028
|
+
can_topup_private_money_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] # 店舗でチャージ可能にするマネーIDの配列
|
|
2029
|
+
))
|
|
2030
|
+
```
|
|
2031
|
+
|
|
2032
|
+
---
|
|
2033
|
+
`name`
|
|
2034
|
+
```json
|
|
2035
|
+
{
|
|
2036
|
+
"type": "string",
|
|
2037
|
+
"minLength": 1,
|
|
2038
|
+
"maxLength": 256
|
|
2039
|
+
}
|
|
2040
|
+
```
|
|
2041
|
+
店舗名です。
|
|
2042
|
+
|
|
2043
|
+
同一組織内に同名の店舗があった場合は`shop_name_conflict`エラーが返ります。
|
|
2044
|
+
|
|
2045
|
+
---
|
|
2046
|
+
`postal_code`
|
|
2047
|
+
```json
|
|
2048
|
+
{
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"pattern": "^[0-9]{3}-?[0-9]{4}$"
|
|
2051
|
+
}
|
|
2052
|
+
```
|
|
2053
|
+
店舗住所の郵便番号(7桁の数字)です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
|
|
2054
|
+
|
|
2055
|
+
---
|
|
2056
|
+
`tel`
|
|
2057
|
+
```json
|
|
2058
|
+
{
|
|
2059
|
+
"type": "string",
|
|
2060
|
+
"pattern": "^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$"
|
|
2061
|
+
}
|
|
2062
|
+
```
|
|
2063
|
+
店舗の電話番号です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
|
|
2064
|
+
|
|
2065
|
+
---
|
|
2066
|
+
`email`
|
|
2067
|
+
```json
|
|
2068
|
+
{
|
|
2069
|
+
"type": "string",
|
|
2070
|
+
"format": "email",
|
|
2071
|
+
"maxLength": 256
|
|
2072
|
+
}
|
|
2073
|
+
```
|
|
2074
|
+
店舗の連絡先メールアドレスです。明示的に空の値を設定するにはNULLを指定します。
|
|
2075
|
+
|
|
2076
|
+
---
|
|
2077
|
+
`external_id`
|
|
2078
|
+
```json
|
|
2079
|
+
{
|
|
2080
|
+
"type": "string",
|
|
2081
|
+
"maxLength": 36
|
|
2082
|
+
}
|
|
2083
|
+
```
|
|
2084
|
+
店舗の外部IDです(最大36文字)。明示的に空の値を設定するにはNULLを指定します。
|
|
2085
|
+
|
|
2086
|
+
---
|
|
2087
|
+
`private_money_ids`
|
|
2088
|
+
```json
|
|
2089
|
+
{
|
|
2090
|
+
"type": "array",
|
|
2091
|
+
"minItems": 0,
|
|
2092
|
+
"items": {
|
|
2093
|
+
"type": "string",
|
|
2094
|
+
"format": "uuid"
|
|
2095
|
+
}
|
|
2096
|
+
}
|
|
2097
|
+
```
|
|
2098
|
+
店舗で有効にするマネーIDの配列を指定します。
|
|
2099
|
+
|
|
2100
|
+
店舗が所属する組織が発行または加盟しているマネーのみが指定できます。利用できないマネーが指定された場合は`unavailable_private_money`エラーが返ります。
|
|
2101
|
+
店舗が既にウォレットを持っている場合に、ここでそのウォレットのマネーIDを指定しないで更新すると、そのマネーのウォレットは凍結(無効化)されます。
|
|
2102
|
+
|
|
2103
|
+
---
|
|
2104
|
+
`can_topup_private_money_ids`
|
|
2105
|
+
```json
|
|
2106
|
+
{
|
|
2107
|
+
"type": "array",
|
|
2108
|
+
"minItems": 0,
|
|
2109
|
+
"items": {
|
|
2110
|
+
"type": "string",
|
|
2111
|
+
"format": "uuid"
|
|
2112
|
+
}
|
|
2113
|
+
}
|
|
2114
|
+
```
|
|
2115
|
+
店舗でチャージ可能にするマネーIDの配列を指定します。
|
|
2116
|
+
|
|
2117
|
+
このパラメータは発行体のみが指定でき、発行しているマネーのみを指定できます。加盟店が他発行体のマネーに加盟している場合でも、そのチャージ可否を変更することはできません。
|
|
2118
|
+
省略したときは対象店舗のその発行体の全てのマネーのアカウントがチャージ不可となります。
|
|
2119
|
+
|
|
2120
|
+
---
|
|
2121
|
+
成功したときは[ShopWithAccounts](#shop-with-accounts)オブジェクトを返します
|
|
2122
|
+
### Account
|
|
2123
|
+
<a name="list-user-accounts"></a>
|
|
916
2124
|
#### エンドユーザー、店舗ユーザーのウォレット一覧を表示する
|
|
917
2125
|
ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
|
|
918
2126
|
```ruby
|
|
919
2127
|
response = $client.send(Pokepay::Request::ListUserAccounts.new(
|
|
920
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
2128
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # user_id: ユーザーID
|
|
921
2129
|
))
|
|
922
2130
|
```
|
|
923
2131
|
|
|
924
2132
|
---
|
|
925
2133
|
`user_id`
|
|
2134
|
+
```json
|
|
2135
|
+
{
|
|
2136
|
+
"type": "string",
|
|
2137
|
+
"format": "uuid"
|
|
2138
|
+
}
|
|
2139
|
+
```
|
|
926
2140
|
ユーザーIDです。
|
|
927
2141
|
|
|
928
2142
|
指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
|
|
929
2143
|
|
|
930
2144
|
---
|
|
931
2145
|
成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
|
|
932
|
-
|
|
933
2146
|
### Private Money
|
|
2147
|
+
<a name="get-private-moneys"></a>
|
|
2148
|
+
#### マネー一覧を取得する
|
|
2149
|
+
マネーの一覧を取得します。
|
|
2150
|
+
パートナーキーの管理者が発行体組織に属している場合、自組織が加盟または発行しているマネーの一覧を返します。また、`organization_code`として決済加盟店の組織コードを指定した場合、発行マネーのうち、その決済加盟店組織が加盟しているマネーの一覧を返します。
|
|
2151
|
+
パートナーキーの管理者が決済加盟店組織に属している場合は、自組織が加盟しているマネーの一覧を返します。
|
|
2152
|
+
```ruby
|
|
2153
|
+
response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
|
|
2154
|
+
organization_code: "ox-supermarket", # 組織コード
|
|
2155
|
+
page: 1, # ページ番号
|
|
2156
|
+
per_page: 50 # 1ページ分の取得数
|
|
2157
|
+
))
|
|
2158
|
+
```
|
|
2159
|
+
|
|
2160
|
+
---
|
|
2161
|
+
`organization_code`
|
|
2162
|
+
```json
|
|
2163
|
+
{
|
|
2164
|
+
"type": "string",
|
|
2165
|
+
"maxLength": 32,
|
|
2166
|
+
"pattern": "^[a-zA-Z0-9-]*$"
|
|
2167
|
+
}
|
|
2168
|
+
```
|
|
2169
|
+
パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
|
|
934
2170
|
|
|
2171
|
+
---
|
|
2172
|
+
成功したときは[PaginatedPrivateMoneys](#paginated-private-moneys)オブジェクトを返します
|
|
2173
|
+
<a name="get-private-money-organization-summaries"></a>
|
|
935
2174
|
#### 決済加盟店の取引サマリを取得する
|
|
936
2175
|
```ruby
|
|
937
2176
|
response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
|
|
938
|
-
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
939
|
-
from: "
|
|
940
|
-
to: "
|
|
941
|
-
page: 1,
|
|
942
|
-
per_page: 50
|
|
2177
|
+
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
|
|
2178
|
+
from: "2019-05-24T22:23:13.000000+09:00", # 開始日時(toと同時に指定する必要有)
|
|
2179
|
+
to: "2023-11-28T06:04:04.000000+09:00", # 終了日時(fromと同時に指定する必要有)
|
|
2180
|
+
page: 1, # ページ番号
|
|
2181
|
+
per_page: 50 # 1ページ分の取引数
|
|
943
2182
|
))
|
|
944
2183
|
```
|
|
945
2184
|
`from`と`to`は同時に指定する必要があります。
|
|
946
2185
|
|
|
947
2186
|
成功したときは[PaginatedPrivateMoneyOrganizationSummaries](#paginated-private-money-organization-summaries)オブジェクトを返します
|
|
2187
|
+
### Bulk
|
|
2188
|
+
<a name="bulk-create-transaction"></a>
|
|
2189
|
+
#### CSVファイル一括取引
|
|
2190
|
+
CSVファイルから一括取引をします。
|
|
2191
|
+
```ruby
|
|
2192
|
+
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
|
|
2193
|
+
"YHoO28zEE65", # name: 一括取引タスク名
|
|
2194
|
+
"UlKt", # content: 取引する情報のCSV
|
|
2195
|
+
"MCe12MUV2dxrA2428zEWnFZLX87qtedPzV8N", # request_id: リクエストID
|
|
2196
|
+
description: "diYCurcmVOPZzwMWHgQ0VESfspW9b9NBdczTSynCfTiWLEN2pEbq7ZeB8PVJkE9NzaeTptZ5kX9rLpagdWQnEnTlLyubwibc5uG9Y4cn6ApRZ5NX6gFb5nuODlmm9r" # 一括取引の説明
|
|
2197
|
+
))
|
|
2198
|
+
```
|
|
2199
|
+
|
|
2200
|
+
---
|
|
2201
|
+
`name`
|
|
2202
|
+
```json
|
|
2203
|
+
{
|
|
2204
|
+
"type": "string",
|
|
2205
|
+
"maxLength": 32
|
|
2206
|
+
}
|
|
2207
|
+
```
|
|
2208
|
+
一括取引タスクの管理用の名前です。
|
|
2209
|
+
|
|
2210
|
+
---
|
|
2211
|
+
`description`
|
|
2212
|
+
```json
|
|
2213
|
+
{
|
|
2214
|
+
"type": "string",
|
|
2215
|
+
"maxLength": 128
|
|
2216
|
+
}
|
|
2217
|
+
```
|
|
2218
|
+
一括取引タスクの管理用の説明文です。
|
|
2219
|
+
|
|
2220
|
+
---
|
|
2221
|
+
`content`
|
|
2222
|
+
```json
|
|
2223
|
+
{ "type": "string" }
|
|
2224
|
+
```
|
|
2225
|
+
一括取引する情報を書いたCSVの文字列です。
|
|
2226
|
+
1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
|
|
2227
|
+
カラムは以下の7つです。任意のカラムには空文字を指定します。
|
|
2228
|
+
|
|
2229
|
+
- `type`: 取引種別
|
|
2230
|
+
- 必須。'topup' または 'payment'
|
|
2231
|
+
- `sender_id`: 送金ユーザーID
|
|
2232
|
+
- 必須。UUID
|
|
2233
|
+
- `receiver_id`: 受取ユーザーID
|
|
2234
|
+
- 必須。UUID
|
|
2235
|
+
- `private_money_id`: マネーID
|
|
2236
|
+
- 必須。UUID
|
|
2237
|
+
- `money_amount`: マネー額
|
|
2238
|
+
- 任意。ただし `point_amount` といずれかが必須。0以上の数字
|
|
2239
|
+
- `point_amount`: ポイント額
|
|
2240
|
+
- 任意。ただし `money_amount` といずれかが必須。0以上の数字
|
|
2241
|
+
- `description`: 取引の説明文
|
|
2242
|
+
- 任意。200文字以内。取引履歴に表示される文章
|
|
2243
|
+
- `bear_account_id`: ポイント負担ウォレットID
|
|
2244
|
+
- `point_amount` があるときは必須。UUID
|
|
2245
|
+
- `point_expires_at`: ポイントの有効期限
|
|
2246
|
+
- 任意。指定がないときはマネーに設定された有効期限を適用
|
|
2247
|
+
|
|
2248
|
+
---
|
|
2249
|
+
`request_id`
|
|
2250
|
+
```json
|
|
2251
|
+
{
|
|
2252
|
+
"type": "string",
|
|
2253
|
+
"minLength": 36,
|
|
2254
|
+
"maxLength": 36
|
|
2255
|
+
}
|
|
2256
|
+
```
|
|
2257
|
+
重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
|
|
948
2258
|
|
|
2259
|
+
---
|
|
2260
|
+
成功したときは[BulkTransaction](#bulk-transaction)オブジェクトを返します
|
|
949
2261
|
## Responses
|
|
950
2262
|
|
|
951
2263
|
|
|
@@ -982,29 +2294,39 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
982
2294
|
* `description (string)`: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
|
|
983
2295
|
* `account (AccountWithUser)`: 支払いQRコード発行ウォレット
|
|
984
2296
|
* `is_disabled (boolean)`: 無効化されているかどうか
|
|
985
|
-
* `token (string)`:
|
|
2297
|
+
* `token (string)`: 支払いQRコードを解析したときに出てくるURL
|
|
986
2298
|
|
|
987
2299
|
`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
|
|
988
2300
|
|
|
989
|
-
<a name="
|
|
990
|
-
##
|
|
991
|
-
* `id (string)`:
|
|
992
|
-
* `amount (double)`:
|
|
993
|
-
* `
|
|
994
|
-
* `
|
|
995
|
-
* `
|
|
996
|
-
* `
|
|
997
|
-
* `
|
|
998
|
-
* `is_disabled (boolean)`: 無効化されているかどうか
|
|
999
|
-
* `expires_at (string)`: チャージQRコード自体の失効日時
|
|
1000
|
-
* `private_money (PrivateMoney)`: 対象マネー情報
|
|
1001
|
-
* `usage_limit (integer)`: 一回限りでない場合の最大読み取り回数
|
|
1002
|
-
* `usage_count (double)`: 一回限りでない場合の現在までに読み取られた回数
|
|
1003
|
-
* `token (string)`: チャージQRコードを解析したときに出てくるURL
|
|
2301
|
+
<a name="cashtray"></a>
|
|
2302
|
+
## Cashtray
|
|
2303
|
+
* `id (string)`: Cashtray自体のIDです。
|
|
2304
|
+
* `amount (double)`: 取引金額
|
|
2305
|
+
* `description (string)`: Cashtrayの説明文
|
|
2306
|
+
* `account (AccountWithUser)`: 発行店舗のウォレット
|
|
2307
|
+
* `expires_at (string)`: Cashtrayの失効日時
|
|
2308
|
+
* `canceled_at (string)`: Cashtrayの無効化日時。NULLの場合は無効化されていません
|
|
2309
|
+
* `token (string)`: CashtrayのQRコードを解析したときに出てくるURL
|
|
1004
2310
|
|
|
1005
|
-
`
|
|
2311
|
+
`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
|
|
1006
2312
|
|
|
1007
|
-
|
|
2313
|
+
<a name="cashtray-with-result"></a>
|
|
2314
|
+
## CashtrayWithResult
|
|
2315
|
+
* `id (string)`: CashtrayのID
|
|
2316
|
+
* `amount (double)`: 取引金額
|
|
2317
|
+
* `description (string)`: Cashtrayの説明文(アプリ上で取引の説明文として表示される)
|
|
2318
|
+
* `account (AccountWithUser)`: 発行店舗のウォレット
|
|
2319
|
+
* `expires_at (string)`: Cashtrayの失効日時
|
|
2320
|
+
* `canceled_at (string)`: Cashtrayの無効化日時。NULLの場合は無効化されていません
|
|
2321
|
+
* `token (string)`: CashtrayのQRコードを解析したときに出てくるURL
|
|
2322
|
+
* `attempt (CashtrayAttempt)`: Cashtray読み取り結果
|
|
2323
|
+
* `transaction (Transaction)`: 取引結果
|
|
2324
|
+
|
|
2325
|
+
`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
|
|
2326
|
+
|
|
2327
|
+
`attempt`は [CashtrayAttempt](#cashtray-attempt) オブジェクトを返します。
|
|
2328
|
+
|
|
2329
|
+
`transaction`は [Transaction](#transaction) オブジェクトを返します。
|
|
1008
2330
|
|
|
1009
2331
|
<a name="user"></a>
|
|
1010
2332
|
## User
|
|
@@ -1012,11 +2334,6 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1012
2334
|
* `name (string)`: ユーザー (または店舗) 名
|
|
1013
2335
|
* `is_merchant (boolean)`: 店舗ユーザーかどうか
|
|
1014
2336
|
|
|
1015
|
-
<a name="organization"></a>
|
|
1016
|
-
## Organization
|
|
1017
|
-
* `code (string)`: 組織コード
|
|
1018
|
-
* `name (string)`: 組織名
|
|
1019
|
-
|
|
1020
2337
|
<a name="transaction"></a>
|
|
1021
2338
|
## Transaction
|
|
1022
2339
|
* `id (string)`: 取引ID
|
|
@@ -1036,20 +2353,31 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1036
2353
|
|
|
1037
2354
|
`receiver_account`と`sender_account`は [Account](#account) オブジェクトを返します。
|
|
1038
2355
|
|
|
1039
|
-
<a name="
|
|
1040
|
-
##
|
|
1041
|
-
* `id (string)`:
|
|
1042
|
-
* `
|
|
1043
|
-
* `
|
|
1044
|
-
* `
|
|
1045
|
-
* `
|
|
1046
|
-
* `
|
|
1047
|
-
* `
|
|
1048
|
-
* `
|
|
1049
|
-
* `
|
|
1050
|
-
* `transaction_id (string)`:
|
|
2356
|
+
<a name="shop-with-accounts"></a>
|
|
2357
|
+
## ShopWithAccounts
|
|
2358
|
+
* `id (string)`: 店舗ID
|
|
2359
|
+
* `name (string)`: 店舗名
|
|
2360
|
+
* `organization_code (string)`: 組織コード
|
|
2361
|
+
* `postal_code (string)`: 店舗の郵便番号
|
|
2362
|
+
* `address (string)`: 店舗の住所
|
|
2363
|
+
* `tel (string)`: 店舗の電話番号
|
|
2364
|
+
* `email (string)`: 店舗のメールアドレス
|
|
2365
|
+
* `external_id (string)`: 店舗の外部ID
|
|
2366
|
+
* `accounts (array of ShopAccounts)`:
|
|
1051
2367
|
|
|
1052
|
-
`
|
|
2368
|
+
`accounts`は [ShopAccount](#shop-account) オブジェクトの配列を返します。
|
|
2369
|
+
|
|
2370
|
+
<a name="bulk-transaction"></a>
|
|
2371
|
+
## BulkTransaction
|
|
2372
|
+
* `id (string)`:
|
|
2373
|
+
* `request_id (string)`: リクエストID
|
|
2374
|
+
* `name (string)`: バルク取引管理用の名前
|
|
2375
|
+
* `description (string)`: バルク取引管理用の説明文
|
|
2376
|
+
* `status (string)`: バルク取引の状態
|
|
2377
|
+
* `error (string)`: バルク取引のエラー種別
|
|
2378
|
+
* `error_lineno (integer)`: バルク取引のエラーが発生した行番号
|
|
2379
|
+
* `submitted_at (string)`: バルク取引が登録された日時
|
|
2380
|
+
* `updated_at (string)`: バルク取引が更新された日時
|
|
1053
2381
|
|
|
1054
2382
|
<a name="paginated-private-money-organization-summaries"></a>
|
|
1055
2383
|
## PaginatedPrivateMoneyOrganizationSummaries
|
|
@@ -1071,6 +2399,16 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1071
2399
|
|
|
1072
2400
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
1073
2401
|
|
|
2402
|
+
<a name="paginated-transfers"></a>
|
|
2403
|
+
## PaginatedTransfers
|
|
2404
|
+
* `rows (array of Transfers)`:
|
|
2405
|
+
* `count (integer)`:
|
|
2406
|
+
* `pagination (Pagination)`:
|
|
2407
|
+
|
|
2408
|
+
`rows`は [Transfer](#transfer) オブジェクトの配列を返します。
|
|
2409
|
+
|
|
2410
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2411
|
+
|
|
1074
2412
|
<a name="paginated-accounts"></a>
|
|
1075
2413
|
## PaginatedAccounts
|
|
1076
2414
|
* `rows (array of Accounts)`:
|
|
@@ -1081,6 +2419,16 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1081
2419
|
|
|
1082
2420
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
1083
2421
|
|
|
2422
|
+
<a name="paginated-account-with-users"></a>
|
|
2423
|
+
## PaginatedAccountWithUsers
|
|
2424
|
+
* `rows (array of AccountWithUsers)`:
|
|
2425
|
+
* `count (integer)`:
|
|
2426
|
+
* `pagination (Pagination)`:
|
|
2427
|
+
|
|
2428
|
+
`rows`は [AccountWithUser](#account-with-user) オブジェクトの配列を返します。
|
|
2429
|
+
|
|
2430
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2431
|
+
|
|
1084
2432
|
<a name="paginated-account-balance"></a>
|
|
1085
2433
|
## PaginatedAccountBalance
|
|
1086
2434
|
* `rows (array of AccountBalances)`:
|
|
@@ -1111,6 +2459,16 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1111
2459
|
|
|
1112
2460
|
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
1113
2461
|
|
|
2462
|
+
<a name="paginated-private-moneys"></a>
|
|
2463
|
+
## PaginatedPrivateMoneys
|
|
2464
|
+
* `rows (array of PrivateMoneys)`:
|
|
2465
|
+
* `count (integer)`:
|
|
2466
|
+
* `pagination (Pagination)`:
|
|
2467
|
+
|
|
2468
|
+
`rows`は [PrivateMoney](#private-money) オブジェクトの配列を返します。
|
|
2469
|
+
|
|
2470
|
+
`pagination`は [Pagination](#pagination) オブジェクトを返します。
|
|
2471
|
+
|
|
1114
2472
|
<a name="private-money"></a>
|
|
1115
2473
|
## PrivateMoney
|
|
1116
2474
|
* `id (string)`: マネーID
|
|
@@ -1125,10 +2483,19 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1125
2483
|
* `type (string)`: マネー種別 (自家型=own, 第三者型=third-party)
|
|
1126
2484
|
* `expiration_type (string)`: 有効期限種別 (チャージ日起算=static, 最終利用日起算=last-update, 最終チャージ日起算=last-topup-update)
|
|
1127
2485
|
* `enable_topup_by_member (boolean)`: 加盟店によるチャージが有効かどうか
|
|
1128
|
-
* `account_image (string)`: マネーの画像URL
|
|
1129
2486
|
|
|
1130
2487
|
`organization`は [Organization](#organization) オブジェクトを返します。
|
|
1131
2488
|
|
|
2489
|
+
<a name="cashtray-attempt"></a>
|
|
2490
|
+
## CashtrayAttempt
|
|
2491
|
+
* `account (AccountWithUser)`: エンドユーザーのウォレット
|
|
2492
|
+
* `status_code (double)`: ステータスコード
|
|
2493
|
+
* `error_type (string)`: エラー型
|
|
2494
|
+
* `error_message (string)`: エラーメッセージ
|
|
2495
|
+
* `created_at (string)`: Cashtray読み取り記録の作成日時
|
|
2496
|
+
|
|
2497
|
+
`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
|
|
2498
|
+
|
|
1132
2499
|
<a name="account"></a>
|
|
1133
2500
|
## Account
|
|
1134
2501
|
* `id (string)`: ウォレットID
|
|
@@ -1138,15 +2505,15 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1138
2505
|
|
|
1139
2506
|
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
1140
2507
|
|
|
1141
|
-
<a name="account
|
|
1142
|
-
##
|
|
1143
|
-
* `id (string)`:
|
|
1144
|
-
* `name (string)`:
|
|
1145
|
-
* `is_suspended (boolean)`:
|
|
1146
|
-
* `
|
|
1147
|
-
* `
|
|
2508
|
+
<a name="shop-account"></a>
|
|
2509
|
+
## ShopAccount
|
|
2510
|
+
* `id (string)`: ウォレットID
|
|
2511
|
+
* `name (string)`: ウォレット名
|
|
2512
|
+
* `is_suspended (boolean)`: ウォレットが凍結されているかどうか
|
|
2513
|
+
* `can_transfer_topup (boolean)`: チャージ可能かどうか
|
|
2514
|
+
* `private_money (PrivateMoney)`: 設定マネー情報
|
|
1148
2515
|
|
|
1149
|
-
`
|
|
2516
|
+
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
|
|
1150
2517
|
|
|
1151
2518
|
<a name="private-money-organization-summary"></a>
|
|
1152
2519
|
## PrivateMoneyOrganizationSummary
|
|
@@ -1164,6 +2531,21 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1164
2531
|
* `has_prev (boolean)`:
|
|
1165
2532
|
* `has_next (boolean)`:
|
|
1166
2533
|
|
|
2534
|
+
<a name="transfer"></a>
|
|
2535
|
+
## Transfer
|
|
2536
|
+
* `id (string)`:
|
|
2537
|
+
* `sender_account (AccountWithoutPrivateMoneyDetail)`:
|
|
2538
|
+
* `receiver_account (AccountWithoutPrivateMoneyDetail)`:
|
|
2539
|
+
* `amount (double)`:
|
|
2540
|
+
* `money_amount (double)`:
|
|
2541
|
+
* `point_amount (double)`:
|
|
2542
|
+
* `done_at (string)`:
|
|
2543
|
+
* `type (string)`:
|
|
2544
|
+
* `description (string)`:
|
|
2545
|
+
* `transaction_id (string)`:
|
|
2546
|
+
|
|
2547
|
+
`receiver_account`と`sender_account`は [AccountWithoutPrivateMoneyDetail](#account-without-private-money-detail) オブジェクトを返します。
|
|
2548
|
+
|
|
1167
2549
|
<a name="account-balance"></a>
|
|
1168
2550
|
## AccountBalance
|
|
1169
2551
|
* `expires_at (string)`:
|
|
@@ -1180,3 +2562,26 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
|
|
|
1180
2562
|
* `tel (string)`: 店舗の電話番号
|
|
1181
2563
|
* `email (string)`: 店舗のメールアドレス
|
|
1182
2564
|
* `external_id (string)`: 店舗の外部ID
|
|
2565
|
+
|
|
2566
|
+
<a name="organization"></a>
|
|
2567
|
+
## Organization
|
|
2568
|
+
* `code (string)`: 組織コード
|
|
2569
|
+
* `name (string)`: 組織名
|
|
2570
|
+
|
|
2571
|
+
<a name="organization-summary"></a>
|
|
2572
|
+
## OrganizationSummary
|
|
2573
|
+
* `count (integer)`:
|
|
2574
|
+
* `money_amount (double)`:
|
|
2575
|
+
* `money_count (integer)`:
|
|
2576
|
+
* `point_amount (double)`:
|
|
2577
|
+
* `point_count (integer)`:
|
|
2578
|
+
|
|
2579
|
+
<a name="account-without-private-money-detail"></a>
|
|
2580
|
+
## AccountWithoutPrivateMoneyDetail
|
|
2581
|
+
* `id (string)`:
|
|
2582
|
+
* `name (string)`:
|
|
2583
|
+
* `is_suspended (boolean)`:
|
|
2584
|
+
* `private_money_id (string)`:
|
|
2585
|
+
* `user (User)`:
|
|
2586
|
+
|
|
2587
|
+
`user`は [User](#user) オブジェクトを返します。
|