paywise icon

paywise

Submit and track debt collection cases with the paywise API v2

Actions37

Claim → Create

AI-generated

Summary

Create a new claim associated with a specified draft order in the Paywise system by providing the order ID and the claim details as JSON.

Inputs

  • Order ID (required) — The ID of the draft order to which the claim will be attached.
  • Claim (JSON) (required) — The claim data structured according to the Paywise Case Management API, including fields like type, references, amounts, legal basis, and dates.
  • Options: Idempotency Key — A string to safely retry the operation without creating duplicate claims, ensuring the same result is returned within 24 hours if the key and body are identical.

Output shape

a single JSON object representing the created claim as returned by the Paywise API

If an idempotency key is used, retries with the same key and request body within 24 hours return the original claim result instead of creating a duplicate.

Links

Discussion