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 top right corner of the page, press your initials and then press Sandbox.

Step 3: Optionally, add a payment gateway

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, press Settings .
2. In the Configuration section, press Gateway accounts.
3. Press 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. Press 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, press Settings .
2. In the Management section, press My organization & websites.
3. On the right of the Organization details tile, press Edit.
4. Add your company logo, organization name, and other information.
5. Press 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, press Data tables, then press Customers.
2. In the right of the page, press 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, press 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, press Data tables, then press Leads.
   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 Name column, press Charlie Sullivan.
3. In the top right of the page, press , then press Collect payment.
4. Enter an amount and add a description for the payment.
5. Select the Pay with Rebilly hosted payment form option, then press Submit.
6. Press Copy URL.
7. Open the URL in a browser.
8. 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.
9. Press Continue, then press 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, press Data tables, then press Customers.
2. Press Customers, then in the Name column, press Charlie Sullivan.
3. Scroll down to Timeline. A record of the transaction is displayed.
   To view payment gateway information for the transaction, press 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, press Settings .
2. In the Pricing section, press Product & pricing plans.
3. In the right of the page, press Add product.
4. In the Name field, enter test-product.
5. Enter your product details.
6. Scroll to the bottom of the page, then press Create pricing plan.
7. Enter pricing plan details:
   1. In the Name field, enter one-time-plan.
      The ID field is automatically populated.
   2. Select a currency.
   3. Under Type, 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, press Create 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, press Data tables, then press Customers.
2. Press Customers, then in the Name column, press Charlie Sullivan.
3. In the top right of the screen, press , then press 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. Press + Select a plan, then select one-time-plan.
7. At the bottom of the page, press 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, press Data tables.
2. Press Billing and then press Unpaid invoices.
3. In the Customer column, locate the invoice for Charlie Sullivan. Then, in the Invoice number column, press the number.
4. On the invoice, press Pay invoice.
5. Select Pay with Rebilly hosted payment form, then press Submit.
6. Press 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. Press Continue, press Pay, then press Confirm.

6.4: View the paid 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, press Data tables.
2. Press Billing and then press Paid invoices.
3. Locate the invoice for Charlie Sullivan. Then, in the Invoice number column, press the number.
4. Scroll down to Timeline. A record of the transaction is displayed.
   To view payment gateway information for the transaction, press 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, press KPIs , then press Payments.
2. Mouse-over or press Sales, then press Go to report.
3. In the top left of the screen, press Transactions.
4. In the top right of the screen, press the date picker, then select a date range.
   To make a quick date range selection, on the right of the date picker, press then make a selection.
5. A payment transaction chart is displayed. For more information, Payment reports.

Related topics

• Gateway accounts
• KPIs
• Manage billing
• Manage customers
• Manage payments
• My organizations & websites
• Products and pricing
• Test payment transactions