pokepay_partner_ruby_sdk 0.1.9 → 0.1.10
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -5
- data/docs/index.md +808 -77
- data/lib/pokepay_partner_ruby_sdk.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/client.rb +1 -1
- data/lib/pokepay_partner_ruby_sdk/request/{create_shop_v.rb → create_shop_v2.rb} +0 -0
- data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
- data/partner.yaml +273 -273
- metadata +4 -4
@@ -32,7 +32,7 @@ require "pokepay_partner_ruby_sdk/request/list_transfers"
|
|
32
32
|
require "pokepay_partner_ruby_sdk/request/create_organization"
|
33
33
|
require "pokepay_partner_ruby_sdk/request/list_shops"
|
34
34
|
require "pokepay_partner_ruby_sdk/request/create_shop"
|
35
|
-
require "pokepay_partner_ruby_sdk/request/
|
35
|
+
require "pokepay_partner_ruby_sdk/request/create_shop_v2"
|
36
36
|
require "pokepay_partner_ruby_sdk/request/get_shop"
|
37
37
|
require "pokepay_partner_ruby_sdk/request/update_shop"
|
38
38
|
require "pokepay_partner_ruby_sdk/request/get_private_moneys"
|
@@ -46,7 +46,7 @@ module Pokepay
|
|
46
46
|
'timestamp' => Time.now.iso8601(6),
|
47
47
|
'partner_call_id' => SecureRandom.uuid }
|
48
48
|
params = {"partner_client_id" => @client_id,
|
49
|
-
"data" => Base64.urlsafe_encode64(@crypto.encrypt(JSON.generate(encrypt_data)))}
|
49
|
+
"data" => Base64.urlsafe_encode64(@crypto.encrypt(JSON.generate(encrypt_data))).tr("=", "")}
|
50
50
|
req = request_class.new(path)
|
51
51
|
req.set_form_data(params)
|
52
52
|
res = @http.start { @http.request(req) }
|
File without changes
|
data/partner.yaml
CHANGED
@@ -100,16 +100,16 @@ components:
|
|
100
100
|
id:
|
101
101
|
type: string
|
102
102
|
format: uuid
|
103
|
-
|
103
|
+
title: 'ウォレットID'
|
104
104
|
name:
|
105
105
|
type: string
|
106
|
-
|
106
|
+
title: 'ウォレット名'
|
107
107
|
is_suspended:
|
108
108
|
type: boolean
|
109
|
-
|
109
|
+
title: 'ウォレットが凍結されているかどうか'
|
110
110
|
private_money:
|
111
111
|
$ref: '#/components/schemas/PrivateMoney'
|
112
|
-
|
112
|
+
title: '設定マネー情報'
|
113
113
|
AccountWithUser:
|
114
114
|
x-pokepay-schema-type: "response"
|
115
115
|
properties:
|
@@ -151,19 +151,19 @@ components:
|
|
151
151
|
id:
|
152
152
|
type: string
|
153
153
|
format: uuid
|
154
|
-
|
154
|
+
title: 'ウォレットID'
|
155
155
|
name:
|
156
156
|
type: string
|
157
|
-
|
157
|
+
title: 'ウォレット名'
|
158
158
|
is_suspended:
|
159
159
|
type: boolean
|
160
|
-
|
160
|
+
title: 'ウォレットが凍結されているかどうか'
|
161
161
|
can_transfer_topup:
|
162
162
|
type: boolean
|
163
|
-
|
163
|
+
title: 'チャージ可能かどうか'
|
164
164
|
private_money:
|
165
165
|
$ref: '#/components/schemas/PrivateMoney'
|
166
|
-
|
166
|
+
title: '設定マネー情報'
|
167
167
|
AccountBalance:
|
168
168
|
x-pokepay-schema-type: "response"
|
169
169
|
properties:
|
@@ -182,86 +182,86 @@ components:
|
|
182
182
|
id:
|
183
183
|
type: string
|
184
184
|
format: uuid
|
185
|
-
|
185
|
+
title: 支払いQRコードのID
|
186
186
|
amount:
|
187
187
|
type: number
|
188
188
|
format: decimal
|
189
189
|
nullable: true
|
190
|
-
|
190
|
+
title: 支払い額
|
191
191
|
description: 支払い額。支払い額未指定の場合は支払い時に任意金額を入力できます。
|
192
192
|
max_amount:
|
193
193
|
type: number
|
194
194
|
format: decimal
|
195
195
|
nullable: true
|
196
|
-
|
196
|
+
title: 支払い額を範囲指定した場合の上限
|
197
197
|
description: 支払い額に任意金額を入力する際の上限です。
|
198
198
|
min_amount:
|
199
199
|
type: number
|
200
200
|
format: decimal
|
201
201
|
nullable: true
|
202
|
-
|
202
|
+
title: 支払い額を範囲指定した場合の下限
|
203
203
|
description: 支払い額に任意金額を入力する際の下限です。
|
204
204
|
description:
|
205
205
|
type: string
|
206
|
-
|
206
|
+
title: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
|
207
207
|
account:
|
208
208
|
$ref: '#/components/schemas/AccountWithUser'
|
209
|
-
|
209
|
+
title: 支払いQRコード発行ウォレット
|
210
210
|
description: 支払いQRコードを発行した店舗のウォレットです。ユーザやマネーの情報を含みます。
|
211
211
|
is_disabled:
|
212
212
|
type: boolean
|
213
|
-
|
213
|
+
title: 無効化されているかどうか
|
214
214
|
token:
|
215
215
|
type: string
|
216
|
-
|
216
|
+
title: 支払いQRコードを解析したときに出てくるURL
|
217
217
|
Check:
|
218
218
|
x-pokepay-schema-type: "response"
|
219
219
|
properties:
|
220
220
|
id:
|
221
221
|
type: string
|
222
222
|
format: uuid
|
223
|
-
|
223
|
+
title: チャージQRコードのID
|
224
224
|
amount:
|
225
225
|
type: number
|
226
226
|
format: decimal
|
227
227
|
deprecated: true
|
228
|
-
|
228
|
+
title: チャージマネー額
|
229
229
|
money_amount:
|
230
230
|
type: number
|
231
231
|
format: decimal
|
232
|
-
|
232
|
+
title: チャージマネー額
|
233
233
|
point_amount:
|
234
234
|
type: number
|
235
235
|
format: decimal
|
236
|
-
|
236
|
+
title: チャージポイント額
|
237
237
|
description:
|
238
238
|
type: string
|
239
|
-
|
239
|
+
title: チャージQRコードの説明文(アプリ上で取引の説明文として表示される)
|
240
240
|
user:
|
241
241
|
$ref: '#/components/schemas/User'
|
242
|
-
|
242
|
+
title: 送金元ユーザ情報
|
243
243
|
is_onetime:
|
244
244
|
type: boolean
|
245
|
-
|
245
|
+
title: 使用回数が一回限りかどうか
|
246
246
|
is_disabled:
|
247
247
|
type: boolean
|
248
|
-
|
248
|
+
title: 無効化されているかどうか
|
249
249
|
expires_at:
|
250
250
|
type: string
|
251
251
|
format: date-time
|
252
|
-
|
252
|
+
title: チャージQRコード自体の失効日時
|
253
253
|
private_money:
|
254
254
|
$ref: '#/components/schemas/PrivateMoney'
|
255
|
-
|
255
|
+
title: 対象マネー情報
|
256
256
|
usage_limit:
|
257
257
|
type: integer
|
258
|
-
|
258
|
+
title: 一回限りでない場合の最大読み取り回数
|
259
259
|
usage_count:
|
260
260
|
type: number
|
261
|
-
|
261
|
+
title: 一回限りでない場合の現在までに読み取られた回数
|
262
262
|
token:
|
263
263
|
type: string
|
264
|
-
|
264
|
+
title: チャージQRコードを解析したときに出てくるURL
|
265
265
|
|
266
266
|
Cashtray:
|
267
267
|
x-pokepay-schema-type: "response"
|
@@ -269,32 +269,32 @@ components:
|
|
269
269
|
id:
|
270
270
|
type: string
|
271
271
|
format: uuid
|
272
|
-
|
272
|
+
title: Cashtray自体のIDです。
|
273
273
|
amount:
|
274
274
|
type: number
|
275
275
|
format: decimal
|
276
|
-
|
276
|
+
title: 取引金額
|
277
277
|
description: Cashtrayの取引金額です。正の数ならチャージ、負の数なら支払いとなります。
|
278
278
|
description:
|
279
279
|
type: string
|
280
|
-
|
280
|
+
title: Cashtrayの説明文
|
281
281
|
description: Cashtrayの説明文です。アプリ上で取引の説明文として表示されます。
|
282
282
|
account:
|
283
283
|
$ref: '#/components/schemas/AccountWithUser'
|
284
|
-
|
284
|
+
title: 発行店舗のウォレット
|
285
285
|
description: Cashtrayを発行した店舗ユーザーのウォレット情報です。ユーザやマネーの情報を含みます。
|
286
286
|
expires_at:
|
287
287
|
type: string
|
288
288
|
format: date-time
|
289
|
-
|
289
|
+
title: Cashtrayの失効日時
|
290
290
|
canceled_at:
|
291
291
|
type: string
|
292
292
|
format: date-time
|
293
293
|
nullable: true
|
294
|
-
|
294
|
+
title: Cashtrayの無効化日時。NULLの場合は無効化されていません
|
295
295
|
token:
|
296
296
|
type: string
|
297
|
-
|
297
|
+
title: CashtrayのQRコードを解析したときに出てくるURL
|
298
298
|
|
299
299
|
CashtrayWithResult:
|
300
300
|
x-pokepay-schema-type: "response"
|
@@ -302,40 +302,40 @@ components:
|
|
302
302
|
id:
|
303
303
|
type: string
|
304
304
|
format: uuid
|
305
|
-
|
305
|
+
title: CashtrayのID
|
306
306
|
description: Cashtray自体のIDです。
|
307
307
|
amount:
|
308
308
|
type: number
|
309
309
|
format: decimal
|
310
|
-
|
310
|
+
title: 取引金額
|
311
311
|
description: Cashtrayの取引金額です。正の数ならチャージ、負の数なら支払いとなります。
|
312
312
|
description:
|
313
313
|
type: string
|
314
|
-
|
314
|
+
title: Cashtrayの説明文(アプリ上で取引の説明文として表示される)
|
315
315
|
account:
|
316
316
|
$ref: '#/components/schemas/AccountWithUser'
|
317
|
-
|
317
|
+
title: 発行店舗のウォレット
|
318
318
|
description: Cashtrayを発行した店舗ユーザーのウォレット情報です。ユーザやマネーの情報を含みます。
|
319
319
|
expires_at:
|
320
320
|
type: string
|
321
321
|
format: date-time
|
322
|
-
|
322
|
+
title: Cashtrayの失効日時
|
323
323
|
canceled_at:
|
324
324
|
type: string
|
325
325
|
format: date-time
|
326
326
|
nullable: true
|
327
|
-
|
327
|
+
title: Cashtrayの無効化日時。NULLの場合は無効化されていません
|
328
328
|
token:
|
329
329
|
type: string
|
330
|
-
|
330
|
+
title: CashtrayのQRコードを解析したときに出てくるURL
|
331
331
|
attempt:
|
332
332
|
$ref: '#/components/schemas/CashtrayAttempt'
|
333
|
-
|
333
|
+
title: Cashtray読み取り結果
|
334
334
|
description: Cashtrayをエンドユーザーが読み取った結果です。Cashtrayがまだ誰にも読み取られていない場合はNULLになります。
|
335
335
|
nullable: true
|
336
336
|
transaction:
|
337
337
|
$ref: '#/components/schemas/Transaction'
|
338
|
-
|
338
|
+
title: 取引結果
|
339
339
|
description: Cashtrayをエンドユーザーが読み取った結果としてできた取引です。Cashtrayがまだ誰にも読み取られていない場合、またはエラーにより取引が完了しなかった場合はNULLになります。
|
340
340
|
nullable: true
|
341
341
|
|
@@ -344,27 +344,27 @@ components:
|
|
344
344
|
properties:
|
345
345
|
account:
|
346
346
|
$ref: '#/components/schemas/AccountWithUser'
|
347
|
-
|
347
|
+
title: エンドユーザーのウォレット
|
348
348
|
description: |-
|
349
349
|
Cashtrayを読み取ったエンドユーザーのウォレット情報です。ユーザやマネーの情報を含みます。
|
350
350
|
この際、エンドユーザーがCashtrayを発行した店舗ウォレットのマネーを持っていない場合、この値はNULLになります。
|
351
351
|
nullable: true
|
352
352
|
status_code:
|
353
353
|
type: number
|
354
|
-
|
354
|
+
title: ステータスコード
|
355
355
|
description: エンドユーザーによるCashtrayの読み取りリクエストに対するレスポンスのHTTPステータスコードです。
|
356
356
|
error_type:
|
357
357
|
type: string
|
358
|
-
|
358
|
+
title: エラー型
|
359
359
|
description: 取引中に発生したエラーの型名です。エラーが発生しなかった場合は空文字となります。
|
360
360
|
error_message:
|
361
361
|
type: string
|
362
|
-
|
362
|
+
title: エラーメッセージ
|
363
363
|
description: 取引中に発生したエラーの説明文です。エラーが発生しなかった場合は空文字となります。
|
364
364
|
created_at:
|
365
365
|
type: string
|
366
366
|
format: date-time
|
367
|
-
|
367
|
+
title: Cashtray読み取り記録の作成日時
|
368
368
|
description: エンドユーザーによるCashtrayの読み取りリクエストに対する記録(CashtrayAttempt)の作成日時です。これによりエンドユーザーがCashtrayをいつ読み取ったかが分かります。
|
369
369
|
|
370
370
|
User:
|
@@ -373,185 +373,185 @@ components:
|
|
373
373
|
id:
|
374
374
|
type: string
|
375
375
|
format: uuid
|
376
|
-
|
376
|
+
title: 'ユーザー (または店舗) ID'
|
377
377
|
name:
|
378
378
|
type: string
|
379
|
-
|
379
|
+
title: 'ユーザー (または店舗) 名'
|
380
380
|
is_merchant:
|
381
381
|
type: boolean
|
382
|
-
|
382
|
+
title: '店舗ユーザーかどうか'
|
383
383
|
PrivateMoney:
|
384
384
|
x-pokepay-schema-type: "response"
|
385
385
|
properties:
|
386
386
|
id:
|
387
387
|
type: string
|
388
388
|
format: uuid
|
389
|
-
|
389
|
+
title: 'マネーID'
|
390
390
|
name:
|
391
391
|
type: string
|
392
392
|
maxLength: 256
|
393
|
-
|
393
|
+
title: 'マネー名'
|
394
394
|
unit:
|
395
395
|
type: string
|
396
|
-
|
396
|
+
title: 'マネー単位 (例: 円)'
|
397
397
|
is_exclusive:
|
398
398
|
type: boolean
|
399
|
-
|
399
|
+
title: '会員制のマネーかどうか'
|
400
400
|
description:
|
401
401
|
type: string
|
402
|
-
|
402
|
+
title: 'マネー説明文'
|
403
403
|
oneline_message:
|
404
404
|
type: string
|
405
|
-
|
405
|
+
title: 'マネーの要約'
|
406
406
|
organization:
|
407
|
-
|
407
|
+
title: 'マネーを発行した組織'
|
408
408
|
$ref: '#/components/schemas/Organization'
|
409
409
|
max_balance:
|
410
410
|
type: number
|
411
411
|
format: decimal
|
412
|
-
|
412
|
+
title: 'ウォレットの上限金額'
|
413
413
|
transfer_limit:
|
414
414
|
type: number
|
415
415
|
format: decimal
|
416
|
-
|
416
|
+
title: 'マネーの取引上限額'
|
417
417
|
type:
|
418
418
|
type: string
|
419
419
|
enum: [own, third-party]
|
420
|
-
|
420
|
+
title: 'マネー種別 (自家型=own, 第三者型=third-party)'
|
421
421
|
expiration_type:
|
422
422
|
type: string
|
423
423
|
enum: [static, last-update, last-topup-update]
|
424
|
-
|
424
|
+
title: '有効期限種別 (チャージ日起算=static, 最終利用日起算=last-update, 最終チャージ日起算=last-topup-update)'
|
425
425
|
enable_topup_by_member:
|
426
426
|
type: boolean
|
427
427
|
nullable: true
|
428
|
-
|
428
|
+
title: '加盟店によるチャージが有効かどうか'
|
429
429
|
Organization:
|
430
430
|
x-pokepay-schema-type: "response"
|
431
431
|
properties:
|
432
432
|
code:
|
433
433
|
type: string
|
434
434
|
maxLength: 32
|
435
|
-
|
435
|
+
title: '組織コード'
|
436
436
|
name:
|
437
437
|
type: string
|
438
438
|
maxLength: 256
|
439
|
-
|
439
|
+
title: '組織名'
|
440
440
|
Transaction:
|
441
441
|
x-pokepay-schema-type: "response"
|
442
442
|
properties:
|
443
443
|
id:
|
444
444
|
type: string
|
445
445
|
format: uuid
|
446
|
-
|
446
|
+
title: '取引ID'
|
447
447
|
type:
|
448
448
|
type: string
|
449
|
-
|
449
|
+
title: '取引種別 (チャージ=topup, 支払い=payment)'
|
450
450
|
is_modified:
|
451
451
|
type: boolean
|
452
|
-
|
452
|
+
title: '返金された取引かどうか'
|
453
453
|
sender:
|
454
454
|
$ref: '#/components/schemas/User'
|
455
|
-
|
455
|
+
title: '送金者情報'
|
456
456
|
sender_account:
|
457
457
|
$ref: '#/components/schemas/Account'
|
458
|
-
|
458
|
+
title: '送金ウォレット情報'
|
459
459
|
receiver:
|
460
460
|
$ref: '#/components/schemas/User'
|
461
|
-
|
461
|
+
title: '受取者情報'
|
462
462
|
receiver_account:
|
463
463
|
$ref: '#/components/schemas/Account'
|
464
|
-
|
464
|
+
title: '受取ウォレット情報'
|
465
465
|
amount:
|
466
466
|
type: number
|
467
|
-
|
467
|
+
title: '決済総額 (マネー額 + ポイント額)'
|
468
468
|
money_amount:
|
469
469
|
type: number
|
470
|
-
|
470
|
+
title: '決済マネー額'
|
471
471
|
point_amount:
|
472
472
|
type: number
|
473
|
-
|
473
|
+
title: '決済ポイント額'
|
474
474
|
done_at:
|
475
475
|
type: string
|
476
476
|
format: date-time
|
477
|
-
|
477
|
+
title: '取引日時'
|
478
478
|
description:
|
479
479
|
type: string
|
480
|
-
|
480
|
+
title: '取引説明文'
|
481
481
|
ShopWithMetadata:
|
482
482
|
x-pokepay-schema-type: "response"
|
483
483
|
properties:
|
484
484
|
id:
|
485
485
|
type: string
|
486
486
|
format: uuid
|
487
|
-
|
487
|
+
title: 店舗ID
|
488
488
|
name:
|
489
489
|
type: string
|
490
|
-
|
490
|
+
title: 店舗名
|
491
491
|
organization_code:
|
492
492
|
type: string
|
493
493
|
maxLength: 256
|
494
|
-
|
494
|
+
title: 組織コード
|
495
495
|
postal_code:
|
496
496
|
type: string
|
497
497
|
nullable: true
|
498
|
-
|
498
|
+
title: '店舗の郵便番号'
|
499
499
|
address:
|
500
500
|
type: string
|
501
501
|
nullable: true
|
502
|
-
|
502
|
+
title: '店舗の住所'
|
503
503
|
tel:
|
504
504
|
type: string
|
505
505
|
nullable: true
|
506
|
-
|
506
|
+
title: '店舗の電話番号'
|
507
507
|
email:
|
508
508
|
type: string
|
509
509
|
nullable: true
|
510
510
|
format: email
|
511
511
|
maxLength: 256
|
512
|
-
|
512
|
+
title: '店舗のメールアドレス'
|
513
513
|
external_id:
|
514
514
|
type: string
|
515
515
|
nullable: true
|
516
516
|
maxLength: 36
|
517
|
-
|
517
|
+
title: '店舗の外部ID'
|
518
518
|
ShopWithAccounts:
|
519
519
|
x-pokepay-schema-type: "response"
|
520
520
|
properties:
|
521
521
|
id:
|
522
522
|
type: string
|
523
523
|
format: uuid
|
524
|
-
|
524
|
+
title: 店舗ID
|
525
525
|
name:
|
526
526
|
type: string
|
527
|
-
|
527
|
+
title: 店舗名
|
528
528
|
organization_code:
|
529
529
|
type: string
|
530
530
|
maxLength: 256
|
531
|
-
|
531
|
+
title: 組織コード
|
532
532
|
postal_code:
|
533
533
|
type: string
|
534
534
|
nullable: true
|
535
|
-
|
535
|
+
title: '店舗の郵便番号'
|
536
536
|
address:
|
537
537
|
type: string
|
538
538
|
nullable: true
|
539
|
-
|
539
|
+
title: '店舗の住所'
|
540
540
|
tel:
|
541
541
|
type: string
|
542
542
|
nullable: true
|
543
|
-
|
543
|
+
title: '店舗の電話番号'
|
544
544
|
email:
|
545
545
|
type: string
|
546
546
|
nullable: true
|
547
547
|
format: email
|
548
548
|
maxLength: 256
|
549
|
-
|
549
|
+
title: '店舗のメールアドレス'
|
550
550
|
external_id:
|
551
551
|
type: string
|
552
552
|
nullable: true
|
553
553
|
maxLength: 36
|
554
|
-
|
554
|
+
title: '店舗の外部ID'
|
555
555
|
accounts:
|
556
556
|
type: array
|
557
557
|
items:
|
@@ -599,13 +599,13 @@ components:
|
|
599
599
|
format: uuid
|
600
600
|
request_id:
|
601
601
|
type: string
|
602
|
-
|
602
|
+
title: リクエストID
|
603
603
|
name:
|
604
604
|
type: string
|
605
|
-
|
605
|
+
title: バルク取引管理用の名前
|
606
606
|
description:
|
607
607
|
type: string
|
608
|
-
|
608
|
+
title: バルク取引管理用の説明文
|
609
609
|
status:
|
610
610
|
type: string
|
611
611
|
enum:
|
@@ -615,23 +615,23 @@ components:
|
|
615
615
|
- processing
|
616
616
|
- error
|
617
617
|
- done
|
618
|
-
|
618
|
+
title: バルク取引の状態
|
619
619
|
error:
|
620
620
|
type: string
|
621
621
|
nullable: true
|
622
|
-
|
622
|
+
title: バルク取引のエラー種別
|
623
623
|
error_lineno:
|
624
624
|
type: integer
|
625
625
|
nullable: true
|
626
|
-
|
626
|
+
title: バルク取引のエラーが発生した行番号
|
627
627
|
submitted_at:
|
628
628
|
type: string
|
629
629
|
format: date-time
|
630
|
-
|
630
|
+
title: バルク取引が登録された日時
|
631
631
|
updated_at:
|
632
632
|
type: string
|
633
633
|
format: date-time
|
634
|
-
|
634
|
+
title: バルク取引が更新された日時
|
635
635
|
AccountWithoutPrivateMoneyDetail:
|
636
636
|
x-pokepay-schema-type: "response"
|
637
637
|
properties:
|
@@ -997,7 +997,7 @@ paths:
|
|
997
997
|
schema:
|
998
998
|
type: string
|
999
999
|
format: uuid
|
1000
|
-
|
1000
|
+
title: 'ユーザーID'
|
1001
1001
|
description: |-
|
1002
1002
|
ユーザーIDです。
|
1003
1003
|
|
@@ -1030,7 +1030,7 @@ paths:
|
|
1030
1030
|
schema:
|
1031
1031
|
type: string
|
1032
1032
|
format: uuid
|
1033
|
-
|
1033
|
+
title: 'ウォレットID'
|
1034
1034
|
description: |-
|
1035
1035
|
ウォレットIDです。
|
1036
1036
|
|
@@ -1062,7 +1062,7 @@ paths:
|
|
1062
1062
|
schema:
|
1063
1063
|
type: string
|
1064
1064
|
format: uuid
|
1065
|
-
|
1065
|
+
title: 'ウォレットID'
|
1066
1066
|
description: |-
|
1067
1067
|
ウォレットIDです。
|
1068
1068
|
|
@@ -1075,7 +1075,7 @@ paths:
|
|
1075
1075
|
properties:
|
1076
1076
|
is_suspended:
|
1077
1077
|
type: boolean
|
1078
|
-
|
1078
|
+
title: 'ウォレットが凍結されているかどうか'
|
1079
1079
|
description: ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
|
1080
1080
|
responses:
|
1081
1081
|
'200':
|
@@ -1105,7 +1105,7 @@ paths:
|
|
1105
1105
|
schema:
|
1106
1106
|
type: string
|
1107
1107
|
format: uuid
|
1108
|
-
|
1108
|
+
title: 'ウォレットID'
|
1109
1109
|
description: |-
|
1110
1110
|
ウォレットIDです。
|
1111
1111
|
|
@@ -1119,27 +1119,27 @@ paths:
|
|
1119
1119
|
page:
|
1120
1120
|
type: integer
|
1121
1121
|
minimum: 1
|
1122
|
-
|
1122
|
+
title: 'ページ番号'
|
1123
1123
|
description: 取得したいページ番号です。デフォルト値は1です。
|
1124
1124
|
per_page:
|
1125
1125
|
type: integer
|
1126
1126
|
minimum: 1
|
1127
|
-
|
1127
|
+
title: '1ページ分の取引数'
|
1128
1128
|
description: 1ページ分のウォレット残高数です。デフォルト値は30です。
|
1129
1129
|
expires_at_from:
|
1130
1130
|
type: string
|
1131
1131
|
format: date-time
|
1132
|
-
|
1132
|
+
title: '有効期限の期間によるフィルター(開始時点)'
|
1133
1133
|
description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
1134
1134
|
expires_at_to:
|
1135
1135
|
type: string
|
1136
1136
|
format: date-time
|
1137
|
-
|
1137
|
+
title: '有効期限の期間によるフィルター(終了時点)'
|
1138
1138
|
description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
1139
1139
|
direction:
|
1140
1140
|
type: string
|
1141
1141
|
enum: [asc, desc]
|
1142
|
-
|
1142
|
+
title: '有効期限によるソート順序'
|
1143
1143
|
description: 有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
|
1144
1144
|
responses:
|
1145
1145
|
'200':
|
@@ -1169,7 +1169,7 @@ paths:
|
|
1169
1169
|
schema:
|
1170
1170
|
type: string
|
1171
1171
|
format: uuid
|
1172
|
-
|
1172
|
+
title: 'ウォレットID'
|
1173
1173
|
description: |-
|
1174
1174
|
ウォレットIDです。
|
1175
1175
|
|
@@ -1183,27 +1183,27 @@ paths:
|
|
1183
1183
|
page:
|
1184
1184
|
type: integer
|
1185
1185
|
minimum: 1
|
1186
|
-
|
1186
|
+
title: 'ページ番号'
|
1187
1187
|
description: 取得したいページ番号です。デフォルト値は1です。
|
1188
1188
|
per_page:
|
1189
1189
|
type: integer
|
1190
1190
|
minimum: 1
|
1191
|
-
|
1191
|
+
title: '1ページ分の取引数'
|
1192
1192
|
description: 1ページ分のウォレット残高数です。デフォルト値は30です。
|
1193
1193
|
expires_at_from:
|
1194
1194
|
type: string
|
1195
1195
|
format: date-time
|
1196
|
-
|
1196
|
+
title: '有効期限の期間によるフィルター(開始時点)'
|
1197
1197
|
description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
|
1198
1198
|
expires_at_to:
|
1199
1199
|
type: string
|
1200
1200
|
format: date-time
|
1201
|
-
|
1201
|
+
title: '有効期限の期間によるフィルター(終了時点)'
|
1202
1202
|
description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
|
1203
1203
|
direction:
|
1204
1204
|
type: string
|
1205
1205
|
enum: [asc, desc]
|
1206
|
-
|
1206
|
+
title: '有効期限によるソート順序'
|
1207
1207
|
description: 有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
|
1208
1208
|
responses:
|
1209
1209
|
'200':
|
@@ -1235,7 +1235,7 @@ paths:
|
|
1235
1235
|
required: ["private_money_id"]
|
1236
1236
|
properties:
|
1237
1237
|
private_money_id:
|
1238
|
-
|
1238
|
+
title: 'マネーID'
|
1239
1239
|
description: |-
|
1240
1240
|
マネーIDです。
|
1241
1241
|
|
@@ -1243,14 +1243,14 @@ paths:
|
|
1243
1243
|
type: string
|
1244
1244
|
format: uuid
|
1245
1245
|
user_name:
|
1246
|
-
|
1246
|
+
title: 'ユーザー名'
|
1247
1247
|
description: |-
|
1248
1248
|
ウォレットと共に作成するユーザ名です。省略した場合は空文字となります。
|
1249
1249
|
type: string
|
1250
1250
|
maxLength: 256
|
1251
1251
|
example: ポケペイ太郎
|
1252
1252
|
account_name:
|
1253
|
-
|
1253
|
+
title: 'アカウント名'
|
1254
1254
|
description: |-
|
1255
1255
|
作成するウォレット名です。省略した場合は空文字となります。
|
1256
1256
|
type: string
|
@@ -1286,38 +1286,38 @@ paths:
|
|
1286
1286
|
page:
|
1287
1287
|
type: integer
|
1288
1288
|
minimum: 1
|
1289
|
-
|
1289
|
+
title: 'ページ番号'
|
1290
1290
|
description: 取得したいページ番号です。
|
1291
1291
|
per_page:
|
1292
1292
|
type: integer
|
1293
1293
|
minimum: 1
|
1294
|
-
|
1294
|
+
title: '1ページの表示数'
|
1295
1295
|
description: 1ページに表示する支払いQRコードの数です。
|
1296
1296
|
bill_id:
|
1297
1297
|
type: string
|
1298
|
-
|
1298
|
+
title: '支払いQRコードのID'
|
1299
1299
|
description: 支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
|
1300
1300
|
private_money_id:
|
1301
1301
|
type: string
|
1302
1302
|
format: uuid
|
1303
|
-
|
1303
|
+
title: 'マネーID'
|
1304
1304
|
description: 支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
|
1305
1305
|
organization_code:
|
1306
1306
|
type: string
|
1307
1307
|
pattern: '^[a-zA-Z0-9-]*$'
|
1308
1308
|
maxLength: 32
|
1309
|
-
|
1309
|
+
title: '組織コード'
|
1310
1310
|
description: 支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
|
1311
1311
|
description:
|
1312
1312
|
type: string
|
1313
1313
|
maxLength: 200
|
1314
|
-
|
1314
|
+
title: '取引説明文'
|
1315
1315
|
description: 支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
|
1316
1316
|
example: 'test bill'
|
1317
1317
|
created_from:
|
1318
1318
|
type: string
|
1319
1319
|
format: date-time
|
1320
|
-
|
1320
|
+
title: '作成日時(起点)'
|
1321
1321
|
description: |-
|
1322
1322
|
支払いQRコードの作成日時でフィルターします。
|
1323
1323
|
|
@@ -1325,7 +1325,7 @@ paths:
|
|
1325
1325
|
created_to:
|
1326
1326
|
type: string
|
1327
1327
|
format: date-time
|
1328
|
-
|
1328
|
+
title: '作成日時(終点)'
|
1329
1329
|
description: |-
|
1330
1330
|
支払いQRコードの作成日時でフィルターします。
|
1331
1331
|
|
@@ -1333,29 +1333,29 @@ paths:
|
|
1333
1333
|
shop_name:
|
1334
1334
|
type: string
|
1335
1335
|
maxLength: 256
|
1336
|
-
|
1336
|
+
title: '店舗名'
|
1337
1337
|
description: 支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
|
1338
1338
|
example: 'bill test shop1'
|
1339
1339
|
shop_id:
|
1340
1340
|
type: string
|
1341
1341
|
format: uuid
|
1342
|
-
|
1342
|
+
title: '店舗ID'
|
1343
1343
|
description: 支払いQRコードを作成した店舗IDでフィルターします。
|
1344
1344
|
lower_limit_amount:
|
1345
1345
|
type: integer
|
1346
1346
|
minimum: 0
|
1347
1347
|
format: decimal
|
1348
|
-
|
1348
|
+
title: '金額の範囲によるフィルタ(下限)'
|
1349
1349
|
description: 支払いQRコードの金額の下限を指定してフィルターします。
|
1350
1350
|
upper_limit_amount:
|
1351
1351
|
type: integer
|
1352
1352
|
minimum: 0
|
1353
1353
|
format: decimal
|
1354
|
-
|
1354
|
+
title: '金額の範囲によるフィルタ(上限)'
|
1355
1355
|
description: 支払いQRコードの金額の上限を指定してフィルターします。
|
1356
1356
|
is_disabled:
|
1357
1357
|
type: boolean
|
1358
|
-
|
1358
|
+
title: '支払いQRコードが無効化されているかどうか'
|
1359
1359
|
description: 支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
|
1360
1360
|
responses:
|
1361
1361
|
'200':
|
@@ -1387,20 +1387,20 @@ paths:
|
|
1387
1387
|
minimum: 0
|
1388
1388
|
nullable: true
|
1389
1389
|
format: decimal
|
1390
|
-
|
1390
|
+
title: '支払い額'
|
1391
1391
|
description: 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
|
1392
1392
|
private_money_id:
|
1393
1393
|
type: string
|
1394
1394
|
format: uuid
|
1395
|
-
|
1395
|
+
title: '支払いマネーのマネーID'
|
1396
1396
|
shop_id:
|
1397
1397
|
type: string
|
1398
1398
|
format: uuid
|
1399
|
-
|
1399
|
+
title: '支払い先(受け取り人)の店舗ID'
|
1400
1400
|
description:
|
1401
1401
|
type: string
|
1402
1402
|
maxLength: 200
|
1403
|
-
|
1403
|
+
title: '説明文(アプリ上で取引の説明文として表示される)'
|
1404
1404
|
example: 'test bill'
|
1405
1405
|
responses:
|
1406
1406
|
'200':
|
@@ -1431,7 +1431,7 @@ paths:
|
|
1431
1431
|
schema:
|
1432
1432
|
type: string
|
1433
1433
|
format: uuid
|
1434
|
-
|
1434
|
+
title: '支払いQRコードのID'
|
1435
1435
|
description: |-
|
1436
1436
|
更新対象の支払いQRコードのIDです。
|
1437
1437
|
requestBody:
|
@@ -1445,17 +1445,17 @@ paths:
|
|
1445
1445
|
minimum: 0
|
1446
1446
|
nullable: true
|
1447
1447
|
format: decimal
|
1448
|
-
|
1448
|
+
title: '支払い額'
|
1449
1449
|
description: 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
|
1450
1450
|
description:
|
1451
1451
|
type: string
|
1452
1452
|
maxLength: 200
|
1453
|
-
|
1453
|
+
title: '説明文'
|
1454
1454
|
description: 支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
|
1455
1455
|
example: 'test bill'
|
1456
1456
|
is_disabled:
|
1457
1457
|
type: boolean
|
1458
|
-
|
1458
|
+
title: '無効化されているかどうか'
|
1459
1459
|
description: 支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
|
1460
1460
|
responses:
|
1461
1461
|
'200':
|
@@ -1488,31 +1488,31 @@ paths:
|
|
1488
1488
|
type: number
|
1489
1489
|
minimum: 0
|
1490
1490
|
format: decimal
|
1491
|
-
|
1491
|
+
title: '付与マネー額'
|
1492
1492
|
point_amount:
|
1493
1493
|
type: number
|
1494
1494
|
minimum: 0
|
1495
1495
|
format: decimal
|
1496
|
-
|
1496
|
+
title: '付与ポイント額'
|
1497
1497
|
account_id:
|
1498
1498
|
type: string
|
1499
1499
|
format: uuid
|
1500
|
-
|
1500
|
+
title: '送金元の店舗アカウントID'
|
1501
1501
|
description:
|
1502
1502
|
type: string
|
1503
1503
|
maxLength: 200
|
1504
|
-
|
1504
|
+
title: '説明文(アプリ上で取引の説明文として表示される)'
|
1505
1505
|
example: 'test check'
|
1506
1506
|
is_onetime:
|
1507
1507
|
type: boolean
|
1508
|
-
|
1508
|
+
title: 'ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)'
|
1509
1509
|
description: |
|
1510
1510
|
チャージQRコードが一度の読み取りで失効するときに`true`にします。デフォルト値は`true`です。
|
1511
1511
|
`false`の場合、そのチャージQRコードは1ユーザについては1回きりですが、複数ユーザによって読み取り可能なQRコードになります。
|
1512
1512
|
usage_limit:
|
1513
1513
|
type: integer
|
1514
1514
|
nullable: true
|
1515
|
-
|
1515
|
+
title: 'ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数'
|
1516
1516
|
description: |
|
1517
1517
|
複数ユーザによって読み取り可能なチャージQRコードの読み取り回数に制限をつけるために指定します。
|
1518
1518
|
省略すると無制限に読み取り可能なチャージQRコードになります。
|
@@ -1520,20 +1520,20 @@ paths:
|
|
1520
1520
|
expires_at:
|
1521
1521
|
type: string
|
1522
1522
|
format: date-time
|
1523
|
-
|
1523
|
+
title: 'チャージQR自体の失効日時'
|
1524
1524
|
point_expires_at:
|
1525
1525
|
type: string
|
1526
1526
|
format: date-time
|
1527
|
-
|
1527
|
+
title: 'チャージQRによって付与されるポイントの失効日時'
|
1528
1528
|
point_expires_in_days:
|
1529
1529
|
type: integer
|
1530
1530
|
minimum: 1
|
1531
|
-
|
1531
|
+
title: 'チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)'
|
1532
1532
|
example: 60
|
1533
1533
|
bear_point_account:
|
1534
1534
|
type: string
|
1535
1535
|
format: uuid
|
1536
|
-
|
1536
|
+
title: 'ポイント額を負担する店舗アカウントのID'
|
1537
1537
|
responses:
|
1538
1538
|
'200':
|
1539
1539
|
description: OK
|
@@ -1560,7 +1560,7 @@ paths:
|
|
1560
1560
|
from:
|
1561
1561
|
type: string
|
1562
1562
|
format: date-time
|
1563
|
-
|
1563
|
+
title: '開始日時'
|
1564
1564
|
description: |-
|
1565
1565
|
抽出期間の開始日時です。
|
1566
1566
|
|
@@ -1568,7 +1568,7 @@ paths:
|
|
1568
1568
|
to:
|
1569
1569
|
type: string
|
1570
1570
|
format: date-time
|
1571
|
-
|
1571
|
+
title: '終了日時'
|
1572
1572
|
description: |-
|
1573
1573
|
抽出期間の終了日時です。
|
1574
1574
|
|
@@ -1576,19 +1576,19 @@ paths:
|
|
1576
1576
|
page:
|
1577
1577
|
type: integer
|
1578
1578
|
minimum: 1
|
1579
|
-
|
1579
|
+
title: 'ページ番号'
|
1580
1580
|
description: 取得したいページ番号です。
|
1581
1581
|
example: 1
|
1582
1582
|
per_page:
|
1583
1583
|
type: integer
|
1584
1584
|
minimum: 1
|
1585
|
-
|
1585
|
+
title: '1ページ分の取引数'
|
1586
1586
|
description: 1ページ分の取引数です。
|
1587
1587
|
example: 50
|
1588
1588
|
shop_id:
|
1589
1589
|
type: string
|
1590
1590
|
format: uuid
|
1591
|
-
|
1591
|
+
title: '店舗ID'
|
1592
1592
|
description: |-
|
1593
1593
|
店舗IDです。
|
1594
1594
|
|
@@ -1596,7 +1596,7 @@ paths:
|
|
1596
1596
|
customer_id:
|
1597
1597
|
type: string
|
1598
1598
|
format: uuid
|
1599
|
-
|
1599
|
+
title: 'エンドユーザーID'
|
1600
1600
|
description: |-
|
1601
1601
|
エンドユーザーIDです。
|
1602
1602
|
|
@@ -1604,7 +1604,7 @@ paths:
|
|
1604
1604
|
customer_name:
|
1605
1605
|
type: string
|
1606
1606
|
maxLength: 256
|
1607
|
-
|
1607
|
+
title: 'エンドユーザー名'
|
1608
1608
|
description: |-
|
1609
1609
|
エンドユーザー名です。
|
1610
1610
|
|
@@ -1613,7 +1613,7 @@ paths:
|
|
1613
1613
|
terminal_id:
|
1614
1614
|
type: string
|
1615
1615
|
format: uuid
|
1616
|
-
|
1616
|
+
title: '端末ID'
|
1617
1617
|
description: |-
|
1618
1618
|
端末IDです。
|
1619
1619
|
|
@@ -1621,7 +1621,7 @@ paths:
|
|
1621
1621
|
transaction_id:
|
1622
1622
|
type: string
|
1623
1623
|
format: uuid
|
1624
|
-
|
1624
|
+
title: '取引ID'
|
1625
1625
|
description: |-
|
1626
1626
|
取引IDです。
|
1627
1627
|
|
@@ -1630,7 +1630,7 @@ paths:
|
|
1630
1630
|
type: string
|
1631
1631
|
pattern: '^[a-zA-Z0-9-]*$'
|
1632
1632
|
maxLength: 32
|
1633
|
-
|
1633
|
+
title: '組織コード'
|
1634
1634
|
description: |-
|
1635
1635
|
組織コードです。
|
1636
1636
|
|
@@ -1639,14 +1639,14 @@ paths:
|
|
1639
1639
|
private_money_id:
|
1640
1640
|
type: string
|
1641
1641
|
format: uuid
|
1642
|
-
|
1642
|
+
title: 'マネーID'
|
1643
1643
|
description: |-
|
1644
1644
|
マネーIDです。
|
1645
1645
|
|
1646
1646
|
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
1647
1647
|
is_modified:
|
1648
1648
|
type: boolean
|
1649
|
-
|
1649
|
+
title: 'キャンセルフラグ'
|
1650
1650
|
description: |-
|
1651
1651
|
キャンセルフラグです。
|
1652
1652
|
|
@@ -1654,7 +1654,7 @@ paths:
|
|
1654
1654
|
デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
|
1655
1655
|
types:
|
1656
1656
|
type: array
|
1657
|
-
|
1657
|
+
title: '取引種別 (複数指定可)、チャージ=topup、支払い=payment'
|
1658
1658
|
example: '["topup", "payment"]'
|
1659
1659
|
description: |-
|
1660
1660
|
取引の種類でフィルターします。
|
@@ -1720,7 +1720,7 @@ paths:
|
|
1720
1720
|
point_expires_at:
|
1721
1721
|
type: string
|
1722
1722
|
format: date-time
|
1723
|
-
|
1723
|
+
title: 'ポイント有効期限'
|
1724
1724
|
description: |-
|
1725
1725
|
ポイントをチャージした場合の、付与されるポイントの有効期限です。
|
1726
1726
|
省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
|
@@ -1758,7 +1758,7 @@ paths:
|
|
1758
1758
|
shop_id:
|
1759
1759
|
type: string
|
1760
1760
|
format: uuid
|
1761
|
-
|
1761
|
+
title: '店舗ID'
|
1762
1762
|
description: |-
|
1763
1763
|
店舗IDです。
|
1764
1764
|
|
@@ -1766,7 +1766,7 @@ paths:
|
|
1766
1766
|
customer_id:
|
1767
1767
|
type: string
|
1768
1768
|
format: uuid
|
1769
|
-
|
1769
|
+
title: 'エンドユーザーのID'
|
1770
1770
|
description: |-
|
1771
1771
|
エンドユーザーIDです。
|
1772
1772
|
|
@@ -1774,7 +1774,7 @@ paths:
|
|
1774
1774
|
private_money_id:
|
1775
1775
|
type: string
|
1776
1776
|
format: uuid
|
1777
|
-
|
1777
|
+
title: 'マネーID'
|
1778
1778
|
description: |-
|
1779
1779
|
マネーIDです。
|
1780
1780
|
|
@@ -1782,7 +1782,7 @@ paths:
|
|
1782
1782
|
bear_point_shop_id:
|
1783
1783
|
type: string
|
1784
1784
|
format: uuid
|
1785
|
-
|
1785
|
+
title: 'ポイント支払時の負担店舗ID'
|
1786
1786
|
description: |-
|
1787
1787
|
ポイント支払時の負担店舗IDです。
|
1788
1788
|
|
@@ -1790,7 +1790,7 @@ paths:
|
|
1790
1790
|
money_amount:
|
1791
1791
|
type: number
|
1792
1792
|
minimum: 0
|
1793
|
-
|
1793
|
+
title: 'マネー額'
|
1794
1794
|
description: |-
|
1795
1795
|
マネー額です。
|
1796
1796
|
|
@@ -1798,7 +1798,7 @@ paths:
|
|
1798
1798
|
point_amount:
|
1799
1799
|
type: number
|
1800
1800
|
minimum: 0
|
1801
|
-
|
1801
|
+
title: 'ポイント額'
|
1802
1802
|
description: |-
|
1803
1803
|
ポイント額です。
|
1804
1804
|
|
@@ -1806,14 +1806,14 @@ paths:
|
|
1806
1806
|
point_expires_at:
|
1807
1807
|
type: string
|
1808
1808
|
format: date-time
|
1809
|
-
|
1809
|
+
title: 'ポイント有効期限'
|
1810
1810
|
description: |-
|
1811
1811
|
ポイントをチャージした場合の、付与されるポイントの有効期限です。
|
1812
1812
|
省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
|
1813
1813
|
description:
|
1814
1814
|
type: string
|
1815
1815
|
maxLength: 200
|
1816
|
-
|
1816
|
+
title: '取引履歴に表示する説明文'
|
1817
1817
|
description: |-
|
1818
1818
|
取引説明文です。
|
1819
1819
|
|
@@ -1853,7 +1853,7 @@ paths:
|
|
1853
1853
|
check_id:
|
1854
1854
|
type: string
|
1855
1855
|
format: uuid
|
1856
|
-
|
1856
|
+
title: 'チャージ用QRコードのID'
|
1857
1857
|
description: |-
|
1858
1858
|
チャージ用QRコードのIDです。
|
1859
1859
|
|
@@ -1861,7 +1861,7 @@ paths:
|
|
1861
1861
|
customer_id:
|
1862
1862
|
type: string
|
1863
1863
|
format: uuid
|
1864
|
-
|
1864
|
+
title: 'エンドユーザーのID'
|
1865
1865
|
description: |-
|
1866
1866
|
エンドユーザーIDです。
|
1867
1867
|
|
@@ -1901,7 +1901,7 @@ paths:
|
|
1901
1901
|
shop_id:
|
1902
1902
|
type: string
|
1903
1903
|
format: uuid
|
1904
|
-
|
1904
|
+
title: '店舗ID'
|
1905
1905
|
description: |-
|
1906
1906
|
店舗IDです。
|
1907
1907
|
|
@@ -1909,7 +1909,7 @@ paths:
|
|
1909
1909
|
customer_id:
|
1910
1910
|
type: string
|
1911
1911
|
format: uuid
|
1912
|
-
|
1912
|
+
title: 'エンドユーザーID'
|
1913
1913
|
description: |-
|
1914
1914
|
エンドユーザーIDです。
|
1915
1915
|
|
@@ -1917,7 +1917,7 @@ paths:
|
|
1917
1917
|
private_money_id:
|
1918
1918
|
type: string
|
1919
1919
|
format: uuid
|
1920
|
-
|
1920
|
+
title: 'マネーID'
|
1921
1921
|
description: |-
|
1922
1922
|
マネーIDです。
|
1923
1923
|
|
@@ -1925,7 +1925,7 @@ paths:
|
|
1925
1925
|
amount:
|
1926
1926
|
type: number
|
1927
1927
|
minimum: 0
|
1928
|
-
|
1928
|
+
title: '支払い額'
|
1929
1929
|
description: |-
|
1930
1930
|
マネー額です。
|
1931
1931
|
|
@@ -1933,7 +1933,7 @@ paths:
|
|
1933
1933
|
description:
|
1934
1934
|
type: string
|
1935
1935
|
maxLength: 200
|
1936
|
-
|
1936
|
+
title: '取引履歴に表示する説明文'
|
1937
1937
|
description: |-
|
1938
1938
|
取引説明文です。
|
1939
1939
|
|
@@ -1972,7 +1972,7 @@ paths:
|
|
1972
1972
|
sender_id:
|
1973
1973
|
type: string
|
1974
1974
|
format: uuid
|
1975
|
-
|
1975
|
+
title: '送金元ユーザーID'
|
1976
1976
|
description: |-
|
1977
1977
|
エンドユーザーIDです。
|
1978
1978
|
|
@@ -1980,7 +1980,7 @@ paths:
|
|
1980
1980
|
receiver_id:
|
1981
1981
|
type: string
|
1982
1982
|
format: uuid
|
1983
|
-
|
1983
|
+
title: '受取ユーザーID'
|
1984
1984
|
description: |-
|
1985
1985
|
エンドユーザーIDです。
|
1986
1986
|
|
@@ -1988,7 +1988,7 @@ paths:
|
|
1988
1988
|
private_money_id:
|
1989
1989
|
type: string
|
1990
1990
|
format: uuid
|
1991
|
-
|
1991
|
+
title: 'マネーID'
|
1992
1992
|
description: |-
|
1993
1993
|
マネーIDです。
|
1994
1994
|
|
@@ -1996,7 +1996,7 @@ paths:
|
|
1996
1996
|
amount:
|
1997
1997
|
type: number
|
1998
1998
|
minimum: 0
|
1999
|
-
|
1999
|
+
title: '送金額'
|
2000
2000
|
description: |-
|
2001
2001
|
マネー額です。
|
2002
2002
|
|
@@ -2004,7 +2004,7 @@ paths:
|
|
2004
2004
|
description:
|
2005
2005
|
type: string
|
2006
2006
|
maxLength: 200
|
2007
|
-
|
2007
|
+
title: '取引履歴に表示する説明文'
|
2008
2008
|
description: |-
|
2009
2009
|
取引説明文です。
|
2010
2010
|
|
@@ -2079,18 +2079,18 @@ paths:
|
|
2079
2079
|
name:
|
2080
2080
|
type: string
|
2081
2081
|
maxLength: 32
|
2082
|
-
|
2082
|
+
title: 一括取引タスク名
|
2083
2083
|
description: |-
|
2084
2084
|
一括取引タスクの管理用の名前です。
|
2085
2085
|
description:
|
2086
2086
|
type: string
|
2087
2087
|
maxLength: 128
|
2088
|
-
|
2088
|
+
title: 一括取引の説明
|
2089
2089
|
description: |-
|
2090
2090
|
一括取引タスクの管理用の説明文です。
|
2091
2091
|
content:
|
2092
2092
|
type: string
|
2093
|
-
|
2093
|
+
title: 取引する情報のCSV
|
2094
2094
|
description: |-
|
2095
2095
|
一括取引する情報を書いたCSVの文字列です。
|
2096
2096
|
1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
|
@@ -2118,7 +2118,7 @@ paths:
|
|
2118
2118
|
type: string
|
2119
2119
|
minLength: 36
|
2120
2120
|
maxLength: 36
|
2121
|
-
|
2121
|
+
title: リクエストID
|
2122
2122
|
description: |-
|
2123
2123
|
重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
|
2124
2124
|
responses:
|
@@ -2149,7 +2149,7 @@ paths:
|
|
2149
2149
|
schema:
|
2150
2150
|
type: string
|
2151
2151
|
format: uuid
|
2152
|
-
|
2152
|
+
title: '取引ID'
|
2153
2153
|
description: |-
|
2154
2154
|
取引IDです。
|
2155
2155
|
|
@@ -2180,7 +2180,7 @@ paths:
|
|
2180
2180
|
schema:
|
2181
2181
|
type: string
|
2182
2182
|
format: uuid
|
2183
|
-
|
2183
|
+
title: '取引ID'
|
2184
2184
|
requestBody:
|
2185
2185
|
required: true
|
2186
2186
|
content:
|
@@ -2190,7 +2190,7 @@ paths:
|
|
2190
2190
|
description:
|
2191
2191
|
type: string
|
2192
2192
|
maxLength: 200
|
2193
|
-
|
2193
|
+
title: '取引履歴に表示する返金事由'
|
2194
2194
|
example: '返品対応のため'
|
2195
2195
|
responses:
|
2196
2196
|
'200':
|
@@ -2285,12 +2285,12 @@ paths:
|
|
2285
2285
|
code:
|
2286
2286
|
type: string
|
2287
2287
|
maxLength: 32
|
2288
|
-
|
2288
|
+
title: '新規組織コード'
|
2289
2289
|
example: ox_supermarket
|
2290
2290
|
name:
|
2291
2291
|
type: string
|
2292
2292
|
maxLength: 256
|
2293
|
-
|
2293
|
+
title: '新規組織名'
|
2294
2294
|
example: oxスーパー
|
2295
2295
|
private_money_ids:
|
2296
2296
|
type: array
|
@@ -2298,56 +2298,56 @@ paths:
|
|
2298
2298
|
type: string
|
2299
2299
|
format: uuid
|
2300
2300
|
minItems: 1
|
2301
|
-
|
2301
|
+
title: '加盟店組織で有効にするマネーIDの配列'
|
2302
2302
|
issuer_admin_user_email:
|
2303
2303
|
type: string
|
2304
2304
|
format: email
|
2305
|
-
|
2305
|
+
title: '発行体担当者メールアドレス'
|
2306
2306
|
member_admin_user_email:
|
2307
2307
|
type: string
|
2308
2308
|
format: email
|
2309
|
-
|
2309
|
+
title: '新規組織担当者メールアドレス'
|
2310
2310
|
bank_name:
|
2311
2311
|
type: string
|
2312
2312
|
maxLength: 64
|
2313
|
-
|
2313
|
+
title: '銀行名'
|
2314
2314
|
example: XYZ銀行
|
2315
2315
|
bank_code:
|
2316
2316
|
type: string
|
2317
2317
|
pattern: '^$|^[0-9]{4}$'
|
2318
|
-
|
2318
|
+
title: '銀行金融機関コード'
|
2319
2319
|
example: 99X
|
2320
2320
|
bank_branch_name:
|
2321
2321
|
type: string
|
2322
2322
|
maxLength: 64
|
2323
|
-
|
2323
|
+
title: '銀行支店名'
|
2324
2324
|
example: ABC支店
|
2325
2325
|
bank_branch_code:
|
2326
2326
|
type: string
|
2327
2327
|
pattern: '^(|[0-9]{3})$'
|
2328
|
-
|
2328
|
+
title: '銀行支店コード'
|
2329
2329
|
example: 99X
|
2330
2330
|
bank_account_type:
|
2331
2331
|
type: string
|
2332
2332
|
enum: [saving, current, other]
|
2333
|
-
|
2333
|
+
title: '銀行口座種別 (普通=saving, 当座=current, その他=other)'
|
2334
2334
|
bank_account:
|
2335
2335
|
type: string
|
2336
2336
|
maxLength: 7
|
2337
2337
|
pattern: '[0-9]{0,7}'
|
2338
|
-
|
2338
|
+
title: '銀行口座番号'
|
2339
2339
|
example: 9999999
|
2340
2340
|
bank_account_holder_name:
|
2341
2341
|
# TODO: flico
|
2342
2342
|
type: string
|
2343
2343
|
maxLength: 30
|
2344
2344
|
pattern: '^[0-9A-Zヲア-゚ (-),-/\\「-」]$'
|
2345
|
-
|
2345
|
+
title: '口座名義人名'
|
2346
2346
|
example: フクザワユキチ
|
2347
2347
|
contact_name:
|
2348
2348
|
type: string
|
2349
2349
|
maxLength: 256
|
2350
|
-
|
2350
|
+
title: '担当者名'
|
2351
2351
|
example: 佐藤清
|
2352
2352
|
responses:
|
2353
2353
|
'200':
|
@@ -2373,66 +2373,66 @@ paths:
|
|
2373
2373
|
type: string
|
2374
2374
|
pattern: '^[a-zA-Z0-9-]*$'
|
2375
2375
|
maxLength: 32
|
2376
|
-
|
2376
|
+
title: '組織コード'
|
2377
2377
|
description: |
|
2378
2378
|
このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
|
2379
2379
|
example: 'pocketchange'
|
2380
2380
|
private_money_id:
|
2381
2381
|
type: string
|
2382
2382
|
format: uuid
|
2383
|
-
|
2383
|
+
title: 'マネーID'
|
2384
2384
|
description: |
|
2385
2385
|
このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
|
2386
2386
|
name:
|
2387
2387
|
type: string
|
2388
2388
|
minLength: 1
|
2389
2389
|
maxLength: 256
|
2390
|
-
|
2390
|
+
title: '店舗名'
|
2391
2391
|
example: 'oxスーパー三田店'
|
2392
2392
|
description: |
|
2393
2393
|
このパラメータを渡すとその名前の店舗のみが返されます。
|
2394
2394
|
postal_code:
|
2395
2395
|
type: string
|
2396
2396
|
pattern: '^[0-9]{3}-?[0-9]{4}$'
|
2397
|
-
|
2397
|
+
title: '店舗の郵便番号'
|
2398
2398
|
description: |
|
2399
2399
|
このパラメータを渡すとその郵便番号が登録された店舗のみが返されます。
|
2400
2400
|
address:
|
2401
2401
|
type: string
|
2402
2402
|
maxLength: 256
|
2403
|
-
|
2403
|
+
title: '店舗の住所'
|
2404
2404
|
example: '東京都港区芝...'
|
2405
2405
|
description: |
|
2406
2406
|
このパラメータを渡すとその住所が登録された店舗のみが返されます。
|
2407
2407
|
tel:
|
2408
2408
|
type: string
|
2409
2409
|
pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
|
2410
|
-
|
2410
|
+
title: '店舗の電話番号'
|
2411
2411
|
description: |
|
2412
2412
|
このパラメータを渡すとその電話番号が登録された店舗のみが返されます。
|
2413
2413
|
email:
|
2414
2414
|
type: string
|
2415
2415
|
format: email
|
2416
2416
|
maxLength: 256
|
2417
|
-
|
2417
|
+
title: '店舗のメールアドレス'
|
2418
2418
|
description: |
|
2419
2419
|
このパラメータを渡すとそのメールアドレスが登録された店舗のみが返されます。
|
2420
2420
|
external_id:
|
2421
2421
|
type: string
|
2422
2422
|
maxLength: 36
|
2423
|
-
|
2423
|
+
title: '店舗の外部ID'
|
2424
2424
|
description: |
|
2425
2425
|
このパラメータを渡すとその外部IDが登録された店舗のみが返されます。
|
2426
2426
|
page:
|
2427
2427
|
type: integer
|
2428
2428
|
minimum: 1
|
2429
|
-
|
2429
|
+
title: 'ページ番号'
|
2430
2430
|
description: 取得したいページ番号です。
|
2431
2431
|
example: 1
|
2432
2432
|
per_page:
|
2433
2433
|
type: integer
|
2434
2434
|
minimum: 1
|
2435
|
-
|
2435
|
+
title: '1ページ分の取引数'
|
2436
2436
|
description: 1ページ分の取引数です。
|
2437
2437
|
example: 50
|
2438
2438
|
responses:
|
@@ -2469,35 +2469,35 @@ paths:
|
|
2469
2469
|
type: string
|
2470
2470
|
minLength: 1
|
2471
2471
|
maxLength: 256
|
2472
|
-
|
2472
|
+
title: '店舗名'
|
2473
2473
|
example: 'oxスーパー三田店'
|
2474
2474
|
shop_postal_code:
|
2475
2475
|
type: string
|
2476
2476
|
pattern: '^[0-9]{3}-?[0-9]{4}$'
|
2477
|
-
|
2477
|
+
title: '店舗の郵便番号'
|
2478
2478
|
shop_address:
|
2479
2479
|
type: string
|
2480
2480
|
maxLength: 256
|
2481
|
-
|
2481
|
+
title: '店舗の住所'
|
2482
2482
|
example: '東京都港区芝...'
|
2483
2483
|
shop_tel:
|
2484
2484
|
type: string
|
2485
2485
|
pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
|
2486
|
-
|
2486
|
+
title: '店舗の電話番号'
|
2487
2487
|
shop_email:
|
2488
2488
|
type: string
|
2489
2489
|
format: email
|
2490
2490
|
maxLength: 256
|
2491
|
-
|
2491
|
+
title: '店舗のメールアドレス'
|
2492
2492
|
shop_external_id:
|
2493
2493
|
type: string
|
2494
2494
|
maxLength: 36
|
2495
|
-
|
2495
|
+
title: '店舗の外部ID'
|
2496
2496
|
organization_code:
|
2497
2497
|
type: string
|
2498
2498
|
pattern: '^[a-zA-Z0-9-]*$'
|
2499
2499
|
maxLength: 32
|
2500
|
-
|
2500
|
+
title: '組織コード'
|
2501
2501
|
example: 'ox-supermarket'
|
2502
2502
|
responses:
|
2503
2503
|
'200':
|
@@ -2532,7 +2532,7 @@ paths:
|
|
2532
2532
|
type: string
|
2533
2533
|
minLength: 1
|
2534
2534
|
maxLength: 256
|
2535
|
-
|
2535
|
+
title: '店舗名'
|
2536
2536
|
description: |-
|
2537
2537
|
店舗名です。
|
2538
2538
|
|
@@ -2541,30 +2541,30 @@ paths:
|
|
2541
2541
|
postal_code:
|
2542
2542
|
type: string
|
2543
2543
|
pattern: '^[0-9]{3}-?[0-9]{4}$'
|
2544
|
-
|
2544
|
+
title: '店舗の郵便番号'
|
2545
2545
|
address:
|
2546
2546
|
type: string
|
2547
2547
|
maxLength: 256
|
2548
|
-
|
2548
|
+
title: '店舗の住所'
|
2549
2549
|
example: '東京都港区芝...'
|
2550
2550
|
tel:
|
2551
2551
|
type: string
|
2552
2552
|
pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
|
2553
|
-
|
2553
|
+
title: '店舗の電話番号'
|
2554
2554
|
email:
|
2555
2555
|
type: string
|
2556
2556
|
format: email
|
2557
2557
|
maxLength: 256
|
2558
|
-
|
2558
|
+
title: '店舗のメールアドレス'
|
2559
2559
|
external_id:
|
2560
2560
|
type: string
|
2561
2561
|
maxLength: 36
|
2562
|
-
|
2562
|
+
title: '店舗の外部ID'
|
2563
2563
|
organization_code:
|
2564
2564
|
type: string
|
2565
2565
|
pattern: '^[a-zA-Z0-9-]*$'
|
2566
2566
|
maxLength: 32
|
2567
|
-
|
2567
|
+
title: '組織コード'
|
2568
2568
|
example: 'ox-supermarket'
|
2569
2569
|
private_money_ids:
|
2570
2570
|
type: array
|
@@ -2572,7 +2572,7 @@ paths:
|
|
2572
2572
|
type: string
|
2573
2573
|
format: uuid
|
2574
2574
|
minItems: 1
|
2575
|
-
|
2575
|
+
title: '店舗で有効にするマネーIDの配列'
|
2576
2576
|
description: |-
|
2577
2577
|
店舗で有効にするマネーIDの配列を指定します。
|
2578
2578
|
|
@@ -2584,7 +2584,7 @@ paths:
|
|
2584
2584
|
type: string
|
2585
2585
|
format: uuid
|
2586
2586
|
minItems: 0
|
2587
|
-
|
2587
|
+
title: '店舗でチャージ可能にするマネーIDの配列'
|
2588
2588
|
description: |-
|
2589
2589
|
店舗でチャージ可能にするマネーIDの配列を指定します。
|
2590
2590
|
|
@@ -2623,7 +2623,7 @@ paths:
|
|
2623
2623
|
schema:
|
2624
2624
|
type: string
|
2625
2625
|
format: uuid
|
2626
|
-
|
2626
|
+
title: '店舗ユーザーID'
|
2627
2627
|
responses:
|
2628
2628
|
'200':
|
2629
2629
|
description: OK
|
@@ -2652,7 +2652,7 @@ paths:
|
|
2652
2652
|
schema:
|
2653
2653
|
type: string
|
2654
2654
|
format: uuid
|
2655
|
-
|
2655
|
+
title: '店舗ユーザーID'
|
2656
2656
|
requestBody:
|
2657
2657
|
required: true
|
2658
2658
|
content:
|
@@ -2663,7 +2663,7 @@ paths:
|
|
2663
2663
|
type: string
|
2664
2664
|
minLength: 1
|
2665
2665
|
maxLength: 256
|
2666
|
-
|
2666
|
+
title: '店舗名'
|
2667
2667
|
description: |-
|
2668
2668
|
店舗名です。
|
2669
2669
|
|
@@ -2672,20 +2672,20 @@ paths:
|
|
2672
2672
|
postal_code:
|
2673
2673
|
type: string
|
2674
2674
|
pattern: '^[0-9]{3}-?[0-9]{4}$'
|
2675
|
-
|
2675
|
+
title: '店舗の郵便番号'
|
2676
2676
|
description: |-
|
2677
2677
|
店舗住所の郵便番号(7桁の数字)です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
|
2678
2678
|
nullable: true
|
2679
2679
|
address:
|
2680
2680
|
type: string
|
2681
2681
|
maxLength: 256
|
2682
|
-
|
2682
|
+
title: '店舗の住所'
|
2683
2683
|
example: '東京都港区芝...'
|
2684
2684
|
nullable: true
|
2685
2685
|
tel:
|
2686
2686
|
type: string
|
2687
2687
|
pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
|
2688
|
-
|
2688
|
+
title: '店舗の電話番号'
|
2689
2689
|
description: |-
|
2690
2690
|
店舗の電話番号です。ハイフンは無視されます。明示的に空の値を設定するにはNULLを指定します。
|
2691
2691
|
nullable: true
|
@@ -2693,14 +2693,14 @@ paths:
|
|
2693
2693
|
type: string
|
2694
2694
|
format: email
|
2695
2695
|
maxLength: 256
|
2696
|
-
|
2696
|
+
title: '店舗のメールアドレス'
|
2697
2697
|
description: |-
|
2698
2698
|
店舗の連絡先メールアドレスです。明示的に空の値を設定するにはNULLを指定します。
|
2699
2699
|
nullable: true
|
2700
2700
|
external_id:
|
2701
2701
|
type: string
|
2702
2702
|
maxLength: 36
|
2703
|
-
|
2703
|
+
title: '店舗の外部ID'
|
2704
2704
|
description: |-
|
2705
2705
|
店舗の外部IDです(最大36文字)。明示的に空の値を設定するにはNULLを指定します。
|
2706
2706
|
nullable: true
|
@@ -2710,7 +2710,7 @@ paths:
|
|
2710
2710
|
type: string
|
2711
2711
|
format: uuid
|
2712
2712
|
minItems: 0
|
2713
|
-
|
2713
|
+
title: '店舗で有効にするマネーIDの配列'
|
2714
2714
|
description: |-
|
2715
2715
|
店舗で有効にするマネーIDの配列を指定します。
|
2716
2716
|
|
@@ -2722,7 +2722,7 @@ paths:
|
|
2722
2722
|
type: string
|
2723
2723
|
format: uuid
|
2724
2724
|
minItems: 0
|
2725
|
-
|
2725
|
+
title: '店舗でチャージ可能にするマネーIDの配列'
|
2726
2726
|
description: |-
|
2727
2727
|
店舗でチャージ可能にするマネーIDの配列を指定します。
|
2728
2728
|
|
@@ -2764,19 +2764,19 @@ paths:
|
|
2764
2764
|
type: string
|
2765
2765
|
pattern: '^[a-zA-Z0-9-]*$'
|
2766
2766
|
maxLength: 32
|
2767
|
-
|
2767
|
+
title: '組織コード'
|
2768
2768
|
description: |-
|
2769
2769
|
パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
|
2770
2770
|
example: 'ox-supermarket'
|
2771
2771
|
page:
|
2772
2772
|
type: integer
|
2773
2773
|
minimum: 1
|
2774
|
-
|
2774
|
+
title: 'ページ番号'
|
2775
2775
|
example: 1
|
2776
2776
|
per_page:
|
2777
2777
|
type: integer
|
2778
2778
|
minimum: 1
|
2779
|
-
|
2779
|
+
title: '1ページ分の取得数'
|
2780
2780
|
example: 50
|
2781
2781
|
responses:
|
2782
2782
|
'200':
|
@@ -2808,20 +2808,20 @@ paths:
|
|
2808
2808
|
from:
|
2809
2809
|
type: string
|
2810
2810
|
format: date-time
|
2811
|
-
|
2811
|
+
title: '開始日時(toと同時に指定する必要有)'
|
2812
2812
|
to:
|
2813
2813
|
type: string
|
2814
2814
|
format: date-time
|
2815
|
-
|
2815
|
+
title: '終了日時(fromと同時に指定する必要有)'
|
2816
2816
|
page:
|
2817
2817
|
type: integer
|
2818
2818
|
minimum: 1
|
2819
|
-
|
2819
|
+
title: 'ページ番号'
|
2820
2820
|
example: 1
|
2821
2821
|
per_page:
|
2822
2822
|
type: integer
|
2823
2823
|
minimum: 1
|
2824
|
-
|
2824
|
+
title: '1ページ分の取引数'
|
2825
2825
|
example: 50
|
2826
2826
|
parameters:
|
2827
2827
|
- in: path
|
@@ -2830,7 +2830,7 @@ paths:
|
|
2830
2830
|
schema:
|
2831
2831
|
type: string
|
2832
2832
|
format: uuid
|
2833
|
-
|
2833
|
+
title: マネーID
|
2834
2834
|
responses:
|
2835
2835
|
'200':
|
2836
2836
|
description: OK
|
@@ -2862,14 +2862,14 @@ paths:
|
|
2862
2862
|
private_money_id:
|
2863
2863
|
type: string
|
2864
2864
|
format: uuid
|
2865
|
-
|
2865
|
+
title: 'マネーID'
|
2866
2866
|
description: |-
|
2867
2867
|
マネーIDです。
|
2868
2868
|
フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
|
2869
2869
|
sender_customer_id:
|
2870
2870
|
type: string
|
2871
2871
|
format: uuid
|
2872
|
-
|
2872
|
+
title: '送金エンドユーザーID'
|
2873
2873
|
description: |-
|
2874
2874
|
送金ユーザーIDです。
|
2875
2875
|
|
@@ -2877,14 +2877,14 @@ paths:
|
|
2877
2877
|
receiver_customer_id:
|
2878
2878
|
type: string
|
2879
2879
|
format: uuid
|
2880
|
-
|
2880
|
+
title: '受取エンドユーザーID'
|
2881
2881
|
description: |-
|
2882
2882
|
受取ユーザーIDです。
|
2883
2883
|
|
2884
2884
|
フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
|
2885
2885
|
type:
|
2886
2886
|
type: string
|
2887
|
-
|
2887
|
+
title: '取引種別、チャージ=topup、支払い=payment、個人間送金=transfer'
|
2888
2888
|
description: |-
|
2889
2889
|
取引の種類でフィルターします。
|
2890
2890
|
|
@@ -2900,7 +2900,7 @@ paths:
|
|
2900
2900
|
個人間送金
|
2901
2901
|
is_modified:
|
2902
2902
|
type: boolean
|
2903
|
-
|
2903
|
+
title: 'キャンセル済みかどうか'
|
2904
2904
|
description: |-
|
2905
2905
|
キャンセル済みかどうかを判定するフラグです。
|
2906
2906
|
|
@@ -2910,7 +2910,7 @@ paths:
|
|
2910
2910
|
from:
|
2911
2911
|
type: string
|
2912
2912
|
format: date-time
|
2913
|
-
|
2913
|
+
title: '開始日時'
|
2914
2914
|
description: |-
|
2915
2915
|
抽出期間の開始日時です。
|
2916
2916
|
|
@@ -2918,7 +2918,7 @@ paths:
|
|
2918
2918
|
to:
|
2919
2919
|
type: string
|
2920
2920
|
format: date-time
|
2921
|
-
|
2921
|
+
title: '終了日時'
|
2922
2922
|
description: |-
|
2923
2923
|
抽出期間の終了日時です。
|
2924
2924
|
|
@@ -2926,13 +2926,13 @@ paths:
|
|
2926
2926
|
page:
|
2927
2927
|
type: integer
|
2928
2928
|
minimum: 1
|
2929
|
-
|
2929
|
+
title: 'ページ番号'
|
2930
2930
|
description: 取得したいページ番号です。
|
2931
2931
|
example: 1
|
2932
2932
|
per_page:
|
2933
2933
|
type: integer
|
2934
2934
|
minimum: 1
|
2935
|
-
|
2935
|
+
title: '1ページ分の取引数'
|
2936
2936
|
description: 1ページ分の取引数です。
|
2937
2937
|
example: 50
|
2938
2938
|
responses:
|
@@ -2959,7 +2959,7 @@ paths:
|
|
2959
2959
|
schema:
|
2960
2960
|
type: string
|
2961
2961
|
format: uuid
|
2962
|
-
|
2962
|
+
title: 'バルク取引ジョブID'
|
2963
2963
|
description: |-
|
2964
2964
|
バルク取引ジョブIDです。
|
2965
2965
|
バルク取引ジョブ登録時にレスポンスに含まれます。
|
@@ -3000,25 +3000,25 @@ paths:
|
|
3000
3000
|
private_money_id:
|
3001
3001
|
type: string
|
3002
3002
|
format: uuid
|
3003
|
-
|
3003
|
+
title: 'マネーID'
|
3004
3004
|
description: |-
|
3005
3005
|
取引対象のマネーのIDです(必須項目)。
|
3006
3006
|
shop_id:
|
3007
3007
|
type: string
|
3008
3008
|
format: uuid
|
3009
|
-
|
3009
|
+
title: '店舗ユーザーID'
|
3010
3010
|
description: |-
|
3011
3011
|
店舗のユーザーIDです(必須項目)。
|
3012
3012
|
amount:
|
3013
3013
|
type: number
|
3014
|
-
|
3014
|
+
title: '金額'
|
3015
3015
|
description: |-
|
3016
3016
|
マネー額です(必須項目)。
|
3017
3017
|
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
3018
3018
|
description:
|
3019
3019
|
type: string
|
3020
3020
|
maxLength: 200
|
3021
|
-
|
3021
|
+
title: '取引履歴に表示する説明文'
|
3022
3022
|
description: |-
|
3023
3023
|
Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
|
3024
3024
|
アプリや管理画面などの取引履歴に表示されます。デフォルトでは空文字になります。
|
@@ -3026,7 +3026,7 @@ paths:
|
|
3026
3026
|
expires_in:
|
3027
3027
|
type: integer
|
3028
3028
|
minimum: 1
|
3029
|
-
|
3029
|
+
title: '失効時間(秒)'
|
3030
3030
|
description: |-
|
3031
3031
|
Cashtrayが失効するまでの時間を秒単位で指定します(任意項目、デフォルト値は1800秒(30分))。
|
3032
3032
|
responses:
|
@@ -3114,7 +3114,7 @@ paths:
|
|
3114
3114
|
schema:
|
3115
3115
|
type: string
|
3116
3116
|
format: uuid
|
3117
|
-
|
3117
|
+
title: 'CashtrayのID'
|
3118
3118
|
description: |-
|
3119
3119
|
情報を取得するCashtrayのIDです。
|
3120
3120
|
responses:
|
@@ -3150,7 +3150,7 @@ paths:
|
|
3150
3150
|
schema:
|
3151
3151
|
type: string
|
3152
3152
|
format: uuid
|
3153
|
-
|
3153
|
+
title: 'CashtrayのID'
|
3154
3154
|
description: |-
|
3155
3155
|
無効化するCashtrayのIDです。
|
3156
3156
|
responses:
|
@@ -3182,7 +3182,7 @@ paths:
|
|
3182
3182
|
schema:
|
3183
3183
|
type: string
|
3184
3184
|
format: uuid
|
3185
|
-
|
3185
|
+
title: 'CashtrayのID'
|
3186
3186
|
description: |-
|
3187
3187
|
更新対象のCashtrayのIDです。
|
3188
3188
|
requestBody:
|
@@ -3193,14 +3193,14 @@ paths:
|
|
3193
3193
|
properties:
|
3194
3194
|
amount:
|
3195
3195
|
type: number
|
3196
|
-
|
3196
|
+
title: '金額'
|
3197
3197
|
description: |-
|
3198
3198
|
マネー額です(任意項目)。
|
3199
3199
|
正の値を与えるとチャージになり、負の値を与えると支払いとなります。
|
3200
3200
|
description:
|
3201
3201
|
type: string
|
3202
3202
|
maxLength: 200
|
3203
|
-
|
3203
|
+
title: '取引履歴に表示する説明文'
|
3204
3204
|
description: |-
|
3205
3205
|
Cashtrayを読み取ったときに作られる取引の説明文です(最大200文字、任意項目)。
|
3206
3206
|
アプリや管理画面などの取引履歴に表示されます。
|
@@ -3208,7 +3208,7 @@ paths:
|
|
3208
3208
|
expires_in:
|
3209
3209
|
type: integer
|
3210
3210
|
minimum: 1
|
3211
|
-
|
3211
|
+
title: '失効時間(秒)'
|
3212
3212
|
description: |-
|
3213
3213
|
Cashtrayが失効するまでの時間を秒で指定します(任意項目、デフォルト値は1800秒(30分))。
|
3214
3214
|
responses:
|