Search
K
MarketConnect-OrderEntry

Saves a comment against the specified transaction.

Saves a comment for the specified transaction and returns the upstream envelope including validation messages.

post

Body

application/json

The comment payload to save.

* Additional properties are NOT allowed.
appSubIndicatorstring | null

Indicator identifying whether the comment applies to the application or sub-application

commentSourcestring | null

Source system or user group that authored the comment

commentTextstringrequired

Free-form comment text

>= 1 characters

statusAtStepstring | null

Status code of the transaction at the step the comment was added

statusDisplayNamestring | null

Display name for the status at the step the comment was added

stepTitlestring | null

Title of the wizard step the comment was added on

transactionIdstringrequired

Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)

Match pattern:^[1-9][0-9]*$

>= 1 characters

Response

application/json

Returns the save comment envelope

SaveCommentResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction. Populated on successful saves.

isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)

post/market-connect/order-entry/v1/comments

Body

{ "appSubIndicator": "App", "commentSource": "OrderEntryUI", "commentText": "Customer requested a follow-up call before submission.", "statusAtStep": "InProgress", "statusDisplayName": "In Progress", "stepTitle": "Owner Information", "transactionId": "1125715" }
 
application/json

Deletes a comment from a transaction.

Deletes the specified comment from the transaction and returns the upstream envelope.

delete

Body

application/json

The comment and transaction identifiers for the comment to delete.

* Additional properties are NOT allowed.
commentIdstringrequired

Unique identifier of the comment to delete (positive integer encoded as a string)

Match pattern:^[1-9][0-9]*$

>= 1 characters

transactionIdstringrequired

Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)

Match pattern:^[1-9][0-9]*$

>= 1 characters

Response

application/json

Returns the delete comment envelope

DeleteCommentResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction. Populated on successful deletes.

isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)

delete/market-connect/order-entry/v1/comments

Body

{ "commentId": "54321", "transactionId": "1125715" }
 
application/json

Retrieves the comments for a transaction.

Returns the list of comments recorded against the specified transaction.

get

Query Parameters

pageinteger(int32)

1-based page number. Omit both page and pageSize to return all comments.

pageSizeinteger(int32)

Number of comments per page (1–100). Omit both page and pageSize to return all comments.

Path Parameters

transactionIdstringrequired

Unique identifier of the transaction (positive integer encoded as a string).

Response

application/json

Returns the comments envelope

GetCommentsResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction

dataobject

Comments data payload

* Additional properties are NOT allowed.
Show Child Parameters
isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation

get/market-connect/order-entry/v1/comments/{transactionId}
 
application/json

ProductPricing

Product pricing retrieval for a transaction

Retrieves the product pricing payload for a transaction.

Returns product pricing and fee schedules for the specified transaction.

Path parameter: transactionId (required) — resolves to the internal transaction; the caller must be authorized for this transaction.

Response envelope: caseId, transactionId, isSuccess, message, status, and optional data.

data (when isSuccess is true): flags (isApplicationTransaction, isVariableAnnuity, showMarketValueAdjustment, showNetManagementFee) plus productFees, featureFees, fundFees, surrenderCharges, and netManagementFees.

get

Path Parameters

transactionIdstringrequired

Unique identifier assigned when the Order Entry transaction is created. Resolves to the internal transaction; caller must be authorized for this transaction.

Example:1064752

Response

application/json

Returns the product pricing payload

ProductPricingResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction when pricing is found.

transactionIdstringrequired

Unique identifier for the Order Entry transaction.

>= 1 characters

dataobject

Fee schedules and product pricing detail; null when isSuccess is false.

Example:{"isApplicationTransaction":true,"isVariableAnnuity":true,"showMarketValueAdjustment":false,"showNetManagementFee":true,"productFees":[{"feeTypeLabel":"Base M&E charges:","feeName":"M&E","feeValue":"0.90%","isDefaultType":false},{"feeTypeLabel":"Annual Contract Amount:","feeName":"Contract fee","feeValue":"$120.00","isDefaultType":false}],"featureFees":[{"featureName":"Lifetime income rider","feeValues":["0.35%","$25 annual"],"riderModifiedChargeSchedule":[{"year":"1","charge":"2.00%"},{"year":"2","charge":"1.50%"}]}],"fundFees":[{"fundName":"Sample Index Fund","percentageDisplay":"0.85%","minPct":"0.50%","maxPct":"1.25%","amountDisplay":"","minAmt":"","maxAmt":"","isValueAdjusted":false}],"surrenderCharges":[{"year":"1","charge":"8%"},{"year":"2","charge":"7%"},{"year":"3","charge":"6%"}],"netManagementFees":[{"fundName":"Sample Index Fund","totalFeePercentage":"1.10%"}]}{"isApplicationTransaction":true,"isVariableAnnuity":true,"showMarketValueAdjustment":false,"showNetManagementFee":true,"productFees":[{"feeTypeLabel":"Base M&E charges:","feeName":"M&E","feeValue":"0.90%","isDefaultType":false},{"feeTypeLabel":"Annual Contract Amount:","feeName":"Contract fee","feeValue":"$120.00","isDefaultType":false}],"featureFees":[{"featureName":"Lifetime income rider","feeValues":["0.35%","$25 annual"],"riderModifiedChargeSchedule":[{"year":"1","charge":"2.00%"},{"year":"2","charge":"1.50%"}]}],"fundFees":[{"fundName":"Sample Index Fund","percentageDisplay":"0.85%","minPct":"0.50%","maxPct":"1.25%","amountDisplay":"","minAmt":"","maxAmt":"","isValueAdjusted":false}],"surrenderCharges":[{"year":"1","charge":"8%"},{"year":"2","charge":"7%"},{"year":"3","charge":"6%"}],"netManagementFees":[{"fundName":"Sample Index Fund","totalFeePercentage":"1.10%"}]}

* Additional properties are NOT allowed.
Show Child Parameters
isSuccessboolean

Whether the upstream product pricing call succeeded.

messagestring | null

Human-readable status message from the product pricing service.

statusstring | null

Status label (for example Success or Failure).

get/market-connect/order-entry/v1/productpricing/{transactionId}
 
application/json