Getting ready

Welcome to Rebilly! If you haven't already signed up for a free Rebilly account, take the time to do it now. When your account is created, your sandbox is already prepared with some things you'll need to make your API requests.

How to use this guide

The purpose of this guide is to provide contextual information around Rebilly's API Reference Docs to make it easier to start an integration. Rebilly has over 300 API operations, yet you only need a handful to integrate a payment form.

First, we'll cover the prerequisites for the API guides.

If you haven't already, be sure to review our core concepts before getting started.

Finally, move to the quick start guides section. After completing a quick start guide, you will have a much more clear idea about how to utilize Rebilly's API, and should accelerate your integration significantly.


API keys

Your API key is required for authentication to the API. Each API request requires some kind of authentication. For this type of integration, we would recommend using a private key.

Our docs will automatically populate your sandbox secret key into the "try it out" feature. To use the try it out feature in the live environment, you will need to generate your API keys. For the purpose of these guides, we will only be using sandbox keys. You do NOT need to generate keys before continuing with a guide.

Organization IDs

When you sign up, your account is created with one organization and website. You will need the organization ID and website ID for making API requests (named organizationId and websiteId within most resources).

Your organization ID can be found on any Rebilly URL.

organization in url

To find your website ID, go to settings > organizations and websites.

website id

Gateway accounts

Your sandbox should come preconfigured with a test gateway (named TestProcessor).

You can add new gateway accounts if you want to test other payment methods.

You can also adjust the gateway account to support additional currencies, or whatever your heart desires.

What's next?

The core resources within Rebilly are:

  • Customers
  • Payment Instruments (eg. Tokens, Payment Cards, Bank Accounts, PayPal Accounts, and more)
  • Transactions

It's important to have a brief understanding of what these mean inside of Rebilly and how they relate to each other.

A customer represents a person or organization that may initiate transaction. The customer may be a lead or a paying customer.

They would use a payment instrument, such as a payment card, to complete the transaction.

When they purchase, they do so by creating a transaction.

This closes the loop on the most important core resources within Rebilly.

We recommend you read through the core concepts before getting started on one of our guides.