Bulk Payments API

Stable Payments

This API handles bulk payment processing for multiple beneficiaries with support for batch submission, status checking, and callback notifications.

Overview

Use Cases

Batch Submission
Status Check
Callback notifications

Key Features

Process multiple payments simultaneously
Real-time batch status tracking
Automatic callback notifications
Comprehensive error handling

API Endpoints

POST /api/v1/payments/bulk

Submit Bulk Payment

Process multiple payments in a single transaction for efficiency

Parameters

batchId string Required

Unique batch identifier

accountCode string Required

Source account code

totalAmount string Required

Total batch amount

beneficiaries object Required

Array of beneficiary objects

institution string Required

Institution identifier

callbackURL string

Callback URL for status updates

Code Examples

Example requests for the Bulk Payments API

curl -X POST "https://api.nmbbank.com/v1/payments/bulk" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "batchId": "334877144",
    "consoleReq": "Y",
    "batchDate": "20210810",
    "institution": "PSSSF",
    "accountCode": "24710004585",
    "accountDescription": "PVNTBKN 0003082 PSSSF Payment",
    "totalAmount": "50000.00",
    "userid": "user.id",
    "callbackURL": "https://yourapp.com/callback",
    "beneficiaries": {
      "beneficiary": [
        {
          "ROWNUM": "1",
          "NAME": "NOEL EMMANUEL MAHUNDA",
          "CURRENCY": "TZS",
          "amount": "50000.00",
          "ACCOUNT": "41510027904",
          "channelIdentifier": "INTERNAL",
          "destinationCode": "NMB",
          "endToEndId": "2000000841",
          "OWNREFERENCE": "18000",
          "NARRATION": "PV N T B KN 0003082 PSSSF Payment"
        }
      ]
    }
  }'

const response = await fetch('https://api.nmbbank.com/v1/payments/bulk', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    batchId: '334877144',
    consoleReq: 'Y',
    batchDate: '20210810',
    institution: 'PSSSF',
    accountCode: '24710004585',
    accountDescription: 'PVNTBKN 0003082 PSSSF Payment',
    totalAmount: '50000.00',
    userid: 'user.id',
    callbackURL: 'https://yourapp.com/callback',
    beneficiaries: {
      beneficiary: [
        {
          ROWNUM: '1',
          NAME: 'NOEL EMMANUEL MAHUNDA',
          CURRENCY: 'TZS',
          amount: '50000.00',
          ACCOUNT: '41510027904',
          channelIdentifier: 'INTERNAL',
          destinationCode: 'NMB',
          endToEndId: '2000000841',
          OWNREFERENCE: '18000',
          NARRATION: 'PV N T B KN 0003082 PSSSF Payment'
        }
      ]
    }
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.nmbbank.com/v1/payments/bulk"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
    "batchId": "334877144",
    "consoleReq": "Y",
    "batchDate": "20210810",
    "institution": "PSSSF",
    "accountCode": "24710004585",
    "accountDescription": "PVNTBKN 0003082 PSSSF Payment",
    "totalAmount": "50000.00",
    "userid": "user.id",
    "callbackURL": "https://yourapp.com/callback",
    "beneficiaries": {
        "beneficiary": [
            {
                "ROWNUM": "1",
                "NAME": "NOEL EMMANUEL MAHUNDA",
                "CURRENCY": "TZS",
                "amount": "50000.00",
                "ACCOUNT": "41510027904",
                "channelIdentifier": "INTERNAL",
                "destinationCode": "NMB",
                "endToEndId": "2000000841",
                "OWNREFERENCE": "18000",
                "NARRATION": "PV N T B KN 0003082 PSSSF Payment"
            }
        ]
    }
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

Response Examples

Success Response

{
  "payload": {
    "respStatus": "Success",
    "respCode": "00",
    "respHeader": {
      "FileNumber": "263145370909",
      "BatchId": "005421895",
      "BatchDate": "2021-09-09T10:03:32.907+03:00"
    },
    "respBody": {
      "message": "Batch 005421895 submitted successful"
    }
  }
}

Quick Info

Base URL: https://www.fintech.nmbbank.co.tz

Authentication: Bearer Token

Content Type: application/json

Support

Need help with this API? Contact our support team.