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.
Retrieves the comments for a transaction.
Returns the list of comments recorded against the specified transaction.
get
Query Parameters
Path Parameters
transactionIdstringrequired
Unique identifier of the transaction (positive integer encoded as a string).
Response
application/json
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}
Authentication
Path Parameters
Query Parameters
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
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}
Authentication
Path Parameters
application/json
Esignature
E-signature signer retrieval and case submission for DocuSign (load recipients, then submit the case with signer roles, auth method, and contact details)
Retrieves the e-signature signer list for a transaction.
Returns DocuSign signer details for the specified transaction.
Path parameter: transactionId (required) — resolves to the internal transaction; the caller must be authorized for this transaction.
Response fields:
success— whether signers were loadedmessage— user-safe text whensuccessis falsesigners— recipient rows withrecipientId,signerName,signerEntityRole,signerEmail,signerSequence,signerAccessCode,signerAuthMethod,signerCountryCode,signerPhoneNo
signerAuthMethod: array of labels (for example ["Phone", "SMS"]); signerAccessCode: string array.
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
Response
application/json
Returns the e-signature signer payload
EsignatureResponse
* Additional properties are NOT allowed.
successboolean
True when signers were retrieved successfully.
messagestring | null
User-safe message; populated when success is false.
signersarray | null[object]
DocuSign recipients for the transaction, ordered by signing sequence.
Example:{"recipientId":"11306862","signerName":"EE EE","signerEntityRole":"PrimaryOwner","signerEmail":"anannya.gupta@zinnia.com","signerSequence":"1","signerAccessCode":[],"signerAuthMethod":["Phone","SMS"],"signerCountryCode":"1","signerPhoneNo":"8650827071"}
* Additional properties are NOT allowed.
Show Child Parameters
get/market-connect/order-entry/v1/esignature/{transactionId}
Authentication
Path Parameters
application/json