PAYMENT_RECORDED

Payment has been made and is recorded

Submit this event using Firing an Event. Product configuration and enabled actions determine the workflow behavior. Use identifiers and snapshots from the same environment.

Request payload#

POST https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "lineId": "<UUID of the product ID>",
  "type": "PAYMENT_RECORDED",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "payment": {
      "amount": 52500,
      "receivedDate": "2027-03-01T10:00:00-05:00",
      "paymentType": "CREDIT_CARD",
      "paymentTransactionId": "<UUID of the payment transaction ID>",
      "policyId": "<UUID of the policy ID>",
      "transactionStatus": "SETTLED"
    },
    "statement": {
      "statementNumber": 1,
      "issueDate": "2027-03-01",
      "totalDue": 52500
    },
    "policy": {
      "id": "<UUID of the policy ID>",
      "policyNumber": "<Policy number>",
      "issuingOrganizationId": "<UUID of the issuing organization ID>",
      "sellerOrganizationId": "<UUID of the seller organization ID>",
      "clientId": "<UUID of the client ID>",
      "quoteId": "<UUID of the quote request ID>",
      "productId": "<UUID of the product ID>",
      "premium": 4200.0,
      "effectiveDate": "2026-11-01",
      "expirationDate": "2027-11-01",
      "lastDayWithCoverage": "2027-10-31",
      "asRatingConfiguredAtTimestamp": "2026-10-01T00:00:00Z"
    }
  }
}'

{
  "lineId": "<UUID of the product ID>",
  "type": "PAYMENT_RECORDED",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "payment": {
      "amount": 52500,
      "receivedDate": "2027-03-01T10:00:00-05:00",
      "paymentType": "CREDIT_CARD",
      "paymentTransactionId": "<UUID of the payment transaction ID>",
      "policyId": "<UUID of the policy ID>",
      "transactionStatus": "SETTLED"
    },
    "statement": {
      "statementNumber": 1,
      "issueDate": "2027-03-01",
      "totalDue": 52500
    },
    "policy": {
      "id": "<UUID of the policy ID>",
      "policyNumber": "<Policy number>",
      "issuingOrganizationId": "<UUID of the issuing organization ID>",
      "sellerOrganizationId": "<UUID of the seller organization ID>",
      "clientId": "<UUID of the client ID>",
      "quoteId": "<UUID of the quote request ID>",
      "productId": "<UUID of the product ID>",
      "premium": 4200.0,
      "effectiveDate": "2026-11-01",
      "expirationDate": "2027-11-01",
      "lastDayWithCoverage": "2027-10-31",
      "asRatingConfiguredAtTimestamp": "2026-10-01T00:00:00Z"
    }
  }
}

Request Fields#

See the shared event envelope. Set type to PAYMENT_RECORDED and provide the payload below.

Payload Fields#

Property	Required	Description
`clientId`	No	UUID of the client associated with the policy
`quoteId`	No	UUID of the quote
`policyId`	No	UUID of the policy.
`documents`	No	Array of associated documents
`payment`	Yes	Payment record object
`statement`	Yes	Statement object
`policy`	Yes	Policy snapshot object. Use the same policy as `policyId`.

Response#

This example illustrates the common trigger response structure. Action counts and metadata depend on the actions that run; action-specific result fields are described where applicable.

{
  "triggerRequestId": "<UUID of the trigger request ID>",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response Fields#

Property	Description
`triggerRequestId`	UUID identifying this trigger execution.
`executedActionCount`	Number of actions reported as executed.
`expectedResponseCount`	Number of expected action responses.
`metadata`	Action-specific results; may be empty.

See Firing an Event for execution modes and response handling.