Basics

This topic describes the basics of how to use Rebilly and complete transactions in the sandbox environment using a payment card. You do not need developer experience to complete this tutorial.

Use this tutorial to learn the basics of how to use Rebilly.

Step 1: Log in or sign up

  1. Log in or sign up to Rebilly .

Step 2: Select the sandbox environment

In the left navigation bar, in the bottom left corner, click your initials and then select Sandbox.

Step 3: Optionally, add a payment gateway

attention
  • This step is optional. The sandbox environment is pre-configured with a test gateway account. If you do not want to add a payment gateway, skip this step and proceed to Step 4 .
  • To add a payment gateway, you must have a payment gateway account and a merchant account.

This step describes how to add a payment gateway account to Rebilly and configure it to accept payments made using a payment card. A payment gateway is a service which enables a business to receive payments from customers to their merchant bank account. For more information on gateway accounts, and how to configure them, see Gateway accounts.

  1. In the left navigation bar, click settings icon Settings .
  2. In the Configuration section, click Gateway accounts .
  3. Click Add gateway account .
  4. Select a gateway account.
  5. In the Gateway account ID field, enter a unique alphanumeric value. Use a value that is recognizable in your reports. This ID is used in other configuration screens, and is how this account is referenced within the API.
  6. Enter your gateway account credentials.
  7. In the Payment methods section, in the Select a payment method dropdown, select payment-card .
  8. Optionally, Configure advanced gateway settings .
  9. Click Save gateway account .

Step 4: Personalize your organization

This step describes how to personalize your organization in Rebilly by adding your company logo and organization information. For more information, see My organizations and websites.

  1. In the left navigation bar, click settings icon Settings .
  2. In the Management section, click My organization & websites .
  3. On the right of the Organization info tile, click Edit .
  4. Add your company logo, organization name, and other information.
  5. Click Save Organization .

Step 5: Complete a payment

This step describes how to set up and complete a payment.

5.1: Create a customer

This step describes how to add a new customer to Rebilly. For a complete list of customer interactions, and how to complete them, see Customers interactions.

  1. In the left navigation bar, click data tables icon Data tables , then click Customers .
  2. In the right of the page, click Add customer .
  3. Enter the following customer details:
    • ID: charlie-sullivan
    • First name: Charlie
    • Last name: Sullivan
    • Organization: Sullivan Inc
    • Address line 1: 34 South Independence Mall West
    • City: Philadelphia
    • Country: United States
    • Region: Pennsylvania
    • Postal/Zip code: 19106
    • Email: charlie.sullivan@gmail.com
  4. In the Default payment instrument section, select None .
  5. At the bottom the page, click Save customer .

5.2: Collect payment

This step describes how to use a hosted payment form to collect payment from a customer. For a complete list of payments interactions, and how to complete them, see Payments interactions.

  1. In the left navigation bar, click Data tables icon Data tables , then click Leads , then select Charlie Sullivan .
    Note: 'Leads' contains information on customers who have not made a payment yet. 'Customers' contains information on customers who have made a payment.
  2. In the right of the page, click actions icon , then click Collect payment .
  3. Enter the amount and add a description for the payment.
  4. Select the Pay with Rebilly hosted payment form option, then click Submit .
  5. Click Copy URL .
  6. Open the URL in a browser.
  7. In the hosted payment form, enter the card details:
    Note: This card does not generate a real charge.
    • Card number: 4111 1111 1111 1111 .
    • Expiration date: any future date.
    • CVV: any 3 digits.
  8. Click Continue , then click Confirm .

5.3: View the completed transaction

This step describes how to view the completed payment. For more information, see View payments activity and View payment transaction details.

  1. In the left navigation bar, click Data tables icon Data tables , then click Customers .
  2. Click Customers and then select Charlie Sullivan .
  3. Scroll down to Timeline . A record of the transaction is displayed.
    To view payment gateway information for the transaction, click the message with the approved status.

Step 6: Create an invoice and collect payment

This step describes how to create an order and pay the related invoice.

Rebilly enables merchants to manage and automate recurring payments, products and pricing, invoicing, and subscriptions.

6.1: Create a product and pricing plan

In Rebilly, products are the items that your business sells. Pricing plans are how your customers pay for the items.

This step describes one type of product and pricing plan. For more information on product and pricing plan options, see Products and pricing.

  1. In the left navigation bar, click settings icon Settings .
  2. In the Pricing section, click Product & pricing plans .
  3. In the right of the page, click Add product → .
  4. In the Product name field, enter test-product .
  5. Enter your product details.
  6. Scroll to the bottom of the page, then click Create pricing plan .
  7. Enter pricing plan details:
    1. In the Plan name field, enter one-time-plan .
      The Plan ID field is automatically populated.
    2. Select a currency.
    3. Select One time sale .
    4. In the Pricing formula dropdown, select Flat rate .
      For more information on pricing plans and formulas, see Pricing formulas .
    5. In the price per unit field, enter 22.00 .
    6. At the bottom of the page, click Add pricing plan .

6.2: Create an order on a customer's account

This step describes how to add an order to a customer's account. It creates an invoice with an unpaid status. For more information on the invoice cycle and statuses, see Invoice lifecycle.

An order is a customer's request to purchase items. It can contain subscription and one-time sale items. For a complete list of billing interactions, and how to complete them, see Billing interactions.

  1. In the left navigation bar, click Data tables icon Data tables , then click Customers .
  2. Click Customers , then select Charlie Sullivan .
  3. In the right of the screen, click Action icon , then click Create order .
  4. In the Order type section, select One time order .
  5. In the Products and plans section, in the Products dropdown, select test-product .
  6. Click + Select a plan , then select one-time-plan .
  7. At the bottom of the page, click Save order .

6.3: Pay the invoice

This step describes how to access an unpaid invoice and collect payment from a customer using a hosted payment form.

  1. In the left navigation bar, click Data tables icon Data tables .
  2. Click Billing and then click Unpaid invoices .
  3. Locate the invoice for Charlie Sullivan , and in the Invoice number column, click the invoice ID.
  4. On the invoice, click Pay invoice .
  5. Select Pay with Rebilly hosted payment form , then click Submit .
  6. Click Copy URL , then open the URL in a web browser.
  7. In the Payment card field, enter the following card details:
    Note: This card does not generate a real charge.
    • Card number: 4111 1111 1111 1111 .
    • Expiration date: any future date.
    • CVV: any 3 digits.
  8. Click Continue , click Pay , then click Confirm .
Note

To automatically create a customer and issue an invoice when collecting payment, use a Rebilly hosted checkout form. For more information, see Hosted checkout forms.

6.4: View the payed invoice and completed transaction

This step describes how to view a completed billing transaction. For a complete list of billing interactions, and how to complete them, see Billing interactions.

  1. In the left navigation bar, click Data tables icon Data tables .
  2. Click Billing and then click Paid invoices .
  3. Locate the invoice for Charlie Sullivan, and in the Invoice number column, click the ID.
  4. Scroll down to Timeline . A record of the transaction is displayed.
    To view payment gateway information for the transaction, click the message with the approved status.

7: View KPIs

This step describes how to view Key Performance Indicators (KPIs) on the payments you have completed in this tutorial.

Rebilly provides KPIs on payments, billing, KYC, and API requests. For more information, see KPIs.

  1. In the left navigation bar, click KPIs icon , then click Payments .
  2. Mouse-over or click Sales , then click Go to report ➔ .
  3. In the top of the screen, click Transactions . A payment transaction chart is displayed. For more information, Payments reports .

Related topics