MarketConnect-OrderEntry

Market Connect Order Entry API

Executes a reviewer action for the given transaction (forwards to the product order-entry service).

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • INVALID_TRANSACTION_ID - The supplied transaction ID is not a valid value.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to access this resource.

  • 404 Not Found

  • TRANSACTION_ID_NOT_FOUND - No transaction exists for the specified transaction ID.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while processing the request.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - An upstream dependency returned an invalid or unsuccessful response.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
post

Body

application/json

Action and transaction identifier.

ReviewerActionRequest

* Additional properties are NOT allowed.
actionstringrequired

Review outcome: Approved, Declined, or Terminate.

>= 1 characters

transactionIdinteger(int32)required

Order-entry transaction (instance) identifier.

>= 1<= 2147483647

Response

application/json

Returns the reviewer action outcome

ReviewerActionResponse

* Additional properties are NOT allowed.
caseIdinteger | null(int64)

Case identifier returned by the upstream service when available.

isSuccessboolean

True when the reviewer action completed successfully.

messagestring | null

Human-readable outcome message.

statusstring | null

High-level status string returned to the client.

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

Body

{ "action": "action", "transactionId": 0 }
 
application/json

ProductPricing

Product pricing retrieval for a transaction

Retrieves the product pricing payload for a transaction.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to access this resource.

  • 404 Not Found

  • NOT_FOUND - No pricing was found for the specified transaction.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while processing the request.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - An upstream dependency returned an invalid or unsuccessful response.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
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%"}]}

* 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

Esignature

E-signature for DocuSign: load recipients, submit the case, poll signer status, cancel ceremony (void envelope; Pending), and retrigger signing email when in progress

Retrieves the e-signature signer list for a transaction.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to access this resource.

  • 404 Not Found

  • TRANSACTION_ID_NOT_FOUND - No transaction exists for the specified transaction ID.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while processing the request.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - An upstream dependency returned an invalid or unsuccessful response.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
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 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@everglades.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}
 
application/json