Who is this for?

Businesses and developers who need to pay multiple recipients (vendors, employees, partners) at once using Monieswitch.

Overview

This guide covers:
  • Preparing your bulk payout data
  • Sending bulk payouts via the API
  • Tracking payout status
  • Best practices for automation and security

Prerequisites

1

Create Monieswitch Account

A Monieswitch account. Register at Monieswitch Dashboard.
2

Get API Key

API Key from your Monieswitch dashboard.
3

Set Up Backend Server

A backend server or script to automate payouts.

1. Prepare Your Bulk Payout Data

Create a list of recipients and amounts. Example in JSON:
[
  {
    "accountNumber": "0123456789",
    "bankCode": "044",
    "amount": 5000,
    "narration": "Vendor payment"
  },
  {
    "accountNumber": "0987654321",
    "bankCode": "058",
    "amount": 7000,
    "narration": "Employee salary"
  }
]

2. Send Bulk Payouts via API

Send a POST request to the bulk payout endpoint:
POST https://nini.monieswitch.com/api/payouts/bulk
Headers:
  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json

Body:
{
  "payouts": [
    {
      "accountNumber": "0123456789",
      "bankCode": "044",
      "amount": 5000,
      "narration": "Vendor payment"
    },
    {
      "accountNumber": "0987654321",
      "bankCode": "058",
      "amount": 7000,
      "narration": "Employee salary"
    }
  ]
}

3. Track Payout Status

  • Check status via API: GET /api/payouts/bulk/{batchId}
  • Receive webhook notifications: Set up webhooks to get real-time updates on payout status.

4. Best Practices

  • Validate all recipient account details before sending payouts.
  • Use unique batch references for each payout run.
  • Secure your API keys and never expose them in client-side code.
  • Reconcile payouts using webhook notifications and API status checks.

Visit our Support page or join the Monieswitch Community for assistance.