Developer docs
/
Deposits
/
Hosted deposit API integration
Last updated

These docs are intended for a developer audience.

Hosted deposit API integration

This topic describes how to integrate a Rebilly hosted deposit form into your website, or checkout flow, using the Rebilly API.

The interactive steps in this guide are configured with sample data using a mock server. To use the steps in your own environment, replace the sample data with your own data.

Step 1: Optional: Get a secret API key and website ID

Complete this step to use your own API key and website ID in the steps in this guide. The interactive elements in this guide are configured with sample data in the Rebilly sandbox environment. Skip this step to use the sample data in interactive examples in this guide.

Important
  • An active gateway is required to complete a payment using a Rebilly hosted deposit. If you would like to complete a payment flow, see set up a payment gateway.
  • If you are testing in the sandbox environment, a test payment gateway called TestProcessor is already configured.
  1. Obtain your organization ID and website ID:
    1. In the left navigation bar, click Settings .
    2. In the Management section, click My organization & websites.
    3. In the Organization details section, note the ID value.
    4. In the Website section, note the ID value. For more information, see Organizations and websites.
  2. Obtain your secret API key:
    1. In the left navigation bar, click Automations .
    2. In the Development section, click API keys.
    3. Optionally, if you have not created a secret key:
      1. In top right of the screen, click Add API.
      2. In the API key type section, select Secret, then complete the form and click Save API key.
      3. Go back to the API Keys page.
    4. Select a secret key and copy the Key value.

Step 2: Upsert a customer

This step creates or updates (upserts) a customer with a specified ID.

This operation prevents duplicate customers. If the customer already has an identifier within your system, that customer is updated. If the customer does not have an identifier, a new customer is created.

For detailed information about this API operation, see Upsert a customer.

Interactive example

This example creates a customer with a specified ID.

  1. Click Security, then in the REB-APIKEY field, enter any alphanumeric value. Alternatively, use your own API key. For more information, see Step 1.
  2. Optionally, if you are using your own data, click Body, then enter your own websiteId value.
  3. Click Parameters, then in the id field, enter any value.
  4. Click Send.

The id value from this response is used as the customerId value when creating the deposit request in Step 3. The websiteId value is also used in Step 3.

Loading...

Step 3: Create a deposit request

This step creates a deposit request using the customer that you created, and website ID that you obtained, in the previous step. When the customer opens the URL included in the response, a Rebilly hosted deposit form is displayed to complete the deposit.

In the response, in the _links field, under "rel": "deposit", the href field contains the deposit URL.

For detailed information about this API operation, see Create a deposit request.

Interactive example

This example creates a deposit request.

  1. Click Security, then in the REB-APIKEY field, enter any numeric value. Alternatively, use your own API key. For more information, see Step 1.
  2. Click Body, and enter the following:
    • In the websiteId field, enter the websiteId value from the Step 2. Or, use your own website ID.
    • In the customerId field, enter the id value from the Step 2 response.
  3. Optionally, to present fixed amounts in the deposit request:
    • In the amounts field, enter the array of amounts that you want to present in the deposit request. For example, [100, 200, 300].
    • In the customAmount field, enter null value to disable the custom amount option. Specify minimum, maximum, and multipleOf to enable the custom amount option.
  4. Optionally, to apply a specific strategy for the request use the strategyId field. To learn more about deposit strategies, see Deposit strategies.
  5. Optionally, to apply a deposit amount limit, in the amountLimits field, specify minimum and maximum amount values. Limits override amounts and customAmount values.
  6. Click Send.
  7. In the response, expand the _links field, then under "rel": "deposit", the href value is the deposit URL.
Note

The below example uses a mock documentation server by default, and does not generate a deposit form URL. Use your own API key against the sandbox to generate a deposit URL.

Loading...

Step 4: Redirect the customer to the deposit URL to complete the deposit

Redirect the customer to the deposit URL that you created in Step 3. After completing the deposit form, the hosted payment form is displayed to complete the deposit.

Previous page
Next page