Prepare or complete consumer umbrella payment collection in chat.

Use this only after the consumer umbrella follow-up reports payment_needed. Authenticate with Authorization: Bearer <intake_access_token> from the latest consumer-prefill follow-up response. First call this endpoint with payment_collection_requested: true to request a secure Stripe SetupIntent session; this native step comes before handing the shopper to payment_url. If your runtime can render the registered secure payment UI, display it and wait for completion; do not collect card details through conversational text. Then call this same endpoint again with setup_intent_id and payment_method_id so Coverage Cat can place the reusable payment method on file. If the secure UI is unavailable or setup fails in chat, use the returned payment_url browser fallback and preserve the specific fallback reason. When payment_needed appears, the current checkout price shown came directly from the insurer while Coverage Cat is down to final declarations verification before charging the card. Never describe successful payment-method setup as premium collected or active insurance.

post/api/intake/{uid}/payment

Request

  • Base URL: https://api.coveragecat.com
  • URL: https://api.coveragecat.com/api/intake/{uid}/payment
  • Auth: HTTP bearer

Path parameters

uidstring required

Coverage Cat intake uid returned by the consumer-prefill or intake creation step.

Headers

Coverage-Cat-API-Version'v1'

Optional explicit Coverage Cat API version selector. Omit the header to use the current stable version.

Idempotency-Keystring

Optional idempotency key for consumer or operator write requests. Coverage Cat replays the cached successful response for the same subject, path, and key for 24 hours, and rejects a changed payload under the same key.

Request body

OR

Response

Payment collection is ready or the payment method is now on file.

poll_after_secondsinteger
detail_status'abandoned' | 'blocked' | 'bound' | 'cancelled' | 'chosen' | 'credit_consent_pending' | 'credit_consent_required' | 'dev_success' | 'documents_needed' | 'documents_pending_review' | 'email_sent' | 'in_review' | 'ineligible' | 'info_requested' | 'needs_more_info' | 'needs_more_info_to_bind' | 'no_policy' | 'no_chosen_offer' | 'no_quotes' | 'no_selection' | 'ok' | 'payment_collection_ready' | 'payment_needed' | 'pending' | 'pending_quotes' | 'queued' | 'quote_rate_limited' | 'quoted' | 'ready_for_review' | 'ready_for_submission' | 'ready_to_finalize' | 'review_pending' | 'service_preview' | 'service_requested' | 'sandbox_unsupported' | 'stale_selection' | 'verifying_documents' | 'waiting_on_carrier' | 'waiting_on_documents' | 'waiting_on_payment'
required_upload_typesstring[]
uidstring required

Coverage Cat intake uid for the current handoff.

payment_urlstring uri

Coverage Cat browser URL for secure payment fallback.

known_summaryobject

Structured facts Coverage Cat can safely summarize at this stage.

compare_details_urlstring uri

Coverage Cat browser URL for compare-details follow-up.

uploaded_countinteger
response_summarystring
schemaobject

Supplemental schema hints for homeowners review payloads.

user_action_requiredstring
expires_atstring date-time

When the current consumer handoff expires.

agent_instructionsstring[]
review_tokenstring

Opaque review token for delegated review-style submit paths.

status'abandoned' | 'blocked' | 'bound' | 'cancelled' | 'chosen' | 'credit_consent_pending' | 'credit_consent_required' | 'dev_success' | 'documents_needed' | 'documents_pending_review' | 'email_sent' | 'in_review' | 'ineligible' | 'info_requested' | 'needs_more_info' | 'needs_more_info_to_bind' | 'no_policy' | 'no_chosen_offer' | 'no_quotes' | 'no_selection' | 'ok' | 'payment_collection_ready' | 'payment_needed' | 'pending' | 'pending_quotes' | 'queued' | 'quote_rate_limited' | 'quoted' | 'ready_for_review' | 'ready_for_submission' | 'ready_to_finalize' | 'review_pending' | 'service_preview' | 'service_requested' | 'sandbox_unsupported' | 'stale_selection' | 'verifying_documents' | 'waiting_on_carrier' | 'waiting_on_documents' | 'waiting_on_payment' required
intake_access_tokenstring

Short-lived follow-up bearer. On REST, send it back as Authorization for the next /api/intake/{uid} call. On MCP, retry the same follow-up tool with this token only when your host cannot preserve Coverage Cat's hidden shopper session. Never display it to the shopper.

line'umbrella' | 'homeowners'
offers_urlstring uri

Coverage Cat browser URL for the selected offer or offer-tracking page.

payment_collection_supportedboolean
review_estimatesobject[]
credit_consent_questionstring
next_actionobject

A structured hint for the next allowed tool or endpoint action.

application_submittedboolean
reviewobject

Structured review card or selected-offer review block.

missing_fieldsobject[]

Structured missing-value hints for homeowners pre-submit review.

next_questionobject

The current shopper-owned question bundle or bind-stage question.

sandboxboolean

True when Coverage Cat is returning consumer sandbox test data rather than a live shopper workflow.

selection_guidanceobject

Guidance for completing an offer choice in one shopper-facing reply.

preview_tokenstring

Opaque bind-preview token for the next homeowners bind confirmation.

post_chooseobject

Structured post-choose state after a quoted umbrella offer is selected.

pending_fieldsobject[]

Structured missing-value hints for umbrella pre-submit review.

field_estimatesobject[]

Changes

No recorded changes to this operation across all 1 revision of this API.