paywise icon

paywise

Consume paywise API
Join our community

Actions20

Overview

This node integrates with the Paywise Case Management API to create a new debtor record. It allows users to add detailed debtor information either by providing a full JSON object or by filling individual fields. This is useful in scenarios where you need to register debtors (persons or organizations) into the Paywise system for case management, collections, or financial tracking.

Practical examples include:

  • Adding a new customer who owes money, including their contact details and bank accounts.
  • Registering an organization as a debtor with multiple addresses and communication channels.
  • Acting on behalf of a client company to create debtor records under that client's user ID.

Properties

Name Meaning
Input Type Choose whether to input debtor data as a complete JSON object or via individual fields. Options: JSON, Fields.
Act on Behalf of Client Boolean flag indicating if the request should be made on behalf of another client company.
User ID The ID of the user to act on behalf of when the above flag is true. Required in that case.
JSON Data Debtor data as a JSON object. Must include your_reference, acting_as, addresses, and either person or organization details. Used only if Input Type is JSON.
Debtor Type Whether the debtor is a Person or an Organization. Required if Input Type is Fields.
Your Reference A unique reference string for this debtor. Required if Input Type is Fields.
Salutation Salutation such as Mr., Mrs., etc. (max 20 characters). Only for person debtors.
First Name First name of the debtor (max 100 characters). Required for person debtors.
Last Name Last name of the debtor (max 100 characters). Required for person debtors.
Birth Date Birth date in YYYY-MM-DD format. Optional for person debtors.
Organization Name Name of the organization (max 255 characters). Required for organization debtors.
Acting As Indicates if the debtor is acting as a Consumer or Business.
Addresses One or more addresses for the debtor. Each address includes street, ZIP/postal code, city, and country (ISO-3166-1 alpha-2 code).
Communication Channels One or more communication channels such as email, phone, mobile phone, fax, Skype, social media platforms, website URL, etc. Each channel requires a type and a value.
Bank Accounts One or more bank accounts with IBAN (required) and optional BIC.
Metadata Additional metadata items as key-value pairs, e.g., user references.
Events One or more events related to the debtor, each with type, title, occurrence date (ISO format), optional reference, description, and location.

Output

The node outputs an array of JSON objects representing the response from the Paywise API after creating the debtor. Each output item corresponds to one input item processed.

The json output field contains the created debtor's data as returned by the API, which typically includes identifiers, status, and all submitted debtor details.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Paywise API.
  • The node depends on the Paywise Case Management API being accessible and properly configured.
  • Network connectivity to the Paywise API endpoint is necessary.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common Issues:

    • Missing required fields such as your_reference, acting_as, or debtor identification details will cause errors.
    • Incorrectly formatted dates (e.g., birth date or event occurrence) may lead to validation failures.
    • Using "Act on Behalf of Client" without providing a valid User ID will result in authorization errors.
    • Providing invalid country codes or improperly formatted IBAN/BIC can cause API rejections.

  • Error Messages:

    • "Resource 'debtor' is not implemented" or "Operation 'create' for resource 'debtor' is not implemented" indicate misconfiguration or unsupported operations.
    • API errors related to authentication usually mean the API key credential is missing or invalid.
    • Validation errors from the API will specify which fields are incorrect or missing; ensure all required fields are provided according to the selected input type.

  • Resolution Tips:

    • Double-check all required properties based on the input type.
    • Validate JSON structure if using JSON input.
    • Confirm API credentials and permissions.
    • Use ISO standard formats for dates and country codes.
    • Test with minimal required data first, then add optional fields incrementally.

Links and References

Discussion