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