Submit Payment Information Gathered Externally

Overview

Records an externally-processed payment in Origami's billing system. This is the second step in the online payment workflow, called after you've successfully collected and processed payment through your external gateway (Stripe, PayPal, etc).

What This Endpoint Does:

1. Validates the InquiryID obtained from /api/OnlinePolicyPayment/Policy
2. Records the payment transaction in the billing system
3. Associates the payment with the policy
4. Clears the inquiry ID to prevent reuse
5. Triggers payment-related events in the system
6. Returns confirmation message

Critical Workflow: This endpoint is always used after calling /api/OnlinePolicyPayment/Policy:

1. Call /Policy → Get InquiryID and AmountDue
2. Collect payment details from customer
3. Process payment through external gateway
4. Call /Submit → Record payment in Origami

Key Security Feature: The endpoint validates that the InquiryID matches the one generated during policy lookup. This prevents:

• Unauthorized payment submissions
• Payment replay attacks
• Payments without proper policy lookup
• Double submissions

When to Use This Endpoint

Use OnlinePolicyPayment/Submit when:

• ✅ Recording a payment processed through an external payment gateway
• ✅ Completing the online payment workflow after /Policy lookup
• ✅ Customer has successfully paid via credit card, ACH, or other method
• ✅ Need to record the payment transaction in Origami's billing system

Prerequisites:

• ❌ Must call /api/OnlinePolicyPayment/Policy first to get valid InquiryID
• ❌ Payment must be processed externally - this endpoint only records it
• ❌ System configuration required - Online payment processing must be configured
• ❌ Valid InquiryID - Must match the one generated during policy lookup

Do NOT use this endpoint for:

• ❌ Internal payment processing (use internal billing endpoints)
• ❌ Manual/administrative payments (use admin tools)
• ❌ Recording payments without external processing
• ❌ Payments where policy lookup was not performed