Quickstart
Learn how to create your first payment link by integrating our API and start processing payments across Latin America in 3 simple steps.
Or if you wish to integrate payment forms directly into your web applications, our JavaScript SDK is available for securely collecting payment information and processing transactions.
Step 1: Create a Plan or Product
To generate a payment link, you first need to create a plan or a product to which the payment link will be associated. A plan or product is a representation of the item or service you want to sell.
However, you can skip this step if you want to create an Instant Payment Link instead.
Use the following API endpoint to create a new plan:
Loading...
After executing this request, you'll receive a response containing the unique ID of the created plan, like this:
Response
{
"plan": {
"id": "example-plan-id-1234", // unique ID of the plan
"name": "Basic Subscription",
"description": "Monthly subscription plan.",
"frequency": {
"type": "months",
"quantity": 1
},
// more plan details...
}
}
Step 2: Create a Payment Link
Generate a payment link associated to your product or plan. See our API reference for more details on these endpoints and how to populate the request body. Remember that currencies are limited to the ones set in the plan or product you are associating the payment link with.
Use the following API endpoint to create a payment link:
Loading...
Step 3: Share the Payment Link
After executing this request, you'll receive a response containing the unique ID of the created payment link, as shown below:
Response
{
"id": "5555fd46-0726-4840-8c12-783353800b4c"
}
Get the url of the payment link by appending your organization alias & the payment link ID to the base URL, like this:
https://pay.rebill.com/{organization_alias}/{payment_link_id}
If you don't have your organization alias, you can find it in the dashboard's settings or you may use this endpoint.
Share this URL with your customers through email, SMS, or embed them on your website. Customers can click on the link and make payments using the secure Checkout Landing provided by our platform.
Instant Payment Links
You can also create Instant Payment Links, which are one-time payment links that can be used to collect payments for a specific amount without needing to associate them to a product or plan.
Use the Instant Links API to create these links.
Additional Information
- Updating Plan Status: You can update a plan's status using the appropriate API endpoints.
Integrate Payment Forms
Remember that our JavaScript SDK is available for securely integrating payment forms directly into your web applications. Utilize the SDK for collecting payment information securely if you plan to process payments directly on your site, adhering to PCI DSS standards.