RabbitPay Documentation

RabbitPay can be installed in two ways depending on your stack.

Shopify (recommended)
Headless / custom storefront
Server SDKs

The easiest path — a native Shopify app with theme extensions.

Install the app

Visit the RabbitPay listing on the Shopify App Store and click Add app.

Authorize scopes

Approve the requested scopes: read_products, write_orders, read_customers, write_draft_orders.

Enable the theme extension

In your Shopify admin, go to Online Store → Themes → Customize and enable the RabbitPay Buy Now app embed.

Publish

Save the theme. The Buy Now button is now live on your product pages.

Use the RabbitPay JavaScript SDK to render checkout anywhere.

npm install @rabbitpay/js

<script src="https://js.rabbitpay.ai/v1"></script>
<button id="buy-now">Buy Now</button>

<script>
  const rabbitpay = RabbitPay('pk_test_your_key');

  document.getElementById('buy-now').addEventListener('click', async () => {
    const { checkout_url } = await fetch('/api/create-session', {
      method: 'POST',
    }).then(r => r.json());

    rabbitpay.checkout.open({ url: checkout_url });
  });
</script>

Install a server SDK to call the API.

Node.js

npm install @rabbitpay/node

Python

pip install rabbitpay

PHP

composer require rabbitpay/rabbitpay-php

Ruby

gem install rabbitpay

Environment configuration

Store your API keys in environment variables — never commit them.

.env

RABBITPAY_PUBLISHABLE_KEY=pk_test_...
RABBITPAY_SECRET_KEY=sk_test_...
RABBITPAY_WEBHOOK_SECRET=whsec_...

Verify the install

On a product page, the RabbitPay Buy Now button should render below Add to Cart. Clicking it opens the RabbitPay drawer. If it doesn’t appear:

Button doesn't render on the storefront

Confirm the theme app embed is enabled and the theme has been published. Clear the Shopify theme cache and reload.

401 Unauthorized on API calls

Verify you’re using the correct key for the environment. sk_test_... keys only work against api.rabbitpay.ai in test mode.

Webhooks not received

Check that your endpoint is publicly reachable and returning 2xx within 5s. See Webhooks → Debugging.

Getting Started

Integrations

API

Product

Support

Installation

Environment configuration

Verify the install

​Environment configuration

​Verify the install

Environment configuration

Verify the install