Installation
      Back to home
      1. Reditus Help Center
      2. B2B SaaS
      3. Installation

      Reditus API

      Our API will allow you to send payment information or pull information from our system. See what is possible and how to set things up.

      When to Use the Reditus API

      The Reditus API allows you to automate aspects of your affiliate program, particularly when using payment providers other than Stripe or Paddle. Below, we explain how and when to use the Reditus API, especially for sending referral payment information. You can also use our API to pull affiliate information from our system, to send it anywhere you want. 

      • Referral Payment Tracking: Use the API to send referral payment information when you don’t use Stripe or Paddle for billing.
      • Partner Data Integration: Pull any partner-related data to integrate with your own systems.

      Payments API: Key Use Case

      The Payments API is useful when you are using alternative payment providers such as Mollie, Chargebee, PayPal, Manual invoicing or any other platform. In such cases, Reditus can track referral payments through the Payments API instead of the pre-built Stripe or Paddle integrations. This is essential for ensuring your affiliate program runs smoothly and all referral payments are tracked.

      No need for Payments API: If you are already using Stripe or Paddle, you won’t need to use the Payments API.


      The Payments API can function independently as long as:

      • The tracking script is correctly installed
      • The conversion snippet is correctly set up

      How to Set Up the Payments API

      To get the Payments API working:

      1. Make sure to add referrals to reditus 
      2. Make API Calls: Every time a payment is made, make a call to our Payments API.
      3. Send the Following Data:
        • Referral email: The email address associated with the referral
        • Payment interval and amount: Details of the payment (monthly, yearly, etc.)
        • Currency
        • Subscription ID: The ID associated with the payment subscription
        • Idempotency Key: A unique string per payment to avoid duplicate tracking

      4. Commissions are generated. When the referral email is in our system, we will generate the commission you agreed with them. 

       

      For full technical details, visit our Payments API documentation.

      Testing the Payments API

      • Staging Environment: We provide a staging environment for testing the API. Message us in support if you'd like access.
      • Production Environment: Be aware that accounts are not cleaned up after extensive testing in production.

      Additional API Options

      The Reditus API offers additional functionalities to automate your affiliate program and integrate key data into your systems. If you need help or have questions, feel free to get in touch with us via chat in the app or on our homepage. We're here to assist you in making the most of your partner program.

      By using the Payments API, you can ensure that your B2B SaaS affiliate program is automated and efficient, regardless of your payment provider. Let us know if you need any assistance!