Manage cashbacks

Let's look at some of the features available for managing a cashback object.

Creating a cashback via Web application

You can create a cashback by filling out the details, such as type, end date, name, and many others, in the form available on the Speed web application.

Log in to your account and follow the steps below to create a cashback.

1. On the left sidebar, click Send Payments > Cashback.
2. Click Create New.
3. After clicking the Create New button, you are redirected to a Create page. Fill out the required details like name, type, amount, and start date.
4. Click the create cashback button. This will redirect you to the detail page, where you can see the cashback you created and its details.
5. Now, associate it with different Speed resources and send rewards.

Associate a Cashback

You can associate a cashback with multiple Speed receive payment resources using both Speed web application and API. Let us see the steps in detail.

Associate Via Web application:

While creating any of the mentioned below Speed receive payments resource through the web application, you can associate a single cashback.

• Checkout link
• Payment link

For this, log in to your account and follow the steps below:

1. On the left sidebar, click Receive Payments > Checkout/ Payment Links.
2. Click Create New.
3. After clicking the Create New button, you are redirected to a Create page. Fill out the required details.
4. In this form, you will find the “Add Cashback” checkbox under the options section. Tick the checkbox and select a single cashback from the list of available cashbacks.

💡

One payment link/ checkout link can have only one cashback associated at a time, but one cashback can be associated with multiple payment links/ checkout links at a time.

Associate Via APIs:

While creating any of the mentioned below Speed receive payments resource through different APIs, you can associate a single cashback.

1. Checkout link /checkout-links
2. Payment link /payment-links
3. Checkout session /checkout-sessions

While calling these endpoints, add basic details such as amount, and currency, and you have an option also to add a cashback id.

In this example below, we'll show you how you can create a checkout link for your customer and associate a cashback.

Make a POST /checkout-links request specifying the following parameters.

• amount
• currency
• cashback.id

{
"currency": "USD",
"amount": 200,
"cashback": {
"id": "cb_ljfg8uiou63JbYPX"
}
}

Retrieve a cashback

Through the cashback APIs listed below or the Speed web application, you can view a list of all cashback objects associated with checkouts/payment links/checkout sessions.

• Retrieve a cashback → GET→ /cashbacks/{Id}
• List all cashbacks → GET → /cashbacks

Claiming a cashback

Once the checkout session is marked as paid, i.e., the customer has made a full payment, a cashback pop-up will appear containing a QR code of the amount derived based on that cashback.

Your customer can scan the QR code in their LNURL-supported lightning wallet and receive a defined cashback amount.

How does a failed cashback claim work?

If a cashback transaction (debit) is currently processing in an account and another transaction is requested simultaneously, the new transaction will not be processed until the current cashback transaction is completed. This means that such a newer transaction would fail and prompt you with an error.

Also, if the ongoing cashback withdrawal fails due to any reason, the withdrawal will be reversed, and the cashback amount deducted earlier will be restored to the account balance along with the network fees.

Deactivate a cashback

Cashback can be deactivated in multiple ways.

• If you want to deactivate a cashback, you can explicitly and manually deactivate through the Speed web application.
• In contrast, a cashback is deactivated automatically when its expiry is over i.e., after the end date.