Overview

Finds a policy for online payment submission and returns the amount due along with a unique inquiry ID required for payment processing. This endpoint is designed for external online payment portals where policyholders look up their policy and make payments.

What This Endpoint Does:

1. Searches for a policy based on configurable criteria (policy number, last name, zip code, etc.)

   ⚠️ See the Query Parameters section below for more info.

2. Retrieves the current amount due for that policy

3. Generates a unique InquiryID that must be used when submitting payment

4. Returns policy information needed for payment

Key Security Feature: The InquiryID is a one-time token that:

• Uniquely identifies this payment inquiry session
• Must be included when submitting payment via /api/OnlinePolicyPayment/Submit
• Prevents unauthorized or duplicate payments
• Expires/clears after payment submission

Typical Use Case: A policyholder visits your online payment portal, enters their policy number and last name, and this endpoint returns how much they owe along with a payment inquiry ID. They then proceed to enter payment details which are submitted with that inquiry ID.

⚠️### Query Parameters

IMPORTANT: The query parameters for this endpoint are configurable and depend on the OnlinePolicyPaymentFilter system setting. This setting controls what query parameters are required by this endpoint.

Example Configuration:

OnlinePolicyPaymentFilter = "PolicyNumber=[PolicyNumber] AND NamedInsured.LastName=[LastName]"

Required Query Parameters (based on above config):

• PolicyNumber - The policy number
• LastName - The named insured's last name

Example API Call based on the Example Configuration:

GET /api/OnlinePolicyPayment/Policy?PolicyNumber=CA-2024-001234&LastName=Smith

When to Use This Endpoint

Use OnlinePolicyPayment/Policy when:

• ✅ Building an online payment portal for policyholders
• ✅ Allowing policyholders to look up their balance due
• ✅ Need to retrieve payment information before collecting payment details
• ✅ Implementing "pay my bill" functionality

Prerequisites:

• ❌ System configuration required: This endpoint will not work without proper configuration of your Origami system settings
  • ❌ OnlinePolicyPaymentFilter setting: Must be configured in Origami system settings
  • ❌ Online payment setup: Billing and payment processing must be configured

Do NOT use this endpoint for:

• ❌ Retrieving standard policy information. Uuse /api/Policy/{id} or search endpoints).
• ❌ Internal billing operations (use billing-specific endpoints)
• ❌ Administrative payment processing (use internal payment tools)