These docs are for v2023-01-01. Click to read the latest docs for v2024-10-16.

JavaScript bundle

❗️

API version 2023-01-01 deprecating

This version will be deprecated on May 1, 2025. If your platform is on this version, you should upgrade to at least 2023-12-01 to simplify authorization and access new features.

The JavaScript bundle must be included in order to collect and display data through the Rainforest components. This framework allows you to keep sensitive data without exposing your platform to card data, reducing your PCI DSS scope.

Platforms using Rainforest retain full ownership of all payment and merchant data and may export it at any time. This reduces your compliance and operational risk while still maintaining control. It's your data with Rainforest.

Include the following bundle into your HTML based on the component you are rendering.

Payment Sandbox Bundle

The payment bundle is meant to be very lightweight and used for processing payments. Simply include the following script tag.

<script type="module" src="https://static.rainforestpay.com/sandbox.payment.js"></script>

Components included in the payment bundle:

ComponentHTML elementPurpose
Payment component<rainforest-payment/>Process ACH or CARD payments with Rainforest's PCI compliant component.
Payin receipt component<rainforest-payin-receipt/>Display payin details including billing contact details, payment method, and state.

Merchant Sandbox Bundle

The merchant bundle includes the reporting and details components. Simply include the following script tag.

<script type="module" src="https://static.rainforestpay.com/sandbox.merchant.js"></script>

Components included in the merchant bundle:

ComponentHTML elementPurpose
Payment report component<rainforest-payment-report/>Report displaying payments, which includes payins and refunds, and integrates with the payin-details component.
Payin details component<rainforest-payin-details/>Display descriptive payin details to a merchant's user or platform's user, which includes actions such as refunding the payin.
Deposit report component<rainforest-deposit-report/>Report displaying a merchant's deposits and integrates with the deposit-details component.
Deposit details component<rainforest-deposit-details/>Display deposit details to a merchant's user.