PAYMENT_COLLECT_SETUP

Prepares payment processing for existing policy

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_COLLECT_SETUP",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "documents": [],
    "totalAmount": 525000
  }
}'

{
  "lineId": "<UUID of the product ID>",
  "type": "PAYMENT_COLLECT_SETUP",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "documents": [],
    "totalAmount": 525000
  }
}

Request Fields#

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

Payload Fields#

Required fields include the inputs used by this event's built-in action. Configured actions can require additional data.

Property	Required	Description
`policyId`	Yes	Target policy to collect a payment for.
`clientId`	No	UUID of the client who owns the policy identified by `policyId`.
`quoteId`	No	UUID of the original quote associated with the policy identified by `policyId`.
`documents`	No	List of documents related to the event.
`totalAmount`	Yes	Decimal payment amount; units depend on the payment integration.

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": {}
}

The built-in action creates a payment session and stores the updated payload under metadata.PAYMENT_COLLECT_SETUP. It fills clientSecret, paymentSessionId, totalAmount, session metadata, and publishKey when the provider supplies one. Use those returned values for the payment flow; the request does not need to supply them in advance.

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.