CSQ Docs
    CSQ Docs
    Dummy Product Usage Guide
    • CSQ API Doc
    • Dummy Product Usage Guide
    • Overview on Dummy Products
    • Top-Up Simulation
    • Voucher Purchase Simulation
    • Supermarket Vouchers Purchase Simulation
    • Bill Payment Simulation
    • Location-based products simulation
    • Insurance Contracting Simulation

    Insurance Contracting Simulation

    Insurance Contracting Simulation#

    🛡️ Simulating Insurance Contracting with Dummy Products#

    This guide explains how to simulate an insurance contracting flow using the Dummy Insurance provider through the public Insurance API.
    The dummy implementation allows developers to test:
    Dynamic step-based contracting flows
    Backend-driven form rendering
    Quote calculation
    Payment execution
    Success and error scenarios
    ⚠️ No real insurance provider is contacted and no real transaction is executed.

    📦 Dummy Insurance Overview#

    Dummy Insurance simulates a dynamic, backend-driven insurance flow identical in behavior to production integrations.
    Main characteristics:
    Dynamic steps (start → step → quote)
    Backend-controlled required and optional fields
    Mandatory propagation of insuranceId
    Explicit transition to payment using payment = true
    Same API contract as production (no dummy-specific logic on client side)
    The client must behave exactly as it would in production.

    🔁 Simulation Flow#

    1.
    Start insurance contracting flow
    2.
    Submit dynamic contract data
    3.
    Receive quote (last step)
    4.
    Execute payment
    5.
    Retrieve ticket

    🔹 Step 1: Start Contracting Flow#

    Method
    GET /insurances/start/{terminalId}/{operatorId}

    Description#

    Initializes the dummy insurance flow. The backend returns:
    Available phases
    Dynamic form definition (front)
    Required and optional input fields
    The next step endpoint (nextStep.path)
    The client must not assume any fixed step order or required fields.

    🔸 Step 2: Submit Contract Data (Dynamic Step)#

    Method
    POST /insurances/step/{terminalId}/{operatorId}/1

    Request body (example)#

    [
  { "key": "documentType", "value": "cedula" },
  { "key": "document", "value": "00112345678" }
]

    💰 Quote Amount Simulation#

    planIdamountToSendX100Amount
    11000001000.00
    22000002000.00
    33000003000.00

    🔚 Payment Transition#

    When the backend returns:
    "payment": true
    the client must immediately execute payment, exactly as in production.

    💳 Step 3: Execute Payment#

    Method
    POST /insurances/payment/{terminalId}/{operatorId}

    Payment body#

    {
  "amountToSendX100": 200000,
  "account": "DUMMY-INS-123456",
  "localDateTime": "2025-12-01T11:20:46Z"
}

    🎟️ Step 4: Get Ticket#

    Method
    GET /insurances/ticket/{terminalId}/{operatorId}/{reference}

    🧪 Dummy vs Production#

    AspectDummyProduction
    insuranceIdSimulatedReal
    frontSimulatedReal
    paymentSimulatedReal

    ✅ Summary#

    Dummy Insurance provides a production-aligned simulation for full end-to-end testing.
    Modified at 2025-12-23 14:46:08
    Previous
    Location-based products simulation
    Built with