Links

Send your customer a link to pay online for anything, in a single tap! No more manual invoices or external payment machines, just use your phone to collect your money.

Okra Links is an extremely simple way to request a payment. Instantly generate a link, then send it via SMS or email to your customer. They click the link and pay online via the Okra widget.

Create a link via the API

To create a payment link the API do the following;

Step 1:
Make a POST request to <https://api.okra.ng/v2/pay/link/create>

Step 2:
Fill in the appropriate request payloads, like the sample you see on the request payload tab.

curl -X POST https://api.okra.ng/v2/pay/link/create
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <secretKey>'

{
    "amount": NUMBER (at least 100),
    "name": STRING,
    "currency": "NGN", 
    "note": STRING,
    "logo": STRING,
    "countries": ["NG"],
    "schedule": { //only required if type is recurring
       "interval": STRING, // 'daily', 'monthly', 'weekly', 'quarterly', or 'yearly' defailts to monthly
       "startDate": 'YYYY-MM-DD', // If blank will default to today
         "endDate": 'YYYY-MM-DD' //If blank will not stop
     }, 
    "color": STRING, //hex 
    "type": STRING, "one-time" or "recurring" // defaults to one-time
    "account": OBJECTID, //id of company account chosen
    "support_email": STRING, //required
    "data": BOOLEAN, //enable data pulling (e.g. balance, transactions, etc)
    "success_url": STRING,
    "callback_url": STRING,
    "continue_cta": STRING //what the button says at the end
}

{
    "status": "success",
    "message": "Payment link suceccefully created!",
    "data": {
        "status": true,
                "link": {
                            "url": "pay.okra.ng/SHORT_URL",
                            "surl": "okr.to/SHORT_URL"
                            "qr": "IMAGE",
                            ... additional link details
                    }
    }
}

📘

Note that the default currency in a payment link is NGN.

📘

No code? No problem, you can create and customise the appearance of payment links directly from your dashboard — Click here to try it out.

Create a link via the dashboard

Step1
After a successful login to your dash, click on Payment on the side nav otherwise, click here to get to the page. Next, click on the “Add a new payment link” to proceed.

👍

There are three payment links; we have the one-time payment link, the recurring payment link, and the future payment authorization but in this tutorial we will explain how the one-time payment link works.

🚧

You can also visit the dashboard if you don't want to navigate to the page through the side nav.

Step2
Select “Payment Link” on the sub-menu and select any type of link.

Step3
Complete the form by entering the Payment link name, and the amount to be paid.

Customize links via the widget

You can customize a link when integrating Okra into your app via the widget.
This guide will you get started on this.

Note: You can also customize a link in your dashboard when making one-time payments by checking the "I want the customer to choose the amount to pay" box, this allows the customer to decide the amount to pay you.
The other input details are similar to the previous section.

Share link

You can share your newly created link with anyone to collect payments via SMS, Phone Number.

📘

Sharing your payment link via WhatsApp is in progress

Returning users

The Okra widget makes collecting payments from a regular user, otherwise known as a returning user, simple.
During widget customization, pass in the usersbvn, nin, or email into your widget options. This will eliminate the need to pass in their credentials during payment, hence facilitating the time to make payment.
Check here for a comprehensive returning users guide.

🚧

Additional Info

You could also include the direct email address you want this link shared with, WhatsApp enabled number you want the payment link to be sent to.
You could also specify form fields to collect specific data, please refer to the image below

🎉 With these steps, you can successfully create a payment link for your customers, and start receiving payments from anybody by simply sending a link.