Search
K
Policy Transactions

ReinstatementRequest

object
correlationIdstringrequired

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date when the transaction was originally scheduled or expected to happen. It can be a non-business day

Example:2023-01-01

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

policyobjectrequired
Show Child Parameters
transactionAmountsobjectrequired
Show Child Parameters
systematicProgramobjectrequired
Show Child Parameters
caseIdstringrequired

Zinnia Live Case ID

Example:CA0000007389

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "2023-01-01",
  "reverseInitiator": false,
  "policy": {
    "policyFeatures": [
      {
        "featureType": "REINSTATEMENT",
        "approvalDate": "2025-08-26",
        "effectiveDate": "2025-08-26",
        "underwritingDecision": "APPROVED"
      }
    ]
  },
  "transactionAmounts": {
    "externalIdentifiers": {
      "externalTransactionId": "externalTransactionId",
      "referenceNumber": "referenceNumber"
    },
    "requestedAmount": 0,
    "appliedAmount": 0,
    "netPaymentAmount": 0,
    "parties": [
      {
        "partyId": "Party_PI_1",
        "paymentForm": "DTCC",
        "bankId": "bank_1",
        "partyRole": "partyRole"
      }
    ]
  },
  "systematicProgram": {
    "externalIdentifiers": {
      "externalTransactionId": "externalTransactionId",
      "referenceNumber": "referenceNumber",
      "externalArrangementId": "B45678"
    },
    "paymentForm": "DTCC",
    "arrangementType": "PAYMENT",
    "amountType": "AMOUNT",
    "amount": 5,
    "frequency": "DAILY",
    "startDate": "startDate",
    "endDate": "endDate",
    "previousProgramDate": "previousProgramDate",
    "nextProgramDate": "nextProgramDate",
    "parties": [
      {
        "partyRole": "OWNER",
        "partyId": "Party_PI_1",
        "paymentForm": "DTCC",
        "allocationPercentage": 100,
        "bankId": "Bank_1",
        "addressId": "1",
        "forBenefitOfOrForFurtherCredit": "TBD"
      }
    ]
  },
  "caseId": "CA0000007389"
}

SystematicProgramUpdateRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "effectiveDate",
  "reverseInitiator": false,
  "systematicProgram": {
    "paymentForm": "DTCC",
    "arrangementType": "PAYMENT",
    "amountType": "AMOUNT",
    "amount": 5,
    "frequency": "DAILY",
    "startDate": "startDate",
    "endDate": "endDate",
    "previousProgramDate": "previousProgramDate",
    "nextProgramDate": "nextProgramDate",
    "party": {
      "partyId": "Party_PI_1",
      "bankId": "Bank_1"
    },
    "parties": [
      {
        "partyRole": "OWNER",
        "partyId": "Party_PI_1",
        "paymentForm": "DTCC",
        "allocationPercentage": 100,
        "bankId": "Bank_1",
        "addressId": "1",
        "forBenefitOfOrForFurtherCredit": "TBD"
      }
    ]
  },
  "caseId": "CA0000007389",
  "externalTransactionId": "A12345"
}

SystematicProgramQuoteRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

arrangementIdstring

The unique ID for the systematic programs available in the policy

Example:arr_1

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "effectiveDate",
  "reverseInitiator": false,
  "arrangementId": "arr_1",
  "systematicProgram": {
    "paymentForm": "DTCC",
    "arrangementType": "PAYMENT",
    "amountType": "AMOUNT",
    "amount": 5,
    "frequency": "DAILY",
    "startDate": "startDate",
    "endDate": "endDate",
    "previousProgramDate": "previousProgramDate",
    "nextProgramDate": "nextProgramDate",
    "party": {
      "partyId": "Party_PI_1",
      "bankId": "Bank_1"
    },
    "parties": [
      {
        "partyRole": "OWNER",
        "partyId": "Party_PI_1",
        "paymentForm": "DTCC",
        "allocationPercentage": 100,
        "bankId": "Bank_1",
        "addressId": "1",
        "forBenefitOfOrForFurtherCredit": "TBD"
      }
    ]
  },
  "caseId": "CA0000007389",
  "externalTransactionId": "A12345"
}

SystematicProgramSubmitRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

externalArrangementIdstring

Arrangement ID from external system

Example:B45678

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "effectiveDate",
  "reverseInitiator": false,
  "systematicProgram": {
    "paymentForm": "DTCC",
    "arrangementType": "PAYMENT",
    "amountType": "AMOUNT",
    "amount": 5,
    "frequency": "DAILY",
    "startDate": "startDate",
    "endDate": "endDate",
    "previousProgramDate": "previousProgramDate",
    "nextProgramDate": "nextProgramDate",
    "party": {
      "partyId": "Party_PI_1",
      "bankId": "Bank_1"
    },
    "parties": [
      {
        "partyRole": "OWNER",
        "partyId": "Party_PI_1",
        "paymentForm": "DTCC",
        "allocationPercentage": 100,
        "bankId": "Bank_1",
        "addressId": "1",
        "forBenefitOfOrForFurtherCredit": "TBD"
      }
    ]
  },
  "caseId": "CA0000007389",
  "externalTransactionId": "A12345",
  "externalArrangementId": "B45678"
}

AddressChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

preferredAddressIndicatorstringrequired

Indicates whether the address being added should be set as default or not.

Allowed values:YESNO

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

addressobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "preferredAddressIndicator": "YES",
  "reverseInitiator": false,
  "effectiveDate": "effectiveDate",
  "address": {
    "startDate": "startDate",
    "endDate": "endDate",
    "addressType": "RESIDENCE",
    "addressLine1": "1112 Pickle Street",
    "addressLine2": "South Jersey",
    "addressLine3": "1234 Post box",
    "city": "Houston",
    "state": "AL",
    "zipCode": "66636",
    "zipCodeExtension": "1232",
    "country": "US"
  },
  "caseId": "CA0000007389",
  "deleteRequest": false
}