Get bulk request

GET

https://api.paybeta.ng/v2/bulk-airtime/{{batchId}}

One request with the result for every recipient. The URL accepts the batch_id (BLK-…) or your reference.

Request

Authorization

Add parameter in header

P-API-KEY

Example:

P-API-KEY: ********************

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.paybeta.ng/v2/bulk-airtime/{{batchId}}' \
--header 'Accept: application/json' \
--header 'Accept: application/json' \
--header 'P-API-KEY: <api-key>' \
--header 'Content-Type: application/json'

Response Example

200 - Success

{
  "status": "successful",
  "message": "Bulk airtime request retrieved successfully",
  "data": {
    "reference": "PAYROLL-OCT",
    "batch_id": "BLK-K3P9XQ2M7Z1A",
    "description": "October staff airtime",
    "status": "completed",
    "total_recipients": 3,
    "total_amount": 1700.0,
    "total_charge": 1644.0,
    "amount_charged": 1450.0,
    "summary": {
      "successful": 1,
      "pending": 1,
      "failed": 1,
      "queued": 0,
      "cancelled": 0
    },
    "created_at": "2026-10-05T09:00:00+01:00",
    "started_at": "2026-10-05T09:00:02+01:00",
    "completed_at": "2026-10-05T09:00:14+01:00",
    "cancelled_at": null,
    "recipients": [
      {
        "row": 1,
        "reference": "STAFF-OCT-ADA",
        "biller": "mtn",
        "phone_number": "08031234567",
        "amount": 1000.0,
        "charged_amount": 970.0,
        "status": "delivered",
        "response_description": "TRANSACTION SUCCESSFUL",
        "transaction_id": "API-17619840121234567",
        "processed_at": "2026-10-05T09:00:12+01:00"
      },
      {
        "row": 2,
        "reference": "PAYROLL-OCT-2",
        "biller": "glo",
        "phone_number": "08051234567",
        "amount": 500.0,
        "charged_amount": 480.0,
        "status": "pending",
        "response_description": "TRANSACTION PENDING",
        "transaction_id": "API-17619840171234567",
        "processed_at": "2026-10-05T09:00:12+01:00"
      },
      {
        "row": 3,
        "reference": "PAYROLL-OCT-3",
        "biller": "airtel",
        "phone_number": "08021234567",
        "amount": 200.0,
        "charged_amount": 194.0,
        "status": "failed",
        "response_description": "Insufficient wallet balance. NGN194.00 was required but your balance was NGN50.00.",
        "transaction_id": "API-17619840221234567",
        "processed_at": "2026-10-05T09:00:12+01:00"
      }
    ]
  }
}

Modified at 2026-10-06 21:07:09

List bulk requests

Download report (CSV)