API Specification Revision History

Files changed (1) hide show
  1. old.yml 2026-08-07 10:10:55 → 21_インターフェース/1_1_API仕様書.yml 2026-07-29 09:45:33 +68 -2
old.yml 2026-08-07 10:10:55 → 21_インターフェース/1_1_API仕様書.yml 2026-07-29 09:45:33 RENAMED
@@ -1,1761 +1,1827 @@
1
  openapi: 3.0.0
2
  servers:
3
  - url: https://crednex.jpx.co.jp/api/v1
4
  description: Production server
5
  - url: https://stg.crednex.jpx.co.jp/api/v1
6
  description: Staging server
7
  info:
8
  title: ETF Creation Redemption Platform (CredNex) API Specification
9
- version: 1.2.4
10
  description: |
11
  ## Outline
12
 
13
  #### Production Environment
14
 
15
  URL: https://crednex.jpx.co.jp/api/v1
16
 
17
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
18
 
19
  #### Demo Environment
20
 
21
  URL: https://stg.crednex.jpx.co.jp/api/v1
22
 
23
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
24
 
25
 
26
  #### Network
27
 
28
  - The access route is provided only via the Internet.
29
  - Global IP for each environment of this system is not fixed.
30
 
31
  ## Preparations
32
 
33
 
34
  #### API Key
35
 
36
  Getting an API key is required.
37
  An API key is an unique key for each API user.
38
  It is used for this service to identify API users.
39
  Any API users who wish to use the APIs on this service must request TSE to issue API keys in advance.
40
  The API key should be set in the X-API-KEY in header every time you send an API call.
41
 
42
 
43
  #### IP Address Whitelisting
44
 
45
  You must submit the global IP address of the system making API calls to TSE.
46
  All API keys are linked to global IP addresses, and API calls from IP addresses not submitted in advance will not be accepted.
47
 
48
 
49
  #### Rate Limits
50
 
51
  This API uses the token bucket algorithm for rate limiting.
52
  If requests exceed the rate limit defined by the following settings, the bucket will be emptied and the user will receive an error response until tokens are replenished.
53
  - Rate: 5 tokens per second
54
  - Burst: 10 tokens
55
 
56
  Rate: The speed at which tokens are added to the bucket.
57
 
58
  Burst: The maximum number of tokens that can be stored in the bucket.
59
 
60
  Overly frequent access is prohibited as stated in the Terms and Conditions. If such behavior is detected, TSE may issue a warning to the user.
61
 
62
  ## Authorization
63
 
64
  |Method|Endpoint|MM|AP (Agency)|AP (Prop)|AM|
65
  |:----|:----|:----|:----|:----|:----|
66
  |GET|/applications<br>/applications/{applicationId}|Available|Available|Available|Available|
67
- |GET|/statements/{applicationId}<br>/issues<br>/issues/blackout<br>/pcf<br>/pcf/{pcfNumber}|Available|Available|Available|Available|
68
  |PATCH|/issues|N/A|N/A|N/A|Available|
69
  |POST|/applications|Available|N/A|Available|N/A|
70
  |PUT|/applications/{applicationId}/approve|N/A|Available|Available|Available|
71
  |PUT|/applications/{applicationId}/deny|N/A|Available|Available|Available|
72
  |PUT|/applications/{applicationId}/approveCancellationRequest|N/A|Available|Available|Available|
73
  |PUT|/applications/{applicationId}/denyCancellationRequest|N/A|Available|Available|Available|
74
  |PUT|/applications/{applicationId}/cancellationRequest|Available|N/A|Available|N/A|
75
 
76
 
77
  paths:
78
  /applications:
79
  get:
80
  summary: Get applicationId of creation and redemption application
81
  description: Get applicationId for which the user has permissions to view
82
  operationId: getApplicationIds
83
  tags:
84
  - applications
85
  parameters:
86
  - name: applicationDate
87
  in: query
88
  schema:
89
  type: string
90
  format: date
91
  description: Application date. Cannot be used together with 'applicationDateFrom'/'applicationDateTo'.
92
  - name: applicationDateFrom
93
  in: query
94
  schema:
95
  type: string
96
  format: date
97
  description: Start of the application date period (inclusive). Can be specified alone or together with 'applicationDateTo'. Cannot be used together with 'applicationDate'.
98
  - name: applicationDateTo
99
  in: query
100
  schema:
101
  type: string
102
  format: date
103
  description: End of the application date period (inclusive). Can be specified alone or together with 'applicationDateFrom'. Cannot be used together with 'applicationDate'.
104
  - name: statementFixingDate
105
  in: query
106
  schema:
107
  type: string
108
  format: date
109
  description: Statement fixing date. Cannot be used together with 'statementFixingDateFrom'/'statementFixingDateTo'.
110
  - name: statementFixingDateFrom
111
  in: query
112
  schema:
113
  type: string
114
  format: date
115
  description: Start of the statement fixing date period (inclusive). Can be specified alone or together with 'statementFixingDateTo'. Cannot be used together with 'statementFixingDate'.
116
  - name: statementFixingDateTo
117
  in: query
118
  schema:
119
  type: string
120
  format: date
121
  description: End of the statement fixing date period (inclusive). Can be specified alone or together with 'statementFixingDateFrom'. Cannot be used together with 'statementFixingDate'.
122
  - name: status
123
  in: query
124
  schema:
125
  type: string
126
  description: Specify the status of the creation and redemption applications
127
  enum:
128
  - "ApplicationInProcessAP"
129
  - "ApplicationInProcessAM"
130
  - "Accepted"
131
  - "StatementInProcessTB"
132
  - "StatementReturnedForRevisionAM"
133
  - "StatementFixed"
134
  - "CancelRequestInProcessAP"
135
  - "CancelRequestInProcessAM"
136
  - "Canceled"
137
  responses:
138
  '200':
139
  description: Success operation
140
  content:
141
  application/json:
142
  schema:
143
  type: object
144
  properties:
145
  applications:
146
  type: array
147
  items:
148
  type: object
149
  properties:
150
  id:
151
  type: string
152
  example: '2024123100010001'
153
  description: Application ID
154
  status:
155
  type: string
156
  enum:
157
  - "ApplicationInProcessAP"
158
  - "ApplicationInProcessAM"
159
  - "Accepted"
160
  - "StatementInProcessTB"
161
  - "StatementReturnedForRevisionAM"
162
  - "StatementFixed"
163
  - "CancelRequestInProcessAP"
164
  - "CancelRequestInProcessAM"
165
  - "Canceled"
166
  createdAt:
167
  type: string
 
168
  example: '2025-04-15T12:34:56+09:00'
169
  description: The time when the applicant registered this application.
170
  hasMore:
171
  type: boolean
172
  example: false
173
  description: Whether there are more than 1,000 application IDs. If true, please send a request again by narrowing down the conditions such as application date, statement fixing date, and status.
174
  '400':
175
  description: 'Bad Request'
176
  content:
177
  application/json:
178
  schema:
179
  type: object
180
  properties:
181
  message:
182
  type: string
183
  enum:
184
  - "'applicationDate' cannot be used together with 'applicationDateFrom'/'applicationDateTo'."
185
  - "'statementFixingDate' cannot be used together with 'statementFixingDateFrom'/'statementFixingDateTo'."
186
  - "'applicationDateFrom' must be before or equal to 'applicationDateTo'."
187
  - "'statementFixingDateFrom' must be before or equal to 'statementFixingDateTo'."
188
  example: "'applicationDateFrom' must be before or equal to 'applicationDateTo'."
189
  post:
190
  summary: Register for your creation/redemption application
191
  description: |
192
  Fill in the information required to apply for creation/redemption and register your application.
193
 
194
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
195
  The value set depends on `clearingType` of the issue being applied for.
196
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
197
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
198
  operationId: registerApplication
199
  tags:
200
  - applications
201
  requestBody:
202
  required: true
203
  content:
204
  application/json:
205
  schema:
206
  $ref: '#/components/schemas/Application'
207
  responses:
208
  '201':
209
  description: Created
210
  content:
211
  application/json:
212
  schema:
213
  type: object
214
  properties:
215
  applicationId:
216
  type: string
217
  example: '2024123100010001'
218
  '400':
219
  description: "Bad Request"
220
  content:
221
  application/json:
222
  schema:
223
  type: object
224
  properties:
225
  message:
226
  type: string
227
  enum:
228
  - ETF code or AP code is incorrect.
229
  - Application date is incorrect.
230
  - Cut-off time for this ETF fund has already elapsed.
231
  - Number of shares is incorrect.
232
  - The number of digits in 'numberOfShares' is exceeded.
233
  - Number of shares must be a minimum lot plus a multiple of the order unit.
234
  - Number of shares must be exceeded the minimum.
235
  - Number of shares must be an integer multiple of the trading unit. The trading unit is {trading unit}.
236
  - This issue can only be applied with clearing.
237
  - This issue can only be applied with non-clearing.
238
  - You cannot apply for cash ETFs by specifying 'codesOfTreasuryStock'.
239
  - "'codesOfTreasuryStock' must be specified as a 5-character alphanumeric code."
240
  - "'codesOfTreasuryStock' must be specified for up to 5 stocks."
241
  - "'codesOfTreasuryStock' contains duplicate codes."
242
  - The value for 'position' in the custom field must be a number up to 9.
243
  - The value for 'position' in the custom field is incorrect.
244
  - The 'value' in the custom field is incorrect.
245
  - The 'value' in the custom field must not exceed 50 characters.
246
  - "'position' in the custom field contains duplicate numbers."
247
  - Please specify either 'true' or 'false' for 'excludeTreasuryStockIfNotInPcf'.
248
  - "'applicationDate' is incorrect."
249
  - "'creationOrRedemption' is incorrect."
250
  - "'isClearing' is incorrect."
251
  - "'numberOfUnits' and 'numberOfShares' must be specified as an integer."
252
  - "Please specify 'numberOfUnits' as 1 or greater."
253
  - "The number of digits in 'numberOfUnits' is exceeded."
254
  - "Please specify 'numberOfShares' as 1 or greater."
255
  - "The number of digits in 'notes' is exceeded."
256
  - "The combination of 'numberOfShares', 'numberOfUnits', and 'pcfNumber' is invalid. Please specify either 'numberOfShares' only, or both 'numberOfUnits' and 'pcfNumber'."
257
  - Required fields are not completely filled in.
258
  - "'applicationDate' is outside the handling period for this etfCode."
259
  - "'applicationDate' is a blackout date."
260
  - Application date is a blackout date.
261
  - This ETF fund is out of handling period.
262
  - "For the specified 'etfCode', 'applicationDate', and 'creationOrRedemption', you cannot apply by specifying 'numberOfShares'. Please specify both 'numberOfUnits' and 'pcfNumber', or choose different options."
263
  - "For the specified 'etfCode', 'applicationDate', and 'creationOrRedemption', you cannot apply by specifying either 'numberOfUnits' or 'pcfNumber'. Please specify only 'numberOfShares' or choose different options."
264
  - "'pcfNumber' is incorrect."
265
  - "Cash ETF must be applied with 'numberOfShares'."
266
  - "The estimated number of units exceeds 15 digits. Please re-specify 'numberOfUnits'."
267
  - "You cannot specify 'codesOfTreasuryStock' to an issue code that does not exist in the PCF basket."
268
  - "The AM does not allow values to be set in the custom fields. Please remove all values from the custom fields and try registering again."
269
  - This issue is not available for clearing by JSCC. Please contact the CredNex team.
270
  - This issue can only be applied with clearing for creation/redemption.
271
  - This issue can only be applied with non-clearing for creation/redemption.
272
  example: 'ETF code or AP code is incorrect.'
273
  '403':
274
  description: 'Forbidden'
275
  content:
276
  application/json:
277
  schema:
278
  type: object
279
  properties:
280
  message:
281
  type: string
282
  enum:
283
  - You are not allowed to access this endpoint.
284
  example: 'You are not allowed to access this endpoint.'
285
  /applications/{applicationId}:
286
  get:
287
  summary: Get detailed application information
288
  description: 'Specify the applicationId to get details of the applications that the user has permission to view.'
289
  parameters:
290
  - $ref: '#/components/parameters/applicationId'
291
  operationId: getApplicationDetails
292
  tags:
293
  - applications
294
  responses:
295
  '200':
296
  description: Success operation
297
  content:
298
  application/json:
299
  schema:
300
  $ref: '#/components/schemas/ApplicationInfo'
301
  '403':
302
  description: 'Forbidden'
303
  content:
304
  application/json:
305
  schema:
306
  type: object
307
  properties:
308
  message:
309
  type: string
310
  example: 'You are not allowed to access this application.'
311
  /applications/{applicationId}/approve:
312
  put:
313
  summary: Approve a creation/redemption application
314
  parameters:
315
  - $ref: '#/components/parameters/applicationId'
316
  description: |
317
  Approve an application from market maker or AP.
318
  APs can only approve applications with the status 'ApplicationInProcessAP'.
319
  AMs can only approve applications with the status 'ApplicationInProcessAM'.
320
  operationId: approveApplication
321
  tags:
322
  - applications
323
  responses:
324
  '200':
325
  description: Success operation
326
  '400':
327
  description: 'Bad Request'
328
  content:
329
  application/json:
330
  schema:
331
  type: object
332
  properties:
333
  message:
334
  type: string
335
  enum:
336
  - This approval is not available for this application ID.
337
  - This application cannot be approved because it has exceeded the cut-off.
338
  example: 'This approval is not available for this application ID.'
339
  '403':
340
  description: 'Forbidden'
341
  content:
342
  application/json:
343
  schema:
344
  type: object
345
  properties:
346
  message:
347
  type: string
348
  enum:
349
  - You are not allowed to access this application.
350
  - You are not allowed to access this endpoint.
351
  example: 'You are not allowed to access this application.'
352
  /applications/{applicationId}/deny:
353
  put:
354
  summary: Deny a creation/redemption application
355
  parameters:
356
  - $ref: '#/components/parameters/applicationId'
357
  description: |
358
  Deny an application from market maker or AP.
359
  APs can only deny applications with the status 'ApplicationInProcessAP'.
360
  AMs can only deny applications with the status 'ApplicationInProcessAM'.
361
  operationId: denyApplication
362
  tags:
363
  - applications
364
  responses:
365
  '200':
366
  description: Success operation
367
  '400':
368
  description: 'Bad Request'
369
  content:
370
  application/json:
371
  schema:
372
  type: object
373
  properties:
374
  message:
375
  type: string
376
  example: 'This denial is not available for this application ID.'
377
  '403':
378
  description: 'Forbidden'
379
  content:
380
  application/json:
381
  schema:
382
  type: object
383
  properties:
384
  message:
385
  type: string
386
  enum:
387
  - You are not allowed to access this application.
388
  - You are not allowed to access this endpoint.
389
  example: 'You are not allowed to access this application.'
390
  /applications/{applicationId}/approveCancellationRequest:
391
  put:
392
  summary: Approve a cancellation request
393
  parameters:
394
  - $ref: '#/components/parameters/applicationId'
395
  description: |
396
  Approve a cancellation request from market maker or AP.
397
  APs can only approve applications with the status 'CancelRequestInProcessAP'.
398
  AMs can only approve applications with the status 'CancelRequestInProcessAM'.
399
  operationId: approveCancellationRequest
400
  tags:
401
  - applications
402
  responses:
403
  '200':
404
  description: Success operation
405
  '400':
406
  description: 'Bad Request'
407
  content:
408
  application/json:
409
  schema:
410
  type: object
411
  properties:
412
  message:
413
  type: string
414
  example: 'This approval is not available for this application ID.'
415
  '403':
416
  description: 'Forbidden'
417
  content:
418
  application/json:
419
  schema:
420
  type: object
421
  properties:
422
  message:
423
  type: string
424
  enum:
425
  - You are not allowed to access this application.
426
  - You are not allowed to access this endpoint.
427
  example: 'You are not allowed to access this application.'
428
  /applications/{applicationId}/denyCancellationRequest:
429
  put:
430
  summary: Deny a cancellation request
431
  parameters:
432
  - $ref: '#/components/parameters/applicationId'
433
  description: |
434
  Deny a cancellation request from market maker or AP.
435
  APs can only deny applications with the status 'CancelRequestInProcessAP'.
436
  AMs can only deny applications with the status 'CancelRequestInProcessAM'.
437
  operationId: denyCancellationRequest
438
  tags:
439
  - applications
440
  responses:
441
  '200':
442
  description: Success operation
443
  '400':
444
  description: 'Bad Request'
445
  content:
446
  application/json:
447
  schema:
448
  type: object
449
  properties:
450
  message:
451
  type: string
452
  example: 'This denial is not available for this application ID.'
453
  '403':
454
  description: 'Forbidden'
455
  content:
456
  application/json:
457
  schema:
458
  type: object
459
  properties:
460
  message:
461
  type: string
462
  enum:
463
  - You are not allowed to access this application.
464
  - You are not allowed to access this endpoint.
465
  example: 'You are not allowed to access this application.'
466
  /applications/{applicationId}/cancellationRequest:
467
  put:
468
  summary: Request APs to cancel an application
469
  parameters:
470
  - $ref: '#/components/parameters/applicationId'
471
  description: 'Request APs to cancel a registered application.'
472
  operationId: cancellationRequest
473
  tags:
474
  - applications
475
  responses:
476
  '200':
477
  description: Success operation
478
  '400':
479
  description: 'Bad Request'
480
  content:
481
  application/json:
482
  schema:
483
  type: object
484
  properties:
485
  message:
486
  type: string
487
  enum:
488
  - Cancellation is not available for this application ID.
489
  - Cut-off time for this ETF fund has already elapsed.
490
  example: 'Cancellation is not available for this application ID.'
491
  '403':
492
  description: 'Forbidden'
493
  content:
494
  application/json:
495
  schema:
496
  type: object
497
  properties:
498
  message:
499
  type: string
500
  enum:
501
  - You are not allowed to access this application.
502
  - You are not allowed to access this endpoint.
503
  example: 'You are not allowed to access this application.'
504
  /statements/{applicationId}:
505
  get:
506
  summary: Get statement data
507
  description: Get statement data. The layout of the response body differs between cash statements and in-kind statements.
508
  operationId: getStatement
509
  parameters:
510
  - $ref: '#/components/parameters/applicationId'
511
  tags:
512
  - applications
513
  responses:
514
  '200':
515
  description: Success operation
516
  content:
517
  application/json:
518
  schema:
519
  $ref: '#/components/schemas/Statements'
520
  '400':
521
  description: 'Bad Request'
522
  content:
523
  application/json:
524
  schema:
525
  type: object
526
  properties:
527
  message:
528
  type: string
529
  example: 'This request is not available for this application ID.'
530
  '403':
531
  description: 'Forbidden'
532
  content:
533
  application/json:
534
  schema:
535
  type: object
536
  properties:
537
  message:
538
  type: string
539
  example: 'You are not allowed to access this application.'
540
  /issues:
541
  patch:
542
  summary: Update issue details
543
  description: |
544
  Partially update issue details. AM can modify the order unit and minimum number of shares of its own issue.
545
  Fields not included in the request body will remain unchanged.
546
  operationId: UpdateIssueDetails
547
  tags:
548
  - information
549
  requestBody:
550
  required: true
551
  content:
552
  application/json:
553
  schema:
554
  type: object
555
  properties:
556
  issues:
557
  type: array
558
  items:
559
  type: object
560
  properties:
561
  etfCode:
562
  type: string
563
  description: ETF fund code. 5-digit alphanumeric character.
564
  example: '12340'
565
  creation:
566
  type: object
567
  properties:
568
  orderUnit:
569
  type: integer
 
570
  description: Order unit in case of creation. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
571
  example: 10000
572
  minimumNumberOfShares:
573
  type: integer
 
574
  description: Minimum number of shares in case of creation. If it is 30000, applicants can request in quantities of 30,000 or more.
575
  example: 30000
576
  redemption:
577
  type: object
578
  properties:
579
  orderUnit:
580
  type: integer
 
581
  description: Order unit in case of redemption. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
582
  example: 10000
583
  minimumNumberOfShares:
584
  type: integer
 
585
  description: Minimum number of shares in case of redemption. If it is 30000, applicants can request in quantities of 30,000 or more.
586
  example: 30000
587
  responses:
588
  '200':
589
  description: Success operation
590
  content:
591
  application/json:
592
  schema:
593
  $ref: '#/components/schemas/Issues'
594
  '400':
595
  description: 'Bad Request'
596
  content:
597
  application/json:
598
  schema:
599
  type: object
600
  properties:
601
  message:
602
  type: string
603
  enum:
604
  - The request body does not match the required JSON schema.
605
  - "'etfCode' must be 5 characters long and contain only uppercase letters (A–Z) and digits (0–9)."
606
  - "'orderUnit' must be an integer greater than 0."
607
  - "The 'orderUnit' exceeds 15 digits. Please re-specify 'orderUnit'."
608
  - "'minimumNumberOfShares' must be an integer greater than 0."
609
  - "The 'minimumNumberOfShares' exceeds 15 digits. Please re-specify 'minimumNumberOfShares'."
610
  example: 'The request body does not match the required JSON schema.'
611
  '403':
612
  description: 'Forbidden'
613
  content:
614
  application/json:
615
  schema:
616
  type: object
617
  properties:
618
  message:
619
  type: string
620
  example: 'You are not allowed to access this issue.'
621
  get:
622
  summary: Get basic information of each issue
623
  description: Get basic information of each issue.
624
  operationId: getIssueInfo
625
  tags:
626
  - information
627
  responses:
628
  '200':
629
  description: Success operation
630
  content:
631
  application/json:
632
  schema:
633
  $ref: '#/components/schemas/Issues'
634
  /issues/blackout:
635
  get:
636
  summary: Get blackout dates of each issue
637
  description: Get blackout dates of each issue.
638
  operationId: getBlackoutCalendar
639
  tags:
640
  - information
641
  responses:
642
  '200':
643
  description: Success operation
644
  content:
645
  application/json:
646
  schema:
647
  type: object
648
  properties:
649
  issues:
650
  type: array
651
  items:
652
  $ref: '#/components/schemas/Blackout'
653
  /pcf:
654
  get:
655
  summary: Get PCF list
656
  description: |
657
  Get PCF list includes only those whose `expirationDate` is today or later.
658
 
659
  If you want to retrieve the component stocks of a PCF, please request to `/pcf/{pcfNumber}`.
660
 
661
  By setting query parameters `isToday` and `enabledStatus` to true,
662
  you can retrieve all PCFs that are available for application today(based on JST).
663
  operationId: getPcf
664
  tags:
665
  - information
666
  parameters:
667
  - name: isToday
668
  in: query
669
  description: Retrieve only PCFs for which the today date (based on JST) is between effectiveDate and expirationDate.
670
  required: false
671
  schema:
672
  type: boolean
673
  default: true
674
  - name: enabledStatus
675
  in: query
676
  description: |
677
  Retrieve PCFs filtered by their enabled status.
678
  If `enabled`, only PCFs whose `isEnabled` value is true are retrieved.
679
  If `disabled`, only PCFs whose `isEnabled` value is false are retrieved.
680
  If `both` or not specified, PCFs with both true and false values for `isEnabled` are returned.
681
  required: false
682
  schema:
683
  type: string
684
  enum:
685
  - enabled
686
  - disabled
687
  - both
688
  default: both
689
  - name: etfCode
690
  in: query
691
  description: Retrieve only PCFs linked to the specified ETF. If not specified, all ETFs are returned.
692
  required: false
693
  schema:
694
  type: string
695
  responses:
696
  '200':
697
  description: Success operation
698
  content:
699
  application/json:
700
  schema:
701
  type: object
702
  properties:
703
  pcf:
704
  type: array
705
  items:
706
  $ref: '#/components/schemas/pcfHeader'
707
  '400':
708
  description: 'Bad Request'
709
  content:
710
  application/json:
711
  schema:
712
  type: object
713
  properties:
714
  message:
715
  type: string
716
  enum:
717
  - This value of the query parameter is incorrect.
718
  - "The query parameter 'etfCode' must be specified as a 5-digit value."
719
  example: 'This value of the query parameter is incorrect.'
720
  /pcf/{pcfNumber}:
721
  get:
722
  summary: Get PCF by specifying PCF number
723
  description: Get PCF by specifying PCF number.
724
  operationId: getPcfByPcfNumber
725
  tags:
726
  - information
727
  parameters:
728
  - name: pcfNumber
729
  in: path
730
  required: true
731
  description: PCF number. 16-digit alphanumeric character.
732
  schema:
733
  type: string
734
  example: 'P180125C13060001'
735
  responses:
736
  '200':
737
  description: Success operation
738
  content:
739
  application/json:
740
  schema:
741
  $ref: '#/components/schemas/pcfIncludingComponentStocks'
742
  '404':
743
  description: Not Found
744
  content:
745
  application/json:
746
  schema:
747
  type: object
748
  properties:
749
  message:
750
  type: string
751
  example: "'pcfNumber' is incorrect."
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
752
  security:
753
  - ApiKeyAuth: []
754
  components:
755
  securitySchemes:
756
  ApiKeyAuth:
757
  type: apiKey
758
  in: header
759
  name: X-API-KEY
760
  schemas:
761
  Application:
762
  allOf:
763
  - type: object
764
  required:
765
  - applicationDate
766
  - apCode
767
  - etfCode
768
  - creationOrRedemption
769
  properties:
770
  applicationDate:
771
  type: string
772
  format: date
773
  description: Application date
774
  example: '2025-04-15'
775
  apCode:
776
  type: string
777
  description: AP code. 5-digit number.
778
  example: '12345'
779
  etfCode:
780
  type: string
781
  description: ETFfund code. 5-digit alphanumeric character.
782
  example: '12340'
783
  creationOrRedemption:
784
  type: string
785
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
786
  example: 'C'
787
  codesOfTreasuryStock:
788
  description: |
789
  Array of Treasury Stock Codes.
790
  type: array
791
  minItems: 0
792
  maxItems: 5
793
  items:
794
  type: string
795
  example: '12340'
796
  description: 5-digit code of treasury stock.
797
  excludeTreasuryStockIfNotInPcf:
798
  description: |
799
  This parameter specifies the behavior when the specified treasury stock codes are not included in the PCF basket.
800
  It specifies whether to exclude treasury stocks not included in the PCF basket before registering the application.
801
 
802
  If the value is `false`, and any of the specified treasury stocks are not included in the PCF basket, the application registration will fail with an error.
803
  If the value is `true`, the application registration will succeed after excluding from the specified treasury stocks those not included in the PCF.
804
 
805
  For application requests for in-cash ETFs or in-kind ETFs without a specified PCF, no validation is performed to check whether the treasury stocks are included in the PCF basket.
806
  In this case, the application registration will always succeed, regardless of the parameter value.
807
  type: boolean
808
  default: false
809
 
810
  custom:
811
  type: array
812
  description: |
813
  Custom fields for extensibility.
814
  All values are visible to applicants, AP and AM.
815
  minItems: 9
816
  maxItems: 9
817
  items:
818
  type: object
819
  properties:
820
  position:
821
  type: integer
 
822
  description: Position is used to identify the field number
823
  minimum: 1
824
  maximum: 9
825
  example: 1
826
  value:
827
  type: string
828
  description: The value for this custom field
829
  example: "CUSTOM_VALUE_001"
830
  required:
831
  - position
832
  - value
833
  example:
834
  - position: 1
835
  value: "Trading Account ABC"
836
  - position: 2
837
  value: "Reference-2025-001"
838
  notes:
839
  type: string
840
  description: Notes from applicants to AP and AM.
841
  example: 'string'
842
  isClearing:
843
  type: boolean
844
  description: |
845
  Cleared by JSCC or non-cleared. false:non-cleared true:cleared.
846
 
847
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
848
  The value set depends on `clearingType` of the issue being applied for.
849
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
850
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
851
  example: true
852
  - oneOf:
853
  - type: object
854
  required:
855
  - numberOfShares
856
  properties:
857
  numberOfShares:
858
  type: integer
859
  description: |
860
  Number of shares.
861
  Required when PCF number is NOT specified.
862
  Cannot be used together with numberOfUnits.
863
  example: 10000
864
  format: int64
865
  - type: object
866
  required:
867
  - pcfNumber
868
  - numberOfUnits
869
  properties:
870
  pcfNumber:
871
  type: string
872
  description: PCF number. 16-digit alphanumeric character.
873
  example: 'P180125C13060001'
874
  numberOfUnits:
875
  type: integer
876
  description: |
877
  Number of Units.
878
  Required when PCF number is specified.
879
  Cannot be used together with numberOfShares.
880
  example: 10
881
  format: int64
882
  ApplicationInfo:
883
  type: object
884
  properties:
885
  status:
886
  type: string
887
  enum:
888
  - "ApplicationInProcessAP"
889
  - "ApplicationInProcessAM"
890
  - "Accepted"
891
  - "StatementInProcessTB"
892
  - "StatementReturnedForRevisionAM"
893
  - "StatementFixed"
894
  - "CancelRequestInProcessAP"
895
  - "CancelRequestInProcessAM"
896
  - "Canceled"
897
  example: "ApplicationInProcessAP"
898
  description: Application status at the time.
899
  applicationDate:
900
  type: string
901
  format: date
902
  description: Application date
903
  example: '2025-04-15'
904
  mmCode:
905
  type: string
906
  example: '12345'
907
  description: |
908
  MM code.
909
  5-digit number.
910
  This value is visible to MM and AP(Agency).
911
  This value is always null in the case of a request from AP(Prop) or AM.
912
  apCode:
913
  type: string
914
  description: AP code. 5-digit number.
915
  example: '12345'
916
  etfCode:
917
  type: string
918
  description: ETF fund code. 5-digit alphanumeric character.
919
  example: '12340'
920
  inKindOrInCash:
921
  type: string
922
  description: Specify in-kind or in-cash.
923
  example: 'InKindCreationInKindRedemption'
924
  enum:
925
  - CashCreationCashRedemption
926
  - InKindCreationInKindRedemption
927
  creationOrRedemption:
928
  type: string
929
  description: Creation or Redemption. 'C':Creation 'R':Redemption
930
  example: 'C'
931
  isClearing:
932
  type: boolean
933
  description: |
934
  Cleared by JSCC or non-cleared. false:non-cleared true:cleared.
935
  example: false
936
  numberOfShares:
937
  type: integer
938
  description: |
939
  Number of shares.
940
  If PCF number is specified, the estimated number of shares is set.
941
  The estimated number of shares is calculated as the PCF’s `estimatedNumberOfSharesPerUnit` multiplied by `numberOfUnits`.
942
  If no PCF number is specified, the number of shares specified by the applicant is set.
943
  example: 123456
944
  format: int64
945
  pcfNumber:
946
  type: string
947
  nullable: true
948
  description: PCF number. 16-digit alphanumeric character. If PCF number is not specified, this field is null.
949
  example: 'P180125C13060001'
950
  numberOfUnits:
951
  type: integer
952
  nullable: true
953
  description: |
954
  Number of Units.
955
  If PCF number is not specified, this field is null.
956
  example: 10
957
  format: int64
958
  jasdecAccountInformation:
959
  type: string
960
  example: '1234567'
961
  description: JASDEC account information. 7-digit number.
962
  navPerShareCalculationDate:
963
  type: string
964
  format: date
965
  example: '2025-05-29'
966
  description: NAV per share calculation date.
967
  statementFixingDate:
968
  type: string
969
  format: date
970
  example: '2025-05-29'
971
  description: Statement fixing date.
972
  trustEstablishmentOrCancellationDate:
973
  type: string
974
  format: date
975
  example: '2025-05-30'
976
  description: Trust establishment or cancellation date.
977
  settlementDate:
978
  type: string
979
  format: date
980
  example: '2025-05-31'
981
  description: Settlement date.
982
  dvpClearingPrice:
983
  type: string
984
  example: ''
985
  description: |
986
  DVP clearing price. Used only if an application is in cash ETF and cleared.
987
  codesOfTreasuryStock:
988
  description: |
989
  Array of Treasury Stock Codes.
990
  type: array
991
  minItems: 0
992
  maxItems: 5
993
  items:
994
  type: string
995
  example: '12340'
996
  description: 5-digit code of treasury stock.
997
  custom:
998
  type: array
999
  description: |
1000
  Custom fields for extensibility.
1001
  All values are visible to applicants, AP and AM.
1002
  minItems: 9
1003
  maxItems: 9
1004
  items:
1005
  type: object
1006
  properties:
1007
  position:
1008
  type: integer
 
1009
  description: Position is used to identify the field number
1010
  minimum: 1
1011
  maximum: 9
1012
  example: 1
1013
  value:
1014
  type: string
1015
  description: The value for this custom field
1016
  example: "CUSTOM_VALUE_001"
1017
  required:
1018
  - position
1019
  - value
1020
  example:
1021
  - position: 1
1022
  value: "Trading Account ABC"
1023
  - position: 2
1024
  value: "Reference-2025-001"
1025
  - position: 3
1026
  value: ""
1027
  - position: 4
1028
  value: ""
1029
  - position: 5
1030
  value: ""
1031
  - position: 6
1032
  value: ""
1033
  - position: 7
1034
  value: ""
1035
  - position: 8
1036
  value: ""
1037
  - position: 9
1038
  value: ""
1039
  notes:
1040
  type: string
1041
  description: Notes from applicants to AP and AM.
1042
  example: 'string'
1043
  createdAt:
1044
  type: string
 
1045
  example: '2025-04-15T12:34:56+09:00'
1046
  description: The time when the applicant registered this application.
1047
  Issues:
1048
  type: object
1049
  properties:
1050
  issues:
1051
  type: array
1052
  items:
1053
  type: object
1054
  properties:
1055
  etfCode:
1056
  type: string
1057
  description: ETF fund code. 5-digit alphanumeric character.
1058
  example: '12340'
1059
  inKindOrInCash:
1060
  type: string
1061
  description: Specify in-kind or in-cash.
1062
  example: 'CashCreationCashRedemption'
1063
  enum:
1064
  - CashCreationCashRedemption
1065
  - InKindCreationInKindRedemption
1066
  etfNameJa:
1067
  type: string
1068
  description: ETF fund name in Japanese.
1069
  example: 'XXX ファンド'
1070
  etfNameEn:
1071
  type: string
1072
  description: ETF fund name in English.
1073
  example: 'XXX fund'
1074
  cutoffTimeIncludingTreasuryStock:
1075
  type: string
1076
  description: Cut-off time (JST) for cases where the treasury stock of AP is included in the basket. This item is omitted for cash ETF.
1077
  example: '14:30'
1078
  cutoffTimeExcludingTreasuryStock:
1079
  type: string
1080
  description: Cut-off time (JST) for cases where the treasury stock of AP is not included in the basket. All cut-off time for in cash ETF funds are placed in this field.
1081
  example: '15:30'
1082
  creation:
1083
  type: object
1084
  properties:
1085
  clearingType:
1086
  type: string
1087
  enum:
1088
  - Clearing
1089
  - Non-Clearing
1090
  - Selectable
1091
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
1092
  example: 'Clearing'
1093
  schedule:
1094
  type: object
1095
  properties:
1096
  clearing:
1097
  $ref: "#/components/schemas/CreationSchedule"
1098
  nonClearing:
1099
  $ref: "#/components/schemas/CreationSchedule"
1100
  example:
1101
  clearing:
1102
  navPerShareCalculationDate: 0
1103
  statementFixingDate: 1
1104
  trustEstablishmentDate: 2
1105
  settlementDate: 2
1106
  nonClearing: null
1107
  orderUnit:
1108
  type: integer
 
1109
  description: Order unit in case of creation. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
1110
  example: 10000
1111
  minimumNumberOfShares:
1112
  type: integer
 
1113
  description: Minimum number of shares in case of creation. If it is 30000, applicants can request in quantities of 30,000 or more.
1114
  example: 30000
1115
  redemption:
1116
  type: object
1117
  properties:
1118
  clearingType:
1119
  type: string
1120
  enum:
1121
  - Clearing
1122
  - Non-Clearing
1123
  - Selectable
1124
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
1125
  example: 'Selectable'
1126
  schedule:
1127
  type: object
1128
  properties:
1129
  clearing:
1130
  $ref: "#/components/schemas/RedemptionSchedule"
1131
  nonClearing:
1132
  $ref: "#/components/schemas/RedemptionSchedule"
1133
  example:
1134
  clearing:
1135
  navPerShareCalculationDate: 0
1136
  statementFixingDate: 1
1137
  trustCancellationDate: 2
1138
  settlementDate: 2
1139
  nonClearing:
1140
  navPerShareCalculationDate: 0
1141
  statementFixingDate: 1
1142
  trustCancellationDate: 2
1143
  settlementDate: 2
1144
  orderUnit:
1145
  type: integer
 
1146
  description: Order unit in case of redemption. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
1147
  example: 10000
1148
  minimumNumberOfShares:
1149
  type: integer
 
1150
  description: Minimum number of shares in case of redemption. If it is 30000, applicants can request in quantities of 30,000 or more.
1151
  example: 30000
1152
  customInputAllowed:
1153
  type: boolean
1154
  description: |
1155
  If true, applicants can specify any value in the optional custom fields when registering an application.
1156
  If false, applicants cannot use the optional custom fields, and all applications will have these fields left blank.
1157
  example: true
1158
  earlyRedemptionClause:
1159
  type: integer
 
1160
  description: The number of early redemption shares specified in the terms and conditions of an investment trust for each fund. This is an optional field.
1161
  example: 100000
1162
  issuersOptionalFundCode:
1163
  type: string
1164
  description: Fund code used by the issuer to identify the fund internally. This is an optional field.
1165
  example: 'ABCD1234'
1166
  isinCode:
1167
  type: string
1168
  description: ISIN code. 12-digit alphanumeric character.
1169
  example: 'JP1234567890'
1170
  amCode:
1171
  type: string
1172
  description: AM code. 5-digit number.
1173
  example: '00123'
1174
  amNameJa:
1175
  type: string
1176
  description: AM name in Japanese.
1177
  example: 'XXX アセットマネジメント'
1178
  amNameEn:
1179
  type: string
1180
  description: AM name in English.
1181
  example: 'XXX Asset Management'
1182
  tbCode:
1183
  type: string
1184
  description: TB code. 5-digit number.
1185
  example: '00001'
1186
  tbNameJa:
1187
  type: string
1188
  description: TB name in Japanese.
1189
  example: 'XXX 信託銀行'
1190
  tbNameEn:
1191
  type: string
1192
  description: TB name in English.
1193
  example: 'XXX Trust Bank Co., Ltd.'
1194
  handlingPeriodFrom:
1195
  type: string
 
1196
  description: Start date of available period for handling.
1197
  example: '2024-12-03'
1198
  handlingPeriodTo:
1199
  type: string
 
1200
  description: End date of available period for handling. If it is null, the end date is undecided.
1201
  example: '2025-09-21'
1202
  DateList:
1203
  type: array
1204
  items:
1205
  type: string
1206
  format: date
1207
  example: '1992-12-02'
1208
  Blackout:
1209
  type: object
1210
  properties:
1211
  etfCode:
1212
  type: string
1213
  example: '12340'
1214
  creationBlackoutDates:
1215
  type: array
1216
  items:
1217
  type: string
1218
  format: date
1219
  example: '1992-12-02'
1220
  redemptionBlackoutDates:
1221
  type: array
1222
  items:
1223
  type: string
1224
  format: date
1225
  example: '1992-12-02'
1226
  Statements:
1227
  oneOf:
1228
  - $ref: '#/components/schemas/InKindStatements'
1229
  - $ref: '#/components/schemas/CashStatements'
1230
  discriminator:
1231
  propertyName: inKindOrInCash
1232
  mapping:
1233
  InKindCreationInKindRedemption: '#/components/schemas/InKindStatements'
1234
  CashCreationCashRedemption: '#/components/schemas/CashStatements'
1235
  pcfHeader:
1236
  type: object
1237
  properties:
1238
  pcfNumber:
1239
  type: string
1240
  description: PCF number. 16-digit alphanumeric character.
1241
  example: "1234567890123456"
1242
  createdAt:
1243
  type: string
 
1244
  description: The date and time this PCF was registered by AM.
1245
  example: "2025-11-14T14:33:00+09:00"
1246
  am:
1247
  type: object
1248
  description: Asset Management information.
1249
  properties:
1250
  code:
1251
  type: string
1252
  description: AM code. 5-digit number.
1253
  example: "00123"
1254
  nameJa:
1255
  type: string
1256
  description: AM name in Japanese.
1257
  example: "XXX アセットマネジメント"
1258
  nameEn:
1259
  type: string
1260
  description: AM name in English.
1261
  example: "XXX Asset Management"
1262
  fileName:
1263
  type: string
1264
  description: The file name of this PCF registered by AM, including the file extension.
1265
  example: "Basket1.csv"
1266
  etf:
1267
  type: object
1268
  description: ETF fund information.
1269
  properties:
1270
  code:
1271
  type: string
1272
  description: ETF fund code. 5-digit alphanumeric character.
1273
  example: "12340"
1274
  isinCode:
1275
  type: string
1276
  description: ISIN code. 12-digit alphanumeric character.
1277
  example: "JP1234567890"
1278
  nameJa:
1279
  type: string
1280
  description: ETF fund name in Japanese.
1281
  example: "XXX ファンド"
1282
  nameEn:
1283
  type: string
1284
  description: ETF fund name in English.
1285
  example: "XXX fund"
1286
  creationOrRedemption:
1287
  type: string
1288
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
1289
  example: "C"
1290
  estimatedNumberOfSharesPerUnit:
1291
  type: integer
 
1292
  description: Estimated number of ETF shares per 1 unit.
1293
  example: 123456789012345
1294
  basketName:
1295
  type: string
1296
  description: Basket name of this PCF registered by AM.
1297
  isEnabled:
1298
  type: boolean
1299
  description: |
1300
  This flag indicates whether this PCF can be specified at the time of application for creation or redemption.
1301
  If true, applications specifying this PCF are allowed.
1302
  If false, either the validity period has expired or this PCF has been invalidated by AM,
1303
  and applications specifying this PCF are not allowed.
1304
  example: true
1305
  effectiveDate:
1306
  type: string
1307
  format: date
1308
  description: Effective date of this PCF.
1309
  example: "2025-11-12"
1310
  expirationDate:
1311
  type: string
1312
  format: date
1313
  description: Expiration date of this PCF.
1314
  example: "2025-11-14"
1315
  optionalInputItem:
1316
  type: array
1317
  minItems: 5
1318
  maxItems: 5
1319
  items:
1320
  type: object
1321
  properties:
1322
  position:
1323
  type: integer
 
1324
  description: Position is used to identify the field number
1325
  minimum: 1
1326
  maximum: 5
1327
  example: 1
1328
  name:
1329
  type: string
1330
  content:
1331
  type: string
1332
  example:
1333
  - position: 1
1334
  name: "Name1"
1335
  content: "Content1"
1336
  - position: 2
1337
  name: "Name2"
1338
  content: "Content2"
1339
  - position: 3
1340
  name: ""
1341
  content: ""
1342
  - position: 4
1343
  name: ""
1344
  content: ""
1345
  - position: 5
1346
  name: ""
1347
  content: ""
1348
  notes:
1349
  type: string
1350
  description: Notes.
1351
  example: "string"
1352
  pcfIncludingComponentStocks:
1353
  allOf:
1354
  - $ref: '#/components/schemas/pcfHeader'
1355
  - type: object
1356
  properties:
1357
  componentStocks:
1358
  type: array
1359
  description: Component Stocks.
1360
  items:
1361
  type: object
1362
  properties:
1363
  code:
1364
  type: string
1365
  description: Issue Code.
1366
  example: "12340"
1367
  isinCode:
1368
  type: string
1369
  description: ISIN Code.
1370
  example: "JP1111111111"
1371
  name:
1372
  type: string
1373
  description: Issue Name.
1374
  example: "XXX 株式"
1375
  cashSettledIssueType:
1376
  type: string
1377
  enum:
1378
  - applicable
1379
  - notApplicable
1380
  - unspecified
1381
  description: |
1382
  The flag when an individual component stock is applicable for cash settlement.<br>
1383
  notApplicable: Not applicable for cash settlement<br>
1384
  applicable: Applicable for cash settlement<br>
1385
  unspecified: Unspecified by AM
1386
  example: applicable
1387
  numberOfShares:
1388
  type: integer
 
1389
  nullable: true
1390
  description: Number of Shares.
1391
  example: 123456789012345
1392
  notes:
1393
  type: string
1394
  description: Individual Issue Optional Input Item.
1395
  example: "notes"
1396
  StatementsBase:
1397
  type: object
1398
  properties:
1399
  inKindOrInCash:
1400
  type: string
1401
  description: Specify in-kind or in-cash.
1402
  example: 'InKindCreationInKindRedemption'
1403
  applicationId:
1404
  type: string
1405
  example: '2024123100010001'
1406
  description: Application ID
1407
  pcfNumber:
1408
  type: string
1409
  example: '1234567890123456'
1410
  description: PCF number. 16-digit alphanumeric character.
1411
  amCode:
1412
  type: string
1413
  example: '00123'
1414
  description: AM code. 5-digit number.
1415
  amNameJa:
1416
  type: string
1417
  example: 'XXX アセットマネジメント'
1418
  description: AM name in Japanese.
1419
  amNameEn:
1420
  type: string
1421
  example: 'XXX Asset Management'
1422
  description: AM name in English.
1423
  userId:
1424
  type: string
1425
  example: 'XXX@crednex.co.jp'
1426
  default: User ID that registered this statement as AM
1427
  apCode:
1428
  type: string
1429
  example: '00012'
1430
  description: AP code. 5-digit number.
1431
  apNameJa:
1432
  type: string
1433
  example: 'XXX 証券'
1434
  description: AP Name in Japanese.
1435
  apNameEn:
1436
  type: string
1437
  example: 'XXX Securities Co., Ltd.'
1438
  description: AP Name in English.
1439
  etfCode:
1440
  type: string
1441
  example: '12340'
1442
  description: ETF fund code. 5-digit alphanumeric character.
1443
  etfISINCode:
1444
  type: string
1445
  example: 'JP0000000000'
1446
  description: ISIN code. 10-digit number.
1447
  etfNameJa:
1448
  type: string
1449
  example: 'XXX ファンド'
1450
  description: ETF fund name in Japanese.
1451
  etfNameEn:
1452
  type: string
1453
  example: 'XXX fund'
1454
  description: ETF fund name in English.
1455
  creationOrRedemption:
1456
  type: string
1457
  example: 'C'
1458
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
1459
  tbCode:
1460
  type: string
1461
  example: '00001'
1462
  description: TB code. 5-digit number.
1463
  tbNameJa:
1464
  type: string
1465
  example: 'XXX 信託銀行'
1466
  description: TB name in Japanese.
1467
  tbNameEn:
1468
  type: string
1469
  example: 'XXX Trust Bank Co., Ltd.'
1470
  description: TB name in English.
1471
  navPerShareCalculationDate:
1472
  type: string
1473
  format: date
1474
  example: '2025-05-29'
1475
  description: NAV per share calculation date.
1476
  statementFixingDate:
1477
  type: string
1478
  format: date
1479
  example: '2025-05-29'
1480
  description: Statement fixing date.
1481
  settlementDate:
1482
  type: string
1483
  format: date
1484
  example: '2025-05-31'
1485
  description: Settlement date.
1486
  trustEstablishmentOrCancellationDate:
1487
  type: string
1488
  format: date
1489
  example: '2025-05-30'
1490
  description: Trust establishment or cancellation date.
1491
  etfNavPerShare:
1492
  type: string
1493
  example: '12345678901234.1234'
1494
  description: |
1495
  For an in-kind statement, this item is mandatory and represents the NAV per ETF share.
1496
  In a cash statement, this item may not be registered from the AM and the value may be left blank.
1497
  In that case, `etfPurchaseOrCancellationPrice` is a mandatory item from the AM and its value is stored.
1498
  If you need to reference the price, use the value of `etfPurchaseOrCancellationPrice`.
1499
  numberOfShares:
1500
  type: integer
1501
  example: 10000
1502
  format: int64
1503
  description: Number of shares the client ordered.
1504
  numberOfSharesOfNewRecordOrScheduledDeletion:
1505
  type: integer
1506
  example: 123456789012345
1507
  format: int64
1508
  description: The number of shares of new record or scheduled deletion.
1509
  etfNetAssetValue:
1510
  type: string
1511
  example: '12345678901234.1234'
1512
  description: ETF net asset value.
1513
  optionalInputItemName1:
1514
  type: string
1515
  description: Name of optional item.
1516
  optionalInputItemName2:
1517
  type: string
1518
  optionalInputItemContent2:
1519
  type: string
1520
  description: Contents of optional item.
1521
  optionalInputItemName3:
1522
  type: string
1523
  optionalInputItemContent3:
1524
  type: string
1525
  optionalInputItemName4:
1526
  type: string
1527
  optionalInputItemName5:
1528
  type: string
1529
  optionalInputItemName6:
1530
  type: string
1531
  optionalInputItemContent6:
1532
  type: string
1533
  optionalInputItemName7:
1534
  type: string
1535
  optionalInputItemContent7:
1536
  type: string
1537
  optionalInputItemName8:
1538
  type: string
1539
  optionalInputItemContent8:
1540
  type: string
1541
  optionalInputItemName9:
1542
  type: string
1543
  optionalInputItemContent9:
1544
  type: string
1545
  optionalInputItemName10:
1546
  type: string
1547
  optionalInputItemContent10:
1548
  type: string
1549
  notes:
1550
  type: string
1551
  description: Notices by AM for AP.
1552
  InKindStatements:
1553
  allOf:
1554
  - $ref: '#/components/schemas/StatementsBase'
1555
  - type: object
1556
  properties:
1557
  inKindOrInCash:
1558
  type: string
1559
  description: Specify in-kind or in-cash.
1560
  example: 'InKindCreationInKindRedemption'
1561
  enum:
1562
  - InKindCreationInKindRedemption
1563
  residualNumberOfEtfSharesToBeReturned:
1564
  type: integer
1565
  example: 10000
1566
  format: int64
1567
  description: Residual Number of ETF Shares to be Returned.
1568
  totalPaymentAmountInCreation:
1569
  type: integer
1570
  example: 10000
1571
  format: int64
1572
  description: Total Payment Amount in Creation.
1573
  basketValuation:
1574
  type: string
1575
  example: '12345678901234.1234'
1576
  description: Basket Valuation.
1577
  cashSettledIssues:
1578
  type: array
1579
  description: Cash-settled Issues.
1580
  minItems: 10
1581
  maxItems: 10
1582
  items:
1583
  type: object
1584
  properties:
1585
  position:
1586
  type: integer
 
1587
  description: Position is used to identify the field number
1588
  minimum: 1
1589
  maximum: 10
1590
  example: 1
1591
  code:
1592
  type: string
1593
  description: Cash-settled Issue Code.
1594
  example: "12340"
1595
  name:
1596
  type: string
1597
  description: Cash-settled Issue Name.
1598
  example: "XXX 株式"
1599
  numberOfShares:
1600
  type: integer
1601
  nullable: true
1602
  format: int64
1603
  description: Cash-settled Issue Quantity.
1604
  example: 123456789012345
1605
  valuationPrice:
1606
  type: string
1607
  description: Cash-settled Issue Valuation Price.
1608
  example: "12345678901234.1234"
1609
  totalAmount:
1610
  type: string
1611
  description: Cash-settled Issue Total Amount.
1612
  example: "12345678901234.1234"
1613
  required:
1614
  - position
1615
  example:
1616
  - position: 1
1617
  code: "12340"
1618
  name: "XXX 株式"
1619
  numberOfShares: 100000
1620
  valuationPrice: "12345678901234.1234"
1621
  totalAmount: "12345678901234.1234"
1622
  optionalInputItemContent1:
1623
  type: string
1624
  optionalInputItemContent4:
1625
  type: string
1626
  optionalInputItemContent5:
1627
  type: string
1628
  componentStocks:
1629
  type: array
1630
  description: Component Stocks.
1631
  items:
1632
  type: object
1633
  properties:
1634
  code:
1635
  type: string
1636
  description: Issue Code.
1637
  example: "12340"
1638
  isinCode:
1639
  type: string
1640
  description: ISIN Code.
1641
  example: "JP1111111111"
1642
  name:
1643
  type: string
1644
  description: Issue Name.
1645
  example: "XXX 株式"
1646
  numberOfShares:
1647
  type: integer
1648
  format: int64
1649
  description: Number of Shares.
1650
  example: 123456789012345
1651
  stockPrice:
1652
  type: string
1653
  description: Stock Price.
1654
  example: "12345678901234.1234"
1655
  individualIssueTotalMarketValue:
1656
  type: string
1657
  description: Individual Issue Total Market Value.
1658
  example: "12345678901234.1234"
1659
  notes:
1660
  type: string
1661
  description: Individual Issue Optional Input Item.
1662
  example: "string"
1663
  CashStatements:
1664
  allOf:
1665
  - $ref: '#/components/schemas/StatementsBase'
1666
  - type: object
1667
  properties:
1668
  inKindOrInCash:
1669
  type: string
1670
  description: Specify in-kind or in-cash.
1671
  example: 'CashCreationCashRedemption'
1672
  enum:
1673
  - CashCreationCashRedemption
1674
  etfPurchaseOrCancellationPrice:
1675
  type: string
1676
  example: '12345678901234.1234'
1677
  description: |
1678
  The price per ETF unit obtained by adding or subtracting execution costs (spreads) and other fees to or from the NAV per ETF unit is set.
1679
  In a cash statement, this is a mandatory item that must always be registered by the AM, and its value is stored.
1680
  When you need to reference the NAV in a cash statement, use this item.
1681
  executionCosts:
1682
  type: string
1683
  description: Execution cost of this creation/redemption for AP.
1684
  totalPaymentAmount:
1685
  type: string
1686
  example: '123456789012345678'
1687
  description: Total payment of this creation/redemption for AP.
1688
  statementType:
1689
  type: string
1690
  enum:
1691
  - 'CreatedByAM'
1692
  - 'CreatedByCredNex'
1693
  description: |
1694
  CreatedByAM: This statement is registered by AM, and transitions to 'StatementFixed' status by the deadline of the statement fixing date.
1695
 
1696
  CreatedByCredNex: This statement is automatically created by CredNex because the application for the statement transitions to 'Accepted', but does not transition to 'StatementFixed' status by the deadline of the statement fixing date.
1697
 
1698
  If the application is non-cleared, the return value for this item will be an empty string.
1699
  dvpSettlementPrice:
1700
  type: string
1701
  example: '12345678901234.1234'
1702
  description: DVP settlement price calculated on the application date. If the application is non-cleared, the return value for this item will be an empty string.
1703
 
1704
  BaseSchedule:
1705
  type: object
1706
  description: Schedule configuration depends on clearingType. For "Clearing", only clearing.schedule is set and nonClearing.schedule is null. For "Non-Clearing", only nonClearing.schedule is set and clearing.schedule is null. For "Selectable", both clearing.schedule and nonClearing.schedule are set.
1707
  nullable: true
1708
  properties:
1709
  navPerShareCalculationDate:
1710
  type: integer
 
1711
  description: NAV per share calculation date. It is counted from the trade date (dayT). If it is '0', T+0 is NAV per share calculation date.
1712
  example: 0
1713
  statementFixingDate:
1714
  type: integer
 
1715
  description: Statement fixing date. It is counted from the trade date (dayT).
1716
  example: 1
1717
  settlementDate:
1718
  type: integer
 
1719
  description: Settlement date. It is counted from the trade date (dayT).
1720
  example: 2
1721
  CreationSchedule:
1722
  allOf:
1723
  - $ref: "#/components/schemas/BaseSchedule"
1724
  - type: object
1725
  properties:
1726
  trustEstablishmentDate:
1727
  type: integer
 
1728
  description: Trust establishment date in case of creation. It is counted from the trade date (dayT).
1729
  example: 2
1730
  RedemptionSchedule:
1731
  allOf:
1732
  - $ref: "#/components/schemas/BaseSchedule"
1733
  - type: object
1734
  properties:
1735
  trustCancellationDate:
1736
  type: integer
 
1737
  description: Trust cancellation date in case of redemption. It is counted from the trade date (dayT).
1738
  example: 2
1739
  parameters:
1740
  applicationId:
1741
  name: applicationId
1742
  in: path
1743
  required: true
1744
  description: Application ID
1745
  schema:
1746
  type: string
1747
  example: '2024123100010001'
1748
  statementFixingDate:
1749
  name: statementFixingDate
1750
  in: query
1751
  required: false
1752
  description: Statement fixing date. Default is today (JST).
1753
  schema:
1754
  type: string
1755
  format: date
1756
  example: '2025-05-29'
1757
  tags:
1758
  - name: applications
1759
  description: Create/Approve creation/redemption applications
1760
  - name: information
1761
  description: Get information related to ETF creation/redemption operations
 
1
  openapi: 3.0.0
2
  servers:
3
  - url: https://crednex.jpx.co.jp/api/v1
4
  description: Production server
5
  - url: https://stg.crednex.jpx.co.jp/api/v1
6
  description: Staging server
7
  info:
8
  title: ETF Creation Redemption Platform (CredNex) API Specification
9
+ version: 1.2.5
10
  description: |
11
  ## Outline
12
 
13
  #### Production Environment
14
 
15
  URL: https://crednex.jpx.co.jp/api/v1
16
 
17
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
18
 
19
  #### Demo Environment
20
 
21
  URL: https://stg.crednex.jpx.co.jp/api/v1
22
 
23
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
24
 
25
 
26
  #### Network
27
 
28
  - The access route is provided only via the Internet.
29
  - Global IP for each environment of this system is not fixed.
30
 
31
  ## Preparations
32
 
33
 
34
  #### API Key
35
 
36
  Getting an API key is required.
37
  An API key is an unique key for each API user.
38
  It is used for this service to identify API users.
39
  Any API users who wish to use the APIs on this service must request TSE to issue API keys in advance.
40
  The API key should be set in the X-API-KEY in header every time you send an API call.
41
 
42
 
43
  #### IP Address Whitelisting
44
 
45
  You must submit the global IP address of the system making API calls to TSE.
46
  All API keys are linked to global IP addresses, and API calls from IP addresses not submitted in advance will not be accepted.
47
 
48
 
49
  #### Rate Limits
50
 
51
  This API uses the token bucket algorithm for rate limiting.
52
  If requests exceed the rate limit defined by the following settings, the bucket will be emptied and the user will receive an error response until tokens are replenished.
53
  - Rate: 5 tokens per second
54
  - Burst: 10 tokens
55
 
56
  Rate: The speed at which tokens are added to the bucket.
57
 
58
  Burst: The maximum number of tokens that can be stored in the bucket.
59
 
60
  Overly frequent access is prohibited as stated in the Terms and Conditions. If such behavior is detected, TSE may issue a warning to the user.
61
 
62
  ## Authorization
63
 
64
  |Method|Endpoint|MM|AP (Agency)|AP (Prop)|AM|
65
  |:----|:----|:----|:----|:----|:----|
66
  |GET|/applications<br>/applications/{applicationId}|Available|Available|Available|Available|
67
+ |GET|/statements/{applicationId}<br>/issues<br>/issues/blackout<br>/pcf<br>/pcf/{pcfNumber}<br>/businessDays|Available|Available|Available|Available|
68
  |PATCH|/issues|N/A|N/A|N/A|Available|
69
  |POST|/applications|Available|N/A|Available|N/A|
70
  |PUT|/applications/{applicationId}/approve|N/A|Available|Available|Available|
71
  |PUT|/applications/{applicationId}/deny|N/A|Available|Available|Available|
72
  |PUT|/applications/{applicationId}/approveCancellationRequest|N/A|Available|Available|Available|
73
  |PUT|/applications/{applicationId}/denyCancellationRequest|N/A|Available|Available|Available|
74
  |PUT|/applications/{applicationId}/cancellationRequest|Available|N/A|Available|N/A|
75
 
76
 
77
  paths:
78
  /applications:
79
  get:
80
  summary: Get applicationId of creation and redemption application
81
  description: Get applicationId for which the user has permissions to view
82
  operationId: getApplicationIds
83
  tags:
84
  - applications
85
  parameters:
86
  - name: applicationDate
87
  in: query
88
  schema:
89
  type: string
90
  format: date
91
  description: Application date. Cannot be used together with 'applicationDateFrom'/'applicationDateTo'.
92
  - name: applicationDateFrom
93
  in: query
94
  schema:
95
  type: string
96
  format: date
97
  description: Start of the application date period (inclusive). Can be specified alone or together with 'applicationDateTo'. Cannot be used together with 'applicationDate'.
98
  - name: applicationDateTo
99
  in: query
100
  schema:
101
  type: string
102
  format: date
103
  description: End of the application date period (inclusive). Can be specified alone or together with 'applicationDateFrom'. Cannot be used together with 'applicationDate'.
104
  - name: statementFixingDate
105
  in: query
106
  schema:
107
  type: string
108
  format: date
109
  description: Statement fixing date. Cannot be used together with 'statementFixingDateFrom'/'statementFixingDateTo'.
110
  - name: statementFixingDateFrom
111
  in: query
112
  schema:
113
  type: string
114
  format: date
115
  description: Start of the statement fixing date period (inclusive). Can be specified alone or together with 'statementFixingDateTo'. Cannot be used together with 'statementFixingDate'.
116
  - name: statementFixingDateTo
117
  in: query
118
  schema:
119
  type: string
120
  format: date
121
  description: End of the statement fixing date period (inclusive). Can be specified alone or together with 'statementFixingDateFrom'. Cannot be used together with 'statementFixingDate'.
122
  - name: status
123
  in: query
124
  schema:
125
  type: string
126
  description: Specify the status of the creation and redemption applications
127
  enum:
128
  - "ApplicationInProcessAP"
129
  - "ApplicationInProcessAM"
130
  - "Accepted"
131
  - "StatementInProcessTB"
132
  - "StatementReturnedForRevisionAM"
133
  - "StatementFixed"
134
  - "CancelRequestInProcessAP"
135
  - "CancelRequestInProcessAM"
136
  - "Canceled"
137
  responses:
138
  '200':
139
  description: Success operation
140
  content:
141
  application/json:
142
  schema:
143
  type: object
144
  properties:
145
  applications:
146
  type: array
147
  items:
148
  type: object
149
  properties:
150
  id:
151
  type: string
152
  example: '2024123100010001'
153
  description: Application ID
154
  status:
155
  type: string
156
  enum:
157
  - "ApplicationInProcessAP"
158
  - "ApplicationInProcessAM"
159
  - "Accepted"
160
  - "StatementInProcessTB"
161
  - "StatementReturnedForRevisionAM"
162
  - "StatementFixed"
163
  - "CancelRequestInProcessAP"
164
  - "CancelRequestInProcessAM"
165
  - "Canceled"
166
  createdAt:
167
  type: string
168
+ format: date-time
169
  example: '2025-04-15T12:34:56+09:00'
170
  description: The time when the applicant registered this application.
171
  hasMore:
172
  type: boolean
173
  example: false
174
  description: Whether there are more than 1,000 application IDs. If true, please send a request again by narrowing down the conditions such as application date, statement fixing date, and status.
175
  '400':
176
  description: 'Bad Request'
177
  content:
178
  application/json:
179
  schema:
180
  type: object
181
  properties:
182
  message:
183
  type: string
184
  enum:
185
  - "'applicationDate' cannot be used together with 'applicationDateFrom'/'applicationDateTo'."
186
  - "'statementFixingDate' cannot be used together with 'statementFixingDateFrom'/'statementFixingDateTo'."
187
  - "'applicationDateFrom' must be before or equal to 'applicationDateTo'."
188
  - "'statementFixingDateFrom' must be before or equal to 'statementFixingDateTo'."
189
  example: "'applicationDateFrom' must be before or equal to 'applicationDateTo'."
190
  post:
191
  summary: Register for your creation/redemption application
192
  description: |
193
  Fill in the information required to apply for creation/redemption and register your application.
194
 
195
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
196
  The value set depends on `clearingType` of the issue being applied for.
197
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
198
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
199
  operationId: registerApplication
200
  tags:
201
  - applications
202
  requestBody:
203
  required: true
204
  content:
205
  application/json:
206
  schema:
207
  $ref: '#/components/schemas/Application'
208
  responses:
209
  '201':
210
  description: Created
211
  content:
212
  application/json:
213
  schema:
214
  type: object
215
  properties:
216
  applicationId:
217
  type: string
218
  example: '2024123100010001'
219
  '400':
220
  description: "Bad Request"
221
  content:
222
  application/json:
223
  schema:
224
  type: object
225
  properties:
226
  message:
227
  type: string
228
  enum:
229
  - ETF code or AP code is incorrect.
230
  - Application date is incorrect.
231
  - Cut-off time for this ETF fund has already elapsed.
232
  - Number of shares is incorrect.
233
  - The number of digits in 'numberOfShares' is exceeded.
234
  - Number of shares must be a minimum lot plus a multiple of the order unit.
235
  - Number of shares must be exceeded the minimum.
236
  - Number of shares must be an integer multiple of the trading unit. The trading unit is {trading unit}.
237
  - This issue can only be applied with clearing.
238
  - This issue can only be applied with non-clearing.
239
  - You cannot apply for cash ETFs by specifying 'codesOfTreasuryStock'.
240
  - "'codesOfTreasuryStock' must be specified as a 5-character alphanumeric code."
241
  - "'codesOfTreasuryStock' must be specified for up to 5 stocks."
242
  - "'codesOfTreasuryStock' contains duplicate codes."
243
  - The value for 'position' in the custom field must be a number up to 9.
244
  - The value for 'position' in the custom field is incorrect.
245
  - The 'value' in the custom field is incorrect.
246
  - The 'value' in the custom field must not exceed 50 characters.
247
  - "'position' in the custom field contains duplicate numbers."
248
  - Please specify either 'true' or 'false' for 'excludeTreasuryStockIfNotInPcf'.
249
  - "'applicationDate' is incorrect."
250
  - "'creationOrRedemption' is incorrect."
251
  - "'isClearing' is incorrect."
252
  - "'numberOfUnits' and 'numberOfShares' must be specified as an integer."
253
  - "Please specify 'numberOfUnits' as 1 or greater."
254
  - "The number of digits in 'numberOfUnits' is exceeded."
255
  - "Please specify 'numberOfShares' as 1 or greater."
256
  - "The number of digits in 'notes' is exceeded."
257
  - "The combination of 'numberOfShares', 'numberOfUnits', and 'pcfNumber' is invalid. Please specify either 'numberOfShares' only, or both 'numberOfUnits' and 'pcfNumber'."
258
  - Required fields are not completely filled in.
259
  - "'applicationDate' is outside the handling period for this etfCode."
260
  - "'applicationDate' is a blackout date."
261
  - Application date is a blackout date.
262
  - This ETF fund is out of handling period.
263
  - "For the specified 'etfCode', 'applicationDate', and 'creationOrRedemption', you cannot apply by specifying 'numberOfShares'. Please specify both 'numberOfUnits' and 'pcfNumber', or choose different options."
264
  - "For the specified 'etfCode', 'applicationDate', and 'creationOrRedemption', you cannot apply by specifying either 'numberOfUnits' or 'pcfNumber'. Please specify only 'numberOfShares' or choose different options."
265
  - "'pcfNumber' is incorrect."
266
  - "Cash ETF must be applied with 'numberOfShares'."
267
  - "The estimated number of units exceeds 15 digits. Please re-specify 'numberOfUnits'."
268
  - "You cannot specify 'codesOfTreasuryStock' to an issue code that does not exist in the PCF basket."
269
  - "The AM does not allow values to be set in the custom fields. Please remove all values from the custom fields and try registering again."
270
  - This issue is not available for clearing by JSCC. Please contact the CredNex team.
271
  - This issue can only be applied with clearing for creation/redemption.
272
  - This issue can only be applied with non-clearing for creation/redemption.
273
  example: 'ETF code or AP code is incorrect.'
274
  '403':
275
  description: 'Forbidden'
276
  content:
277
  application/json:
278
  schema:
279
  type: object
280
  properties:
281
  message:
282
  type: string
283
  enum:
284
  - You are not allowed to access this endpoint.
285
  example: 'You are not allowed to access this endpoint.'
286
  /applications/{applicationId}:
287
  get:
288
  summary: Get detailed application information
289
  description: 'Specify the applicationId to get details of the applications that the user has permission to view.'
290
  parameters:
291
  - $ref: '#/components/parameters/applicationId'
292
  operationId: getApplicationDetails
293
  tags:
294
  - applications
295
  responses:
296
  '200':
297
  description: Success operation
298
  content:
299
  application/json:
300
  schema:
301
  $ref: '#/components/schemas/ApplicationInfo'
302
  '403':
303
  description: 'Forbidden'
304
  content:
305
  application/json:
306
  schema:
307
  type: object
308
  properties:
309
  message:
310
  type: string
311
  example: 'You are not allowed to access this application.'
312
  /applications/{applicationId}/approve:
313
  put:
314
  summary: Approve a creation/redemption application
315
  parameters:
316
  - $ref: '#/components/parameters/applicationId'
317
  description: |
318
  Approve an application from market maker or AP.
319
  APs can only approve applications with the status 'ApplicationInProcessAP'.
320
  AMs can only approve applications with the status 'ApplicationInProcessAM'.
321
  operationId: approveApplication
322
  tags:
323
  - applications
324
  responses:
325
  '200':
326
  description: Success operation
327
  '400':
328
  description: 'Bad Request'
329
  content:
330
  application/json:
331
  schema:
332
  type: object
333
  properties:
334
  message:
335
  type: string
336
  enum:
337
  - This approval is not available for this application ID.
338
  - This application cannot be approved because it has exceeded the cut-off.
339
  example: 'This approval is not available for this application ID.'
340
  '403':
341
  description: 'Forbidden'
342
  content:
343
  application/json:
344
  schema:
345
  type: object
346
  properties:
347
  message:
348
  type: string
349
  enum:
350
  - You are not allowed to access this application.
351
  - You are not allowed to access this endpoint.
352
  example: 'You are not allowed to access this application.'
353
  /applications/{applicationId}/deny:
354
  put:
355
  summary: Deny a creation/redemption application
356
  parameters:
357
  - $ref: '#/components/parameters/applicationId'
358
  description: |
359
  Deny an application from market maker or AP.
360
  APs can only deny applications with the status 'ApplicationInProcessAP'.
361
  AMs can only deny applications with the status 'ApplicationInProcessAM'.
362
  operationId: denyApplication
363
  tags:
364
  - applications
365
  responses:
366
  '200':
367
  description: Success operation
368
  '400':
369
  description: 'Bad Request'
370
  content:
371
  application/json:
372
  schema:
373
  type: object
374
  properties:
375
  message:
376
  type: string
377
  example: 'This denial is not available for this application ID.'
378
  '403':
379
  description: 'Forbidden'
380
  content:
381
  application/json:
382
  schema:
383
  type: object
384
  properties:
385
  message:
386
  type: string
387
  enum:
388
  - You are not allowed to access this application.
389
  - You are not allowed to access this endpoint.
390
  example: 'You are not allowed to access this application.'
391
  /applications/{applicationId}/approveCancellationRequest:
392
  put:
393
  summary: Approve a cancellation request
394
  parameters:
395
  - $ref: '#/components/parameters/applicationId'
396
  description: |
397
  Approve a cancellation request from market maker or AP.
398
  APs can only approve applications with the status 'CancelRequestInProcessAP'.
399
  AMs can only approve applications with the status 'CancelRequestInProcessAM'.
400
  operationId: approveCancellationRequest
401
  tags:
402
  - applications
403
  responses:
404
  '200':
405
  description: Success operation
406
  '400':
407
  description: 'Bad Request'
408
  content:
409
  application/json:
410
  schema:
411
  type: object
412
  properties:
413
  message:
414
  type: string
415
  example: 'This approval is not available for this application ID.'
416
  '403':
417
  description: 'Forbidden'
418
  content:
419
  application/json:
420
  schema:
421
  type: object
422
  properties:
423
  message:
424
  type: string
425
  enum:
426
  - You are not allowed to access this application.
427
  - You are not allowed to access this endpoint.
428
  example: 'You are not allowed to access this application.'
429
  /applications/{applicationId}/denyCancellationRequest:
430
  put:
431
  summary: Deny a cancellation request
432
  parameters:
433
  - $ref: '#/components/parameters/applicationId'
434
  description: |
435
  Deny a cancellation request from market maker or AP.
436
  APs can only deny applications with the status 'CancelRequestInProcessAP'.
437
  AMs can only deny applications with the status 'CancelRequestInProcessAM'.
438
  operationId: denyCancellationRequest
439
  tags:
440
  - applications
441
  responses:
442
  '200':
443
  description: Success operation
444
  '400':
445
  description: 'Bad Request'
446
  content:
447
  application/json:
448
  schema:
449
  type: object
450
  properties:
451
  message:
452
  type: string
453
  example: 'This denial is not available for this application ID.'
454
  '403':
455
  description: 'Forbidden'
456
  content:
457
  application/json:
458
  schema:
459
  type: object
460
  properties:
461
  message:
462
  type: string
463
  enum:
464
  - You are not allowed to access this application.
465
  - You are not allowed to access this endpoint.
466
  example: 'You are not allowed to access this application.'
467
  /applications/{applicationId}/cancellationRequest:
468
  put:
469
  summary: Request APs to cancel an application
470
  parameters:
471
  - $ref: '#/components/parameters/applicationId'
472
  description: 'Request APs to cancel a registered application.'
473
  operationId: cancellationRequest
474
  tags:
475
  - applications
476
  responses:
477
  '200':
478
  description: Success operation
479
  '400':
480
  description: 'Bad Request'
481
  content:
482
  application/json:
483
  schema:
484
  type: object
485
  properties:
486
  message:
487
  type: string
488
  enum:
489
  - Cancellation is not available for this application ID.
490
  - Cut-off time for this ETF fund has already elapsed.
491
  example: 'Cancellation is not available for this application ID.'
492
  '403':
493
  description: 'Forbidden'
494
  content:
495
  application/json:
496
  schema:
497
  type: object
498
  properties:
499
  message:
500
  type: string
501
  enum:
502
  - You are not allowed to access this application.
503
  - You are not allowed to access this endpoint.
504
  example: 'You are not allowed to access this application.'
505
  /statements/{applicationId}:
506
  get:
507
  summary: Get statement data
508
  description: Get statement data. The layout of the response body differs between cash statements and in-kind statements.
509
  operationId: getStatement
510
  parameters:
511
  - $ref: '#/components/parameters/applicationId'
512
  tags:
513
  - applications
514
  responses:
515
  '200':
516
  description: Success operation
517
  content:
518
  application/json:
519
  schema:
520
  $ref: '#/components/schemas/Statements'
521
  '400':
522
  description: 'Bad Request'
523
  content:
524
  application/json:
525
  schema:
526
  type: object
527
  properties:
528
  message:
529
  type: string
530
  example: 'This request is not available for this application ID.'
531
  '403':
532
  description: 'Forbidden'
533
  content:
534
  application/json:
535
  schema:
536
  type: object
537
  properties:
538
  message:
539
  type: string
540
  example: 'You are not allowed to access this application.'
541
  /issues:
542
  patch:
543
  summary: Update issue details
544
  description: |
545
  Partially update issue details. AM can modify the order unit and minimum number of shares of its own issue.
546
  Fields not included in the request body will remain unchanged.
547
  operationId: UpdateIssueDetails
548
  tags:
549
  - information
550
  requestBody:
551
  required: true
552
  content:
553
  application/json:
554
  schema:
555
  type: object
556
  properties:
557
  issues:
558
  type: array
559
  items:
560
  type: object
561
  properties:
562
  etfCode:
563
  type: string
564
  description: ETF fund code. 5-digit alphanumeric character.
565
  example: '12340'
566
  creation:
567
  type: object
568
  properties:
569
  orderUnit:
570
  type: integer
571
+ format: int64
572
  description: Order unit in case of creation. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
573
  example: 10000
574
  minimumNumberOfShares:
575
  type: integer
576
+ format: int64
577
  description: Minimum number of shares in case of creation. If it is 30000, applicants can request in quantities of 30,000 or more.
578
  example: 30000
579
  redemption:
580
  type: object
581
  properties:
582
  orderUnit:
583
  type: integer
584
+ format: int64
585
  description: Order unit in case of redemption. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
586
  example: 10000
587
  minimumNumberOfShares:
588
  type: integer
589
+ format: int64
590
  description: Minimum number of shares in case of redemption. If it is 30000, applicants can request in quantities of 30,000 or more.
591
  example: 30000
592
  responses:
593
  '200':
594
  description: Success operation
595
  content:
596
  application/json:
597
  schema:
598
  $ref: '#/components/schemas/Issues'
599
  '400':
600
  description: 'Bad Request'
601
  content:
602
  application/json:
603
  schema:
604
  type: object
605
  properties:
606
  message:
607
  type: string
608
  enum:
609
  - The request body does not match the required JSON schema.
610
  - "'etfCode' must be 5 characters long and contain only uppercase letters (A–Z) and digits (0–9)."
611
  - "'orderUnit' must be an integer greater than 0."
612
  - "The 'orderUnit' exceeds 15 digits. Please re-specify 'orderUnit'."
613
  - "'minimumNumberOfShares' must be an integer greater than 0."
614
  - "The 'minimumNumberOfShares' exceeds 15 digits. Please re-specify 'minimumNumberOfShares'."
615
  example: 'The request body does not match the required JSON schema.'
616
  '403':
617
  description: 'Forbidden'
618
  content:
619
  application/json:
620
  schema:
621
  type: object
622
  properties:
623
  message:
624
  type: string
625
  example: 'You are not allowed to access this issue.'
626
  get:
627
  summary: Get basic information of each issue
628
  description: Get basic information of each issue.
629
  operationId: getIssueInfo
630
  tags:
631
  - information
632
  responses:
633
  '200':
634
  description: Success operation
635
  content:
636
  application/json:
637
  schema:
638
  $ref: '#/components/schemas/Issues'
639
  /issues/blackout:
640
  get:
641
  summary: Get blackout dates of each issue
642
  description: Get blackout dates of each issue.
643
  operationId: getBlackoutCalendar
644
  tags:
645
  - information
646
  responses:
647
  '200':
648
  description: Success operation
649
  content:
650
  application/json:
651
  schema:
652
  type: object
653
  properties:
654
  issues:
655
  type: array
656
  items:
657
  $ref: '#/components/schemas/Blackout'
658
  /pcf:
659
  get:
660
  summary: Get PCF list
661
  description: |
662
  Get PCF list includes only those whose `expirationDate` is today or later.
663
 
664
  If you want to retrieve the component stocks of a PCF, please request to `/pcf/{pcfNumber}`.
665
 
666
  By setting query parameters `isToday` and `enabledStatus` to true,
667
  you can retrieve all PCFs that are available for application today(based on JST).
668
  operationId: getPcf
669
  tags:
670
  - information
671
  parameters:
672
  - name: isToday
673
  in: query
674
  description: Retrieve only PCFs for which the today date (based on JST) is between effectiveDate and expirationDate.
675
  required: false
676
  schema:
677
  type: boolean
678
  default: true
679
  - name: enabledStatus
680
  in: query
681
  description: |
682
  Retrieve PCFs filtered by their enabled status.
683
  If `enabled`, only PCFs whose `isEnabled` value is true are retrieved.
684
  If `disabled`, only PCFs whose `isEnabled` value is false are retrieved.
685
  If `both` or not specified, PCFs with both true and false values for `isEnabled` are returned.
686
  required: false
687
  schema:
688
  type: string
689
  enum:
690
  - enabled
691
  - disabled
692
  - both
693
  default: both
694
  - name: etfCode
695
  in: query
696
  description: Retrieve only PCFs linked to the specified ETF. If not specified, all ETFs are returned.
697
  required: false
698
  schema:
699
  type: string
700
  responses:
701
  '200':
702
  description: Success operation
703
  content:
704
  application/json:
705
  schema:
706
  type: object
707
  properties:
708
  pcf:
709
  type: array
710
  items:
711
  $ref: '#/components/schemas/pcfHeader'
712
  '400':
713
  description: 'Bad Request'
714
  content:
715
  application/json:
716
  schema:
717
  type: object
718
  properties:
719
  message:
720
  type: string
721
  enum:
722
  - This value of the query parameter is incorrect.
723
  - "The query parameter 'etfCode' must be specified as a 5-digit value."
724
  example: 'This value of the query parameter is incorrect.'
725
  /pcf/{pcfNumber}:
726
  get:
727
  summary: Get PCF by specifying PCF number
728
  description: Get PCF by specifying PCF number.
729
  operationId: getPcfByPcfNumber
730
  tags:
731
  - information
732
  parameters:
733
  - name: pcfNumber
734
  in: path
735
  required: true
736
  description: PCF number. 16-digit alphanumeric character.
737
  schema:
738
  type: string
739
  example: 'P180125C13060001'
740
  responses:
741
  '200':
742
  description: Success operation
743
  content:
744
  application/json:
745
  schema:
746
  $ref: '#/components/schemas/pcfIncludingComponentStocks'
747
  '404':
748
  description: Not Found
749
  content:
750
  application/json:
751
  schema:
752
  type: object
753
  properties:
754
  message:
755
  type: string
756
  example: "'pcfNumber' is incorrect."
757
+ /businessDays:
758
+ get:
759
+ summary: Get business days
760
+ description: |
761
+ Get the list of business days registered on this service in ascending order.
762
+
763
+ Business days are days on which this service is available (excluding weekends, Japanese public holidays, and other non-business days).
764
+
765
+ The response contains business days from the first day of the previous month of the request date (JST) up to the latest future business day registered on this service.
766
+ operationId: getBusinessDays
767
+ tags:
768
+ - information
769
+ responses:
770
+ '200':
771
+ description: Success operation
772
+ content:
773
+ application/json:
774
+ schema:
775
+ type: object
776
+ properties:
777
+ businessDays:
778
+ type: array
779
+ description: List of business days in ascending order.
780
+ items:
781
+ type: string
782
+ format: date
783
+ example:
784
+ - '2025-05-01'
785
+ - '2025-05-02'
786
+ - '2025-05-07'
787
+ - '2025-05-08'
788
+ - '2025-05-09'
789
+ - '2025-06-02'
790
+ - '2025-06-03'
791
+ - '2025-06-04'
792
+ - '2025-06-05'
793
+ - '2025-06-06'
794
+ - '2025-06-09'
795
+ - '2025-06-30'
796
+ - '2025-07-01'
797
+ - '2025-07-31'
798
  security:
799
  - ApiKeyAuth: []
800
  components:
801
  securitySchemes:
802
  ApiKeyAuth:
803
  type: apiKey
804
  in: header
805
  name: X-API-KEY
806
  schemas:
807
  Application:
808
  allOf:
809
  - type: object
810
  required:
811
  - applicationDate
812
  - apCode
813
  - etfCode
814
  - creationOrRedemption
815
  properties:
816
  applicationDate:
817
  type: string
818
  format: date
819
  description: Application date
820
  example: '2025-04-15'
821
  apCode:
822
  type: string
823
  description: AP code. 5-digit number.
824
  example: '12345'
825
  etfCode:
826
  type: string
827
  description: ETFfund code. 5-digit alphanumeric character.
828
  example: '12340'
829
  creationOrRedemption:
830
  type: string
831
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
832
  example: 'C'
833
  codesOfTreasuryStock:
834
  description: |
835
  Array of Treasury Stock Codes.
836
  type: array
837
  minItems: 0
838
  maxItems: 5
839
  items:
840
  type: string
841
  example: '12340'
842
  description: 5-digit code of treasury stock.
843
  excludeTreasuryStockIfNotInPcf:
844
  description: |
845
  This parameter specifies the behavior when the specified treasury stock codes are not included in the PCF basket.
846
  It specifies whether to exclude treasury stocks not included in the PCF basket before registering the application.
847
 
848
  If the value is `false`, and any of the specified treasury stocks are not included in the PCF basket, the application registration will fail with an error.
849
  If the value is `true`, the application registration will succeed after excluding from the specified treasury stocks those not included in the PCF.
850
 
851
  For application requests for in-cash ETFs or in-kind ETFs without a specified PCF, no validation is performed to check whether the treasury stocks are included in the PCF basket.
852
  In this case, the application registration will always succeed, regardless of the parameter value.
853
  type: boolean
854
  default: false
855
 
856
  custom:
857
  type: array
858
  description: |
859
  Custom fields for extensibility.
860
  All values are visible to applicants, AP and AM.
861
  minItems: 9
862
  maxItems: 9
863
  items:
864
  type: object
865
  properties:
866
  position:
867
  type: integer
868
+ format: int32
869
  description: Position is used to identify the field number
870
  minimum: 1
871
  maximum: 9
872
  example: 1
873
  value:
874
  type: string
875
  description: The value for this custom field
876
  example: "CUSTOM_VALUE_001"
877
  required:
878
  - position
879
  - value
880
  example:
881
  - position: 1
882
  value: "Trading Account ABC"
883
  - position: 2
884
  value: "Reference-2025-001"
885
  notes:
886
  type: string
887
  description: Notes from applicants to AP and AM.
888
  example: 'string'
889
  isClearing:
890
  type: boolean
891
  description: |
892
  Cleared by JSCC or non-cleared. false:non-cleared true:cleared.
893
 
894
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
895
  The value set depends on `clearingType` of the issue being applied for.
896
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
897
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
898
  example: true
899
  - oneOf:
900
  - type: object
901
  required:
902
  - numberOfShares
903
  properties:
904
  numberOfShares:
905
  type: integer
906
  description: |
907
  Number of shares.
908
  Required when PCF number is NOT specified.
909
  Cannot be used together with numberOfUnits.
910
  example: 10000
911
  format: int64
912
  - type: object
913
  required:
914
  - pcfNumber
915
  - numberOfUnits
916
  properties:
917
  pcfNumber:
918
  type: string
919
  description: PCF number. 16-digit alphanumeric character.
920
  example: 'P180125C13060001'
921
  numberOfUnits:
922
  type: integer
923
  description: |
924
  Number of Units.
925
  Required when PCF number is specified.
926
  Cannot be used together with numberOfShares.
927
  example: 10
928
  format: int64
929
  ApplicationInfo:
930
  type: object
931
  properties:
932
  status:
933
  type: string
934
  enum:
935
  - "ApplicationInProcessAP"
936
  - "ApplicationInProcessAM"
937
  - "Accepted"
938
  - "StatementInProcessTB"
939
  - "StatementReturnedForRevisionAM"
940
  - "StatementFixed"
941
  - "CancelRequestInProcessAP"
942
  - "CancelRequestInProcessAM"
943
  - "Canceled"
944
  example: "ApplicationInProcessAP"
945
  description: Application status at the time.
946
  applicationDate:
947
  type: string
948
  format: date
949
  description: Application date
950
  example: '2025-04-15'
951
  mmCode:
952
  type: string
953
  example: '12345'
954
  description: |
955
  MM code.
956
  5-digit number.
957
  This value is visible to MM and AP(Agency).
958
  This value is always null in the case of a request from AP(Prop) or AM.
959
  apCode:
960
  type: string
961
  description: AP code. 5-digit number.
962
  example: '12345'
963
  etfCode:
964
  type: string
965
  description: ETF fund code. 5-digit alphanumeric character.
966
  example: '12340'
967
  inKindOrInCash:
968
  type: string
969
  description: Specify in-kind or in-cash.
970
  example: 'InKindCreationInKindRedemption'
971
  enum:
972
  - CashCreationCashRedemption
973
  - InKindCreationInKindRedemption
974
  creationOrRedemption:
975
  type: string
976
  description: Creation or Redemption. 'C':Creation 'R':Redemption
977
  example: 'C'
978
  isClearing:
979
  type: boolean
980
  description: |
981
  Cleared by JSCC or non-cleared. false:non-cleared true:cleared.
982
  example: false
983
  numberOfShares:
984
  type: integer
985
  description: |
986
  Number of shares.
987
  If PCF number is specified, the estimated number of shares is set.
988
  The estimated number of shares is calculated as the PCF’s `estimatedNumberOfSharesPerUnit` multiplied by `numberOfUnits`.
989
  If no PCF number is specified, the number of shares specified by the applicant is set.
990
  example: 123456
991
  format: int64
992
  pcfNumber:
993
  type: string
994
  nullable: true
995
  description: PCF number. 16-digit alphanumeric character. If PCF number is not specified, this field is null.
996
  example: 'P180125C13060001'
997
  numberOfUnits:
998
  type: integer
999
  nullable: true
1000
  description: |
1001
  Number of Units.
1002
  If PCF number is not specified, this field is null.
1003
  example: 10
1004
  format: int64
1005
  jasdecAccountInformation:
1006
  type: string
1007
  example: '1234567'
1008
  description: JASDEC account information. 7-digit number.
1009
  navPerShareCalculationDate:
1010
  type: string
1011
  format: date
1012
  example: '2025-05-29'
1013
  description: NAV per share calculation date.
1014
  statementFixingDate:
1015
  type: string
1016
  format: date
1017
  example: '2025-05-29'
1018
  description: Statement fixing date.
1019
  trustEstablishmentOrCancellationDate:
1020
  type: string
1021
  format: date
1022
  example: '2025-05-30'
1023
  description: Trust establishment or cancellation date.
1024
  settlementDate:
1025
  type: string
1026
  format: date
1027
  example: '2025-05-31'
1028
  description: Settlement date.
1029
  dvpClearingPrice:
1030
  type: string
1031
  example: ''
1032
  description: |
1033
  DVP clearing price. Used only if an application is in cash ETF and cleared.
1034
  codesOfTreasuryStock:
1035
  description: |
1036
  Array of Treasury Stock Codes.
1037
  type: array
1038
  minItems: 0
1039
  maxItems: 5
1040
  items:
1041
  type: string
1042
  example: '12340'
1043
  description: 5-digit code of treasury stock.
1044
  custom:
1045
  type: array
1046
  description: |
1047
  Custom fields for extensibility.
1048
  All values are visible to applicants, AP and AM.
1049
  minItems: 9
1050
  maxItems: 9
1051
  items:
1052
  type: object
1053
  properties:
1054
  position:
1055
  type: integer
1056
+ format: int32
1057
  description: Position is used to identify the field number
1058
  minimum: 1
1059
  maximum: 9
1060
  example: 1
1061
  value:
1062
  type: string
1063
  description: The value for this custom field
1064
  example: "CUSTOM_VALUE_001"
1065
  required:
1066
  - position
1067
  - value
1068
  example:
1069
  - position: 1
1070
  value: "Trading Account ABC"
1071
  - position: 2
1072
  value: "Reference-2025-001"
1073
  - position: 3
1074
  value: ""
1075
  - position: 4
1076
  value: ""
1077
  - position: 5
1078
  value: ""
1079
  - position: 6
1080
  value: ""
1081
  - position: 7
1082
  value: ""
1083
  - position: 8
1084
  value: ""
1085
  - position: 9
1086
  value: ""
1087
  notes:
1088
  type: string
1089
  description: Notes from applicants to AP and AM.
1090
  example: 'string'
1091
  createdAt:
1092
  type: string
1093
+ format: date-time
1094
  example: '2025-04-15T12:34:56+09:00'
1095
  description: The time when the applicant registered this application.
1096
  Issues:
1097
  type: object
1098
  properties:
1099
  issues:
1100
  type: array
1101
  items:
1102
  type: object
1103
  properties:
1104
  etfCode:
1105
  type: string
1106
  description: ETF fund code. 5-digit alphanumeric character.
1107
  example: '12340'
1108
  inKindOrInCash:
1109
  type: string
1110
  description: Specify in-kind or in-cash.
1111
  example: 'CashCreationCashRedemption'
1112
  enum:
1113
  - CashCreationCashRedemption
1114
  - InKindCreationInKindRedemption
1115
  etfNameJa:
1116
  type: string
1117
  description: ETF fund name in Japanese.
1118
  example: 'XXX ファンド'
1119
  etfNameEn:
1120
  type: string
1121
  description: ETF fund name in English.
1122
  example: 'XXX fund'
1123
  cutoffTimeIncludingTreasuryStock:
1124
  type: string
1125
  description: Cut-off time (JST) for cases where the treasury stock of AP is included in the basket. This item is omitted for cash ETF.
1126
  example: '14:30'
1127
  cutoffTimeExcludingTreasuryStock:
1128
  type: string
1129
  description: Cut-off time (JST) for cases where the treasury stock of AP is not included in the basket. All cut-off time for in cash ETF funds are placed in this field.
1130
  example: '15:30'
1131
  creation:
1132
  type: object
1133
  properties:
1134
  clearingType:
1135
  type: string
1136
  enum:
1137
  - Clearing
1138
  - Non-Clearing
1139
  - Selectable
1140
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
1141
  example: 'Clearing'
1142
  schedule:
1143
  type: object
1144
  properties:
1145
  clearing:
1146
  $ref: "#/components/schemas/CreationSchedule"
1147
  nonClearing:
1148
  $ref: "#/components/schemas/CreationSchedule"
1149
  example:
1150
  clearing:
1151
  navPerShareCalculationDate: 0
1152
  statementFixingDate: 1
1153
  trustEstablishmentDate: 2
1154
  settlementDate: 2
1155
  nonClearing: null
1156
  orderUnit:
1157
  type: integer
1158
+ format: int64
1159
  description: Order unit in case of creation. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
1160
  example: 10000
1161
  minimumNumberOfShares:
1162
  type: integer
1163
+ format: int64
1164
  description: Minimum number of shares in case of creation. If it is 30000, applicants can request in quantities of 30,000 or more.
1165
  example: 30000
1166
  redemption:
1167
  type: object
1168
  properties:
1169
  clearingType:
1170
  type: string
1171
  enum:
1172
  - Clearing
1173
  - Non-Clearing
1174
  - Selectable
1175
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
1176
  example: 'Selectable'
1177
  schedule:
1178
  type: object
1179
  properties:
1180
  clearing:
1181
  $ref: "#/components/schemas/RedemptionSchedule"
1182
  nonClearing:
1183
  $ref: "#/components/schemas/RedemptionSchedule"
1184
  example:
1185
  clearing:
1186
  navPerShareCalculationDate: 0
1187
  statementFixingDate: 1
1188
  trustCancellationDate: 2
1189
  settlementDate: 2
1190
  nonClearing:
1191
  navPerShareCalculationDate: 0
1192
  statementFixingDate: 1
1193
  trustCancellationDate: 2
1194
  settlementDate: 2
1195
  orderUnit:
1196
  type: integer
1197
+ format: int64
1198
  description: Order unit in case of redemption. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
1199
  example: 10000
1200
  minimumNumberOfShares:
1201
  type: integer
1202
+ format: int64
1203
  description: Minimum number of shares in case of redemption. If it is 30000, applicants can request in quantities of 30,000 or more.
1204
  example: 30000
1205
  customInputAllowed:
1206
  type: boolean
1207
  description: |
1208
  If true, applicants can specify any value in the optional custom fields when registering an application.
1209
  If false, applicants cannot use the optional custom fields, and all applications will have these fields left blank.
1210
  example: true
1211
  earlyRedemptionClause:
1212
  type: integer
1213
+ format: int64
1214
  description: The number of early redemption shares specified in the terms and conditions of an investment trust for each fund. This is an optional field.
1215
  example: 100000
1216
  issuersOptionalFundCode:
1217
  type: string
1218
  description: Fund code used by the issuer to identify the fund internally. This is an optional field.
1219
  example: 'ABCD1234'
1220
  isinCode:
1221
  type: string
1222
  description: ISIN code. 12-digit alphanumeric character.
1223
  example: 'JP1234567890'
1224
  amCode:
1225
  type: string
1226
  description: AM code. 5-digit number.
1227
  example: '00123'
1228
  amNameJa:
1229
  type: string
1230
  description: AM name in Japanese.
1231
  example: 'XXX アセットマネジメント'
1232
  amNameEn:
1233
  type: string
1234
  description: AM name in English.
1235
  example: 'XXX Asset Management'
1236
  tbCode:
1237
  type: string
1238
  description: TB code. 5-digit number.
1239
  example: '00001'
1240
  tbNameJa:
1241
  type: string
1242
  description: TB name in Japanese.
1243
  example: 'XXX 信託銀行'
1244
  tbNameEn:
1245
  type: string
1246
  description: TB name in English.
1247
  example: 'XXX Trust Bank Co., Ltd.'
1248
  handlingPeriodFrom:
1249
  type: string
1250
+ format: date
1251
  description: Start date of available period for handling.
1252
  example: '2024-12-03'
1253
  handlingPeriodTo:
1254
  type: string
1255
+ format: date
1256
  description: End date of available period for handling. If it is null, the end date is undecided.
1257
  example: '2025-09-21'
1258
  DateList:
1259
  type: array
1260
  items:
1261
  type: string
1262
  format: date
1263
  example: '1992-12-02'
1264
  Blackout:
1265
  type: object
1266
  properties:
1267
  etfCode:
1268
  type: string
1269
  example: '12340'
1270
  creationBlackoutDates:
1271
  type: array
1272
  items:
1273
  type: string
1274
  format: date
1275
  example: '1992-12-02'
1276
  redemptionBlackoutDates:
1277
  type: array
1278
  items:
1279
  type: string
1280
  format: date
1281
  example: '1992-12-02'
1282
  Statements:
1283
  oneOf:
1284
  - $ref: '#/components/schemas/InKindStatements'
1285
  - $ref: '#/components/schemas/CashStatements'
1286
  discriminator:
1287
  propertyName: inKindOrInCash
1288
  mapping:
1289
  InKindCreationInKindRedemption: '#/components/schemas/InKindStatements'
1290
  CashCreationCashRedemption: '#/components/schemas/CashStatements'
1291
  pcfHeader:
1292
  type: object
1293
  properties:
1294
  pcfNumber:
1295
  type: string
1296
  description: PCF number. 16-digit alphanumeric character.
1297
  example: "1234567890123456"
1298
  createdAt:
1299
  type: string
1300
+ format: date-time
1301
  description: The date and time this PCF was registered by AM.
1302
  example: "2025-11-14T14:33:00+09:00"
1303
  am:
1304
  type: object
1305
  description: Asset Management information.
1306
  properties:
1307
  code:
1308
  type: string
1309
  description: AM code. 5-digit number.
1310
  example: "00123"
1311
  nameJa:
1312
  type: string
1313
  description: AM name in Japanese.
1314
  example: "XXX アセットマネジメント"
1315
  nameEn:
1316
  type: string
1317
  description: AM name in English.
1318
  example: "XXX Asset Management"
1319
  fileName:
1320
  type: string
1321
  description: The file name of this PCF registered by AM, including the file extension.
1322
  example: "Basket1.csv"
1323
  etf:
1324
  type: object
1325
  description: ETF fund information.
1326
  properties:
1327
  code:
1328
  type: string
1329
  description: ETF fund code. 5-digit alphanumeric character.
1330
  example: "12340"
1331
  isinCode:
1332
  type: string
1333
  description: ISIN code. 12-digit alphanumeric character.
1334
  example: "JP1234567890"
1335
  nameJa:
1336
  type: string
1337
  description: ETF fund name in Japanese.
1338
  example: "XXX ファンド"
1339
  nameEn:
1340
  type: string
1341
  description: ETF fund name in English.
1342
  example: "XXX fund"
1343
  creationOrRedemption:
1344
  type: string
1345
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
1346
  example: "C"
1347
  estimatedNumberOfSharesPerUnit:
1348
  type: integer
1349
+ format: int64
1350
  description: Estimated number of ETF shares per 1 unit.
1351
  example: 123456789012345
1352
  basketName:
1353
  type: string
1354
  description: Basket name of this PCF registered by AM.
1355
  isEnabled:
1356
  type: boolean
1357
  description: |
1358
  This flag indicates whether this PCF can be specified at the time of application for creation or redemption.
1359
  If true, applications specifying this PCF are allowed.
1360
  If false, either the validity period has expired or this PCF has been invalidated by AM,
1361
  and applications specifying this PCF are not allowed.
1362
  example: true
1363
  effectiveDate:
1364
  type: string
1365
  format: date
1366
  description: Effective date of this PCF.
1367
  example: "2025-11-12"
1368
  expirationDate:
1369
  type: string
1370
  format: date
1371
  description: Expiration date of this PCF.
1372
  example: "2025-11-14"
1373
  optionalInputItem:
1374
  type: array
1375
  minItems: 5
1376
  maxItems: 5
1377
  items:
1378
  type: object
1379
  properties:
1380
  position:
1381
  type: integer
1382
+ format: int32
1383
  description: Position is used to identify the field number
1384
  minimum: 1
1385
  maximum: 5
1386
  example: 1
1387
  name:
1388
  type: string
1389
  content:
1390
  type: string
1391
  example:
1392
  - position: 1
1393
  name: "Name1"
1394
  content: "Content1"
1395
  - position: 2
1396
  name: "Name2"
1397
  content: "Content2"
1398
  - position: 3
1399
  name: ""
1400
  content: ""
1401
  - position: 4
1402
  name: ""
1403
  content: ""
1404
  - position: 5
1405
  name: ""
1406
  content: ""
1407
  notes:
1408
  type: string
1409
  description: Notes.
1410
  example: "string"
1411
  pcfIncludingComponentStocks:
1412
  allOf:
1413
  - $ref: '#/components/schemas/pcfHeader'
1414
  - type: object
1415
  properties:
1416
  componentStocks:
1417
  type: array
1418
  description: Component Stocks.
1419
  items:
1420
  type: object
1421
  properties:
1422
  code:
1423
  type: string
1424
  description: Issue Code.
1425
  example: "12340"
1426
  isinCode:
1427
  type: string
1428
  description: ISIN Code.
1429
  example: "JP1111111111"
1430
  name:
1431
  type: string
1432
  description: Issue Name.
1433
  example: "XXX 株式"
1434
  cashSettledIssueType:
1435
  type: string
1436
  enum:
1437
  - applicable
1438
  - notApplicable
1439
  - unspecified
1440
  description: |
1441
  The flag when an individual component stock is applicable for cash settlement.<br>
1442
  notApplicable: Not applicable for cash settlement<br>
1443
  applicable: Applicable for cash settlement<br>
1444
  unspecified: Unspecified by AM
1445
  example: applicable
1446
  numberOfShares:
1447
  type: integer
1448
+ format: int64
1449
  nullable: true
1450
  description: Number of Shares.
1451
  example: 123456789012345
1452
  notes:
1453
  type: string
1454
  description: Individual Issue Optional Input Item.
1455
  example: "notes"
1456
  StatementsBase:
1457
  type: object
1458
  properties:
1459
  inKindOrInCash:
1460
  type: string
1461
  description: Specify in-kind or in-cash.
1462
  example: 'InKindCreationInKindRedemption'
1463
  applicationId:
1464
  type: string
1465
  example: '2024123100010001'
1466
  description: Application ID
1467
  pcfNumber:
1468
  type: string
1469
  example: '1234567890123456'
1470
  description: PCF number. 16-digit alphanumeric character.
1471
  amCode:
1472
  type: string
1473
  example: '00123'
1474
  description: AM code. 5-digit number.
1475
  amNameJa:
1476
  type: string
1477
  example: 'XXX アセットマネジメント'
1478
  description: AM name in Japanese.
1479
  amNameEn:
1480
  type: string
1481
  example: 'XXX Asset Management'
1482
  description: AM name in English.
1483
  userId:
1484
  type: string
1485
  example: 'XXX@crednex.co.jp'
1486
  default: User ID that registered this statement as AM
1487
  apCode:
1488
  type: string
1489
  example: '00012'
1490
  description: AP code. 5-digit number.
1491
  apNameJa:
1492
  type: string
1493
  example: 'XXX 証券'
1494
  description: AP Name in Japanese.
1495
  apNameEn:
1496
  type: string
1497
  example: 'XXX Securities Co., Ltd.'
1498
  description: AP Name in English.
1499
  etfCode:
1500
  type: string
1501
  example: '12340'
1502
  description: ETF fund code. 5-digit alphanumeric character.
1503
  etfISINCode:
1504
  type: string
1505
  example: 'JP0000000000'
1506
  description: ISIN code. 10-digit number.
1507
  etfNameJa:
1508
  type: string
1509
  example: 'XXX ファンド'
1510
  description: ETF fund name in Japanese.
1511
  etfNameEn:
1512
  type: string
1513
  example: 'XXX fund'
1514
  description: ETF fund name in English.
1515
  creationOrRedemption:
1516
  type: string
1517
  example: 'C'
1518
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
1519
  tbCode:
1520
  type: string
1521
  example: '00001'
1522
  description: TB code. 5-digit number.
1523
  tbNameJa:
1524
  type: string
1525
  example: 'XXX 信託銀行'
1526
  description: TB name in Japanese.
1527
  tbNameEn:
1528
  type: string
1529
  example: 'XXX Trust Bank Co., Ltd.'
1530
  description: TB name in English.
1531
  navPerShareCalculationDate:
1532
  type: string
1533
  format: date
1534
  example: '2025-05-29'
1535
  description: NAV per share calculation date.
1536
  statementFixingDate:
1537
  type: string
1538
  format: date
1539
  example: '2025-05-29'
1540
  description: Statement fixing date.
1541
  settlementDate:
1542
  type: string
1543
  format: date
1544
  example: '2025-05-31'
1545
  description: Settlement date.
1546
  trustEstablishmentOrCancellationDate:
1547
  type: string
1548
  format: date
1549
  example: '2025-05-30'
1550
  description: Trust establishment or cancellation date.
1551
  etfNavPerShare:
1552
  type: string
1553
  example: '12345678901234.1234'
1554
  description: |
1555
  For an in-kind statement, this item is mandatory and represents the NAV per ETF share.
1556
  In a cash statement, this item may not be registered from the AM and the value may be left blank.
1557
  In that case, `etfPurchaseOrCancellationPrice` is a mandatory item from the AM and its value is stored.
1558
  If you need to reference the price, use the value of `etfPurchaseOrCancellationPrice`.
1559
  numberOfShares:
1560
  type: integer
1561
  example: 10000
1562
  format: int64
1563
  description: Number of shares the client ordered.
1564
  numberOfSharesOfNewRecordOrScheduledDeletion:
1565
  type: integer
1566
  example: 123456789012345
1567
  format: int64
1568
  description: The number of shares of new record or scheduled deletion.
1569
  etfNetAssetValue:
1570
  type: string
1571
  example: '12345678901234.1234'
1572
  description: ETF net asset value.
1573
  optionalInputItemName1:
1574
  type: string
1575
  description: Name of optional item.
1576
  optionalInputItemName2:
1577
  type: string
1578
  optionalInputItemContent2:
1579
  type: string
1580
  description: Contents of optional item.
1581
  optionalInputItemName3:
1582
  type: string
1583
  optionalInputItemContent3:
1584
  type: string
1585
  optionalInputItemName4:
1586
  type: string
1587
  optionalInputItemName5:
1588
  type: string
1589
  optionalInputItemName6:
1590
  type: string
1591
  optionalInputItemContent6:
1592
  type: string
1593
  optionalInputItemName7:
1594
  type: string
1595
  optionalInputItemContent7:
1596
  type: string
1597
  optionalInputItemName8:
1598
  type: string
1599
  optionalInputItemContent8:
1600
  type: string
1601
  optionalInputItemName9:
1602
  type: string
1603
  optionalInputItemContent9:
1604
  type: string
1605
  optionalInputItemName10:
1606
  type: string
1607
  optionalInputItemContent10:
1608
  type: string
1609
  notes:
1610
  type: string
1611
  description: Notices by AM for AP.
1612
  InKindStatements:
1613
  allOf:
1614
  - $ref: '#/components/schemas/StatementsBase'
1615
  - type: object
1616
  properties:
1617
  inKindOrInCash:
1618
  type: string
1619
  description: Specify in-kind or in-cash.
1620
  example: 'InKindCreationInKindRedemption'
1621
  enum:
1622
  - InKindCreationInKindRedemption
1623
  residualNumberOfEtfSharesToBeReturned:
1624
  type: integer
1625
  example: 10000
1626
  format: int64
1627
  description: Residual Number of ETF Shares to be Returned.
1628
  totalPaymentAmountInCreation:
1629
  type: integer
1630
  example: 10000
1631
  format: int64
1632
  description: Total Payment Amount in Creation.
1633
  basketValuation:
1634
  type: string
1635
  example: '12345678901234.1234'
1636
  description: Basket Valuation.
1637
  cashSettledIssues:
1638
  type: array
1639
  description: Cash-settled Issues.
1640
  minItems: 10
1641
  maxItems: 10
1642
  items:
1643
  type: object
1644
  properties:
1645
  position:
1646
  type: integer
1647
+ format: int32
1648
  description: Position is used to identify the field number
1649
  minimum: 1
1650
  maximum: 10
1651
  example: 1
1652
  code:
1653
  type: string
1654
  description: Cash-settled Issue Code.
1655
  example: "12340"
1656
  name:
1657
  type: string
1658
  description: Cash-settled Issue Name.
1659
  example: "XXX 株式"
1660
  numberOfShares:
1661
  type: integer
1662
  nullable: true
1663
  format: int64
1664
  description: Cash-settled Issue Quantity.
1665
  example: 123456789012345
1666
  valuationPrice:
1667
  type: string
1668
  description: Cash-settled Issue Valuation Price.
1669
  example: "12345678901234.1234"
1670
  totalAmount:
1671
  type: string
1672
  description: Cash-settled Issue Total Amount.
1673
  example: "12345678901234.1234"
1674
  required:
1675
  - position
1676
  example:
1677
  - position: 1
1678
  code: "12340"
1679
  name: "XXX 株式"
1680
  numberOfShares: 100000
1681
  valuationPrice: "12345678901234.1234"
1682
  totalAmount: "12345678901234.1234"
1683
  optionalInputItemContent1:
1684
  type: string
1685
  optionalInputItemContent4:
1686
  type: string
1687
  optionalInputItemContent5:
1688
  type: string
1689
  componentStocks:
1690
  type: array
1691
  description: Component Stocks.
1692
  items:
1693
  type: object
1694
  properties:
1695
  code:
1696
  type: string
1697
  description: Issue Code.
1698
  example: "12340"
1699
  isinCode:
1700
  type: string
1701
  description: ISIN Code.
1702
  example: "JP1111111111"
1703
  name:
1704
  type: string
1705
  description: Issue Name.
1706
  example: "XXX 株式"
1707
  numberOfShares:
1708
  type: integer
1709
  format: int64
1710
  description: Number of Shares.
1711
  example: 123456789012345
1712
  stockPrice:
1713
  type: string
1714
  description: Stock Price.
1715
  example: "12345678901234.1234"
1716
  individualIssueTotalMarketValue:
1717
  type: string
1718
  description: Individual Issue Total Market Value.
1719
  example: "12345678901234.1234"
1720
  notes:
1721
  type: string
1722
  description: Individual Issue Optional Input Item.
1723
  example: "string"
1724
  CashStatements:
1725
  allOf:
1726
  - $ref: '#/components/schemas/StatementsBase'
1727
  - type: object
1728
  properties:
1729
  inKindOrInCash:
1730
  type: string
1731
  description: Specify in-kind or in-cash.
1732
  example: 'CashCreationCashRedemption'
1733
  enum:
1734
  - CashCreationCashRedemption
1735
  etfPurchaseOrCancellationPrice:
1736
  type: string
1737
  example: '12345678901234.1234'
1738
  description: |
1739
  The price per ETF unit obtained by adding or subtracting execution costs (spreads) and other fees to or from the NAV per ETF unit is set.
1740
  In a cash statement, this is a mandatory item that must always be registered by the AM, and its value is stored.
1741
  When you need to reference the NAV in a cash statement, use this item.
1742
  executionCosts:
1743
  type: string
1744
  description: Execution cost of this creation/redemption for AP.
1745
  totalPaymentAmount:
1746
  type: string
1747
  example: '123456789012345678'
1748
  description: Total payment of this creation/redemption for AP.
1749
  statementType:
1750
  type: string
1751
  enum:
1752
  - 'CreatedByAM'
1753
  - 'CreatedByCredNex'
1754
  description: |
1755
  CreatedByAM: This statement is registered by AM, and transitions to 'StatementFixed' status by the deadline of the statement fixing date.
1756
 
1757
  CreatedByCredNex: This statement is automatically created by CredNex because the application for the statement transitions to 'Accepted', but does not transition to 'StatementFixed' status by the deadline of the statement fixing date.
1758
 
1759
  If the application is non-cleared, the return value for this item will be an empty string.
1760
  dvpSettlementPrice:
1761
  type: string
1762
  example: '12345678901234.1234'
1763
  description: DVP settlement price calculated on the application date. If the application is non-cleared, the return value for this item will be an empty string.
1764
 
1765
  BaseSchedule:
1766
  type: object
1767
  description: Schedule configuration depends on clearingType. For "Clearing", only clearing.schedule is set and nonClearing.schedule is null. For "Non-Clearing", only nonClearing.schedule is set and clearing.schedule is null. For "Selectable", both clearing.schedule and nonClearing.schedule are set.
1768
  nullable: true
1769
  properties:
1770
  navPerShareCalculationDate:
1771
  type: integer
1772
+ format: int32
1773
  description: NAV per share calculation date. It is counted from the trade date (dayT). If it is '0', T+0 is NAV per share calculation date.
1774
  example: 0
1775
  statementFixingDate:
1776
  type: integer
1777
+ format: int32
1778
  description: Statement fixing date. It is counted from the trade date (dayT).
1779
  example: 1
1780
  settlementDate:
1781
  type: integer
1782
+ format: int32
1783
  description: Settlement date. It is counted from the trade date (dayT).
1784
  example: 2
1785
  CreationSchedule:
1786
  allOf:
1787
  - $ref: "#/components/schemas/BaseSchedule"
1788
  - type: object
1789
  properties:
1790
  trustEstablishmentDate:
1791
  type: integer
1792
+ format: int32
1793
  description: Trust establishment date in case of creation. It is counted from the trade date (dayT).
1794
  example: 2
1795
  RedemptionSchedule:
1796
  allOf:
1797
  - $ref: "#/components/schemas/BaseSchedule"
1798
  - type: object
1799
  properties:
1800
  trustCancellationDate:
1801
  type: integer
1802
+ format: int32
1803
  description: Trust cancellation date in case of redemption. It is counted from the trade date (dayT).
1804
  example: 2
1805
  parameters:
1806
  applicationId:
1807
  name: applicationId
1808
  in: path
1809
  required: true
1810
  description: Application ID
1811
  schema:
1812
  type: string
1813
  example: '2024123100010001'
1814
  statementFixingDate:
1815
  name: statementFixingDate
1816
  in: query
1817
  required: false
1818
  description: Statement fixing date. Default is today (JST).
1819
  schema:
1820
  type: string
1821
  format: date
1822
  example: '2025-05-29'
1823
  tags:
1824
  - name: applications
1825
  description: Create/Approve creation/redemption applications
1826
  - name: information
1827
  description: Get information related to ETF creation/redemption operations