transactionIdstringrequired
Secure API to get TransactionData by transactionId
get
Path Parameters
Response
application/json
Response
application/json
Transaction Model success
TransactionModelResponse
Model for a transaction with detailed information.
recordIdstring
Unique identifier for the transaction record.
correlationIdstring
Correlation ID associated with the transaction.
transactionTypestring
Type of transaction.
carrierstring
Carrier associated with the transaction.
sourcestring
Source of the transaction.
entityTypestring
Type of the entity involved.
entityIdstring
Unique identifier for the entity.
entityobject
Actual entity information as JSON Object.
expireTsstring(date-time)
Expiration timestamp for the transaction.
createdTsstring(date-time)
Timestamp when the transaction was created.
updatedTsstring(date-time)
Timestamp when the transaction was last updated.
createdBystring
User or system that created the transaction.
updatedBystring
User or system that last updated the transaction.
identifiersarray[object]
Identifier model with key-value pair.
Show Child Parameters
get/bpm/v1/policies/withdrawals/transactionstore/entities/{transactionId}
Path Parameters
application/json
Get supported configurations for a transaction
get
Query Parameters
transactionstring
arrangementTypestring
Path Parameters
clientCodestringrequired
planCodestringrequired
transactionNamestringrequired
Allowed values:SystematicProgramSetupSystematicProgramUpdate
Response
application/json
Response
application/json
Success response
get/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/paymentforms
Path Parameters
Query Parameters
application/json
Get supported configurations for a transaction
get
Query Parameters
transactionstring
arrangementTypestring
Path Parameters
clientCodestringrequired
planCodestringrequired
transactionNamestringrequired
Allowed values:SystematicProgramSetupSystematicProgramUpdate
Response
application/json
Response
application/json
Success response
get/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/prevalidationreference
Path Parameters
Query Parameters
application/json
Get eligible transaction types for a policy by CUSIP and policy number
Returns the list of eligible transaction types for the given CUSIP and policy number.
get
Path Parameters
cusipstringrequired
CUSIP number
policyNumberstringrequired
Policy number
Response
application/json
Response
application/json
Success
EligibleTransactionsResponse
cusipstring
Example:123456789
productCodestring
Example:ADDAARP
eligibleTransactionTypesarray[object]
List of eligible transaction types
Show Child Parameters
get/bpm/v1/policies/{cusip}/{policyNumber}/eligibleTransactions
Path Parameters
application/json
IdentifierInstance
objectAn object representing an identifier and its corresponding value.
identifierstring
The type of identifier.
Allowed values:eAppIdpolicyNumber
valuestring
The value of the identifier.
Example:ABC123349257367
Example