Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to update payment provider settings. It is useful for automating the management of payment collection and settlement configurations within a workflow, such as setting collection modes, settlement modes, and additional payment provider-specific options. For example, it can update settings to switch between manual and invoice collection modes or configure retry policies for failed payments.

Use Case Examples

  1. Updating payment provider settings to change collection mode to 'invoice' and settlement mode to 'confirmed'.
  2. Adding metadata and description to differentiate multiple payment provider instances.
  3. Configuring automatic retry for failed payments and setting fixed collection days.

Properties

Name Meaning
Id Unique identifier for the payment provider settings to update.
Collection Mode Mode of payment collection, either manual or invoice.
Settlement Mode Mode of payment settlement, either paid out or confirmed.
Additional Body Fields Optional additional fields to customize the payment provider settings, including provider type, description, collection timing, retry policies, and metadata.

Output

JSON

  • data - Response data from the Billing Booth One API after updating payment settings.
  • error - Error information if the update operation fails.

Dependencies

  • Billing Booth One API with an API key credential for authentication.

Troubleshooting

  • Common issues include missing or invalid 'Id' parameter, causing the API to reject the update request.
  • Incorrect or unsupported values for collection_mode or settlement_mode may cause errors.
  • If 'collection_in_days' and 'collection_fixed_day' are both set, the API may reject the request due to mutual exclusivity.
  • Errors from the API are returned in the output's error field; ensure the API key is valid and has necessary permissions.

Links

Discussion