Actions37
- API Key Info Actions
- Claim Actions
- Claim Document Actions
- Debtor Actions
- Mandate Actions
- Order Actions
- Payment Actions
- Single Mandate Statement Actions
- Statement Actions
Debtor → Create
AI-generatedSummary
Create a new debtor record in the Paywise system by specifying whether the debtor is a consumer or a business along with the required personal or company details and address information.
Inputs
- actingAs (required) — Specifies the type of debtor: 'consumer' for a private person or 'business' for a company or self-employed individual.
- organizationName (required) — The name of the company; required if actingAs is 'business'.
- legalForm — Legal form name or ID of the business entity; selectable from a list or provided via an expression; applicable for business debtors.
- firstName (required) — Debtor's first name; required if actingAs is 'consumer'.
- lastName (required) — Debtor's last name; required if actingAs is 'consumer'.
- street (required) — Street address including house number of the debtor.
- postalCode (required) — Postal code of the debtor's address.
- city (required) — City of the debtor's address.
- country — Two-letter ISO country code of the debtor's location; defaults to 'DE'.
- additionalFields — Optional additional information fields such as birth date (for consumers), email, phone numbers, salutation, your own reference, or any other extra information specified as JSON.
Output shape
a single record representing the newly created debtor object as returned by the Paywise API
The output contains all standard and additional fields that were submitted or assigned by the API. Required fields depend on whether the debtor is a consumer or business. Some fields in 'additionalFields' apply only to consumers. The creation is synchronous and returns the debtor data or API errors if input validation fails.
Examples
Example 1: Create a consumer debtor
Set actingAs to 'consumer', provide first name, last name, street, postal code, city, and optionally additional fields like birth date and email.
Example 2: Create a business debtor
Set actingAs to 'business', provide organization name, legal form, street, postal code, city, and optionally additional fields such as phone or your internal reference ID.