v4

latestOpenAPI 3.1.02026-08-03427198448.4 KB

Validate Payments For Notifications

Validate which payments can receive notification emails.

This is a lightweight endpoint that checks payment eligibility without actually sending emails. Returns categorized lists of eligible, ineligible, and already-notified payments.

Args: payment_ids: List of payment IDs to validate (optional if filters provided) filters: Filter criteria to fetch payment IDs (optional if payment_ids provided) user_id: ID of the authenticated user (from auth middleware) org_id: ID of the user's organization (from auth middleware)

Returns: dict: Lists of eligible_ids, ineligible_ids (with reasons), and already_notified_ids

post/payments/validate-for-notifications

Query parameters

user_idstring
org_idstring

Request body

object required

Body containing payment_ids array or filters object

Response

Successful Response

{"stackTrail":"paths:/payments/validate-for-notifications:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}