paywiseInstall

Summary

Report a payment event either related to a mandate (post-order acceptance) or a claim (pre-order acceptance) by specifying the respective ID along with payment details like amount, currency, and value date.

Inputs

• target (required) — Determines the type of payment event to report: 'mandate' for payments after Paywise accepted the order, or 'claim' for payments before acceptance.
• mandateId (required) — The identifier of the mandate to report payment against when 'target' is 'mandate'.
• claimId (required) — The identifier of the claim to report payment against when 'target' is 'claim'.
• amount (required) — The monetary amount of the payment being reported; must be at least 0.01.
• currency — The currency code for the payment amount; defaults to 'EUR' if unspecified.
• valueDate (required) — The date and time when the payment was received or credited.
• yourReference — Optional user-defined identifier for the payment, such as a bank transaction ID.
• options.idempotencyKey — Key used to ensure the operation is idempotent; reusing the same key within 24 hours returns the original result to prevent duplicates.

Output shape

a single JSON object representing the reported payment confirmation or status from Paywise

The response will reflect the result of reporting the payment against either the mandate or claim, based on the provided identifiers and details. Use the idempotency key to safely retry the operation without duplication.

Examples

Example 1: Reporting payment post-order acceptance to a mandate

Set 'target' to 'mandate' and provide 'mandateId', 'amount', 'currency', 'valueDate', and optionally 'yourReference' and 'idempotencyKey'.

Example 2: Reporting payment pre-order acceptance to a claim

Set 'target' to 'claim' and provide 'claimId', 'amount', 'currency', 'valueDate', and optionally 'yourReference' and 'idempotencyKey'.

Links

• n8n community nodes installation guide