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 manage payment-related operations. Specifically, the 'Add Mandate' operation under the 'Payments' resource allows users to add a payment mandate for a customer. This is useful for automating payment setups, such as linking a customer's payment method to a provider mandate reference for recurring billing or direct debit arrangements.

Use Case Examples

  1. Adding a new payment mandate for a customer using Go Cardless as the payment provider.
  2. Setting a default payment mandate with a custom description and status for a customer.

Properties

Name Meaning
Customer Id Unique identifier for the customer in the system.
Customer Provider-specific customer reference used in the API request body.
Mandate Provider-specific mandate reference used in the API request body.
Description Friendly description of the mandate, sent in the API request body.
Payment Provider Settings Id Identifier for the payment provider settings, included in the API request body.
Additional Body Fields Optional additional fields to customize the mandate, such as collection days, default status, provider type, descriptions, creation date, and status details.

Output

JSON

  • json - The response from the Billing Booth One API after adding the mandate, typically containing details of the created mandate or error information.

Dependencies

  • Billing Booth One API access with an API key credential

Troubleshooting

  • Ensure all required fields (Customer Id, Customer, Mandate, Description, Payment Provider Settings Id) are provided to avoid validation errors.
  • If the API returns an error, check the API key credential and base URL configuration.
  • Conflicts between 'collection_in_days' and 'collection_fixed_day' fields should be avoided as they cannot be set together.
  • If the node fails, enabling 'Continue On Fail' can help process subsequent items without stopping the workflow.

Links

Discussion