Skip to main content

Welcome to our Billwerk+ Optimize Help Center

Checkout helper

Introducing the Checkout Helper Tool in Billwerk+

Overview

The Checkout Helper tool in Billwerk+ is an optional yet powerful resource designed to help developers understand and work with our Session API. While not mandatory, it’s an excellent starting point for learning how to construct secure and effective API requests for creating payment windows.

Whether you're integrating one-time payments, recurring billing, or subscription management, the Checkout Helper serves as a hands-on learning tool, providing insights into the structure and functionality of the Billwerk+ Session API.

You can navigate by clicking on Configurations > Integrations and tools > Checkout helper in the sidebar

screenshot-staging-admin_billwerk_plus-2024_12_04-15_47_17.png

screenshot-staging-checkout-helper_billwerk_plus-2024_12_04-15_49_33.png

 

Why Use the Checkout Helper?

The Sessions API underpins the creation of secure and customizable payment windows. Before opening a payment window, an API call is required to create a checkout session, ensuring secure parameter exchange for details such as payment amounts, accepted payment methods, and customer information.

For developers unfamiliar with the API or those seeking to fine-tune their requests, the Checkout Helper is a helpful way to:

  • Understand Request Structure: See how different fields map to API parameters.

  • Experiment with Configurations: Try out different settings and instantly see how they affect the generated request.

  • Validate API Calls: Ensure your calls are correctly structured before implementation.

When to Use the Checkout Helper

The Checkout Helper is ideal for the initial stages of your integration journey, such as:

  1. Learning the Session API:

    If you’re new to Billwerk+ or APIs in general, this tool simplifies the process of understanding the required parameters and structure.

  2. Prototyping and Testing:

    Quickly configure and preview API calls to test different session types or parameter combinations. 

  3. Debugging Issues:

    Use the tool to cross-check your existing API calls and identify potential issues.

What Can You Do with the Checkout Helper?

The Checkout Helper supports three types of checkout sessions, aligned with the functionality of the Session API:

  1. Charge Session:

    1. Process a one-time payment.

    2. Optionally store the payment method for future use (e.g., recurring or subscription payments).

  2. Recurring Session:

    1. Store a payment method for future use in recurring transactions or subscriptions.

  3. Subscription Session:

    1. Change the payment method for an existing subscription.

    2. Activate a subscription and link it to a payment method.

Each session type corresponds to a specific endpoint in the Session API, and the tool helps you construct the appropriate request for your needs.

screenshot-staging-checkout-helper_billwerk_plus-2024_12_04-15_53_15.png

Key Features of the Checkout Helper

  • Preconfigured Fields: Essential fields like API keys, amounts, currencies, and customer details are available for quick input.

  • Real-time Request Generation: Watch as the tool dynamically builds the JSON request payload based on your inputs.

  • Guided Setup: The tool provides context and descriptions for each parameter, helping you understand its role in the API call.

  • Session Execution: Test your configurations directly from the interface and see the responses returned by the API.

screenshot-staging-checkout-helper_billwerk_plus-2024_12_04-16_05_36.png

How to Use the Checkout Helper

1. Access the Tool

Open the Checkout Helper in the Billwerk+ interface.

2. Select the Session Type

Choose between Charge, Recurring, or Subscription session types based on your use case.

3. Fill in the Fields

Configure the session by entering details such as:

  • API Key for authentication.

  • Locale and Currency for regional customization.

  • Order Amount and Order Details for transaction specifics.

  • Customer Information and payment method preferences.

4. Review the API Request

The generated request is displayed in real-time, allowing you to validate and understand its structure.

5. Test and Adjust

Test the session creation to see how the API responds. Adjust parameters as needed to refine your request.

Do You Need the Checkout Helper?

The Checkout Helper is entirely optional. If you’re confident in your understanding of the Session API and prefer working directly in your development environment, you can skip using this tool. However, it can save you time and reduce errors, especially during the initial setup phase.

Benefits of Using the Checkout Helper

  • Learn Faster: Get hands-on experience with the Session API in a guided environment.

  • Reduce Mistakes: Build accurate and secure requests with confidence.

  • Accelerate Integration: Spend less time troubleshooting and more time developing.

Conclusion

The Checkout Helper in Billwerk+ is a convenient resource for developers looking to master the Session API. While it’s not a required step in your integration process, it’s a useful tool for learning, testing, and validating your API requests. Use it to streamline your workflow and ensure your payment windows function seamlessly.