Creating Payment Links💰

Learn How to Create a Link to Accept Payments for Your Customers

Overview

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.

Generate a payment link via the API

To create a payment link the API do the following;

Step1:
Make a POST request to https://api.okra.ng/v2/pay/link/create

Step2:
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
                    }
    }
}

📘

Not a Developer?

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

How create a payment 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.

🚧

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 click on the continue button 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.

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

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

🚧

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

Receive Payouts

In order for you to receive funds, Okra (or your platform via our API) makes payouts to your connected bank account.

Payout availability depends on a number of factors such as the industry and country you’re operating in, and the risks involved. When you start processing live payments from your customers with Okra, you won’t receive your first payout until 7–14 days after receiving your first successful payment. The first payout usually takes a little longer in order to establish the Okra account. Processing subsequent payouts then happen according to your account’s payout schedule.

You can view a list of all of your payouts and the date that they are expected to be received in your bank account in the Dashboard.

Payout Schedule

By default, Okra automatically creates payouts of your available account balance based on the schedule specified in the Dashboard. The schedule depends on your country and whether your business operates in a higher-risk industry.

When a payment is first received, it’s initially reflected as a pending balance (less any bank or Okra fees). This balance becomes available according to your payout schedule. For instance, it takes seven calendar days from a payment being received to it being paid out for Okra accounts on a 7 calendar day schedule.

Most banks deposit payouts into your bank account as soon as they receive them, though some may take a few extra days to make them available.

Manual Payouts

If you turn off automatic payouts in the Dashboard, you can manually send funds to your bank account. You can do this either in the Payouts section of the Dashboard or by creating payouts using the API.

curl -X POST https://api.okra.ng/v2/pay/payout
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <secretKey>'
-d '{ 
        account_to_credit: "5fe0a6f8ee69d878a679ef39"
    }'
curl -X POST https://api.okra.ng/v2/pay/payout
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <secretKey>'
-d '{ 
        nuabn: "1111111111",
        bank: Okra Bank ID
    }'
{
    "status": "success",
    "message": "Payout successfully initiated!",
    "data": {
        "payout": {
            "status": "initiated",
            "_id": "60125b7eec6d18084871cf53",
            "amount": 10000,
            "ref": "9klUm7uavRTL8Mw",
            "fee": 10.75,
            "account_to_credit": "5fc7bd32ac84294a78653e31",
            "nuban_to_credit": {
                "nuban": "1329137339",
                "bank": "5d6fe57a4099cc4b210bbec0"
            },
            "initiated_by": "5da4c3564d32480a24663fab2",
            "env": "production",
            "created_at": "2021-01-28T06:36:46.953Z",
            "last_updated": "2021-01-28T06:36:46.953Z",
        }
    }
}

Instant Payouts

With Instant Payouts, you can instantly send funds to a supported bank account. You can request Instant Payouts 24/7, including weekends and holidays, and funds typically appear in the associated bank account within 30 minutes.

New Okra users aren’t immediately eligible for Instant Payouts. You request this feature by sending a request to [email protected].

Payment Limits

When you get approved by Okra to begin accepting payments, you will have a default set of limits with the minimum debit amount being N100. You can contact [email protected] at anytime to request a limit increase.

Limit Type

🇺🇸 USD

🇳🇬 NGN

Per Transaction

$50

N15,000

Daily

$250

N100,000

Weekly

$500

N250,000

Monthly

$2,500

N1,000,000

Payment Object

This table contains all of the payments fields in the respective endpoints.

Field

Description

id
ObjectID

Unique Auth ID (Unique Okra Identifier)

available_balance
Number

Amount of available funds in the account

ledger_balance
Number

The closing balance of the account

account
ObjectID

Unique account ID (Unique Okra Identifier)

connected
Boolean

Customer connection status (Did they choose to connect this account to you?)

customer
ObjectID

Unique customer ID (Unique Okra Identifier)

See Manage Customers ]

record
ObjectID

Unique record ID (Unique Okra Identifier)

See Records

owner
ObjectID

Unique company ID (Unique Okra Identifier) (Your Client Token)

env
String

Okra API Env the Auth was pulled from production or production-sandbox

created_at
Date

Date of Authentication

last_updated
Object

Last date of Authentication

Conclusion: With these steps, you can successfully create a payment for your customers with ease.


What's Next
Did this page help you?