Bulk Payments

This section describes how to setup and initiate a bulk payment

Overview

Making one-time or recurring payments seems like an easy task to do, but have you ever considered initiating multiple debit payments for over a hundred users? You will agree the process is tiring if you follow the one-time payment procedure.
Initiating multiple payments like salary, commissions at a high volume requires a more efficient method known as a bulk payments.

In this section, you will learn what bulk payments are and how you can initiate bulk payments using Okra API.

What is Bulk Payments?

Bulk payments, also known as mass payments or batch payments, is simply a system that allows you to initiate multiple debit payments to a bulk list.
A bulk list represents a list of credit accounts you wish to pay from your debit account.

Now that you know what bulk payments are, in the next section you'll learn how to implement this feature using our API.

How to Implement Bulk Payment via the API

The bulk payment feature allows you to make bulk payment from a bulk list.
The endpoint accepts a POST request, with product and file as required parameters.
The product parameter takes initiate_payment as value, while file requires you to upload a CSV file.

Key

Value

file

your_CSV_file

product

initiate_payment

This endpoint returns the following details:

✔ file name
✔ owner id
✔ product
✔ status
✔ user id

📘

NOTE

This CSV file is the bulklist

What will the CSV file(bulk list) look like?

The bulk list which has to be in a CSV format must have the following columns;

  • account_to_debit - This involves the account that makes the payment
  • account_to_credit - This refers to the accounts payments will be made to
  • amount - The amount in figures
  • currency - NGN
  • callback_url - A callback URL

📘

Disclaimer

The bulk payment is currently available via the Okra API, we are working tirelessly to make it accessible via the widget soonest.

Prerequisite

  1. If you're on a sandbox mode, ensure you create a customer using this guide.
  2. Setup your webhook
curl -X POST https://api.okra.ng/v2/bulkfiles/initiate
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <secretKey>'
-d '{
    "account_to_debit":  ACCOUNT ID,
    "account_to_credit": ACCOUNT ID,
        "amount": 10000, //kobo e.g. 100.00 naira = 10000,
        "currency": "NGN" // only NGN supported for now,
    "callback_url": "a valid webhook url"
}'
{
    "status": "success",
    "message": "File successfully uploaded",
    "data": {
        "id": "xxxxxxxxxx",
        "file_name": "yourcsvfile.csv",
        "owner": "xxxxxxxxxx",
        "product": "initiate_payment",
        "status": "in-progress",
        "user": "xxxxxxxxxx"
    }
}

Did this page help you?