Buy Bulk Airtime API
Cancel
Stop recipients that have not started yet (they become cancelled, not charged). Numbers already processed are not affected.
Send your secret key in the
P-API-KEY header. Keep it on your server, never in an app or browser.Responses
- 200Success
- 422Error
Request
curl --request POST \ --url 'https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'P-API-KEY: YOUR_SECRET_KEY'curl --request POST \ --url 'https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'P-API-KEY: YOUR_SECRET_KEY'
<?php use Illuminate\Support\Facades\Http; $response = Http::withHeaders([ 'Accept' => 'application/json', 'Content-Type' => 'application/json', 'P-API-KEY' => 'YOUR_SECRET_KEY', ])->post('https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel'); $data = $response->json();<?php use Illuminate\Support\Facades\Http; $response = Http::withHeaders([ 'Accept' => 'application/json', 'Content-Type' => 'application/json', 'P-API-KEY' => 'YOUR_SECRET_KEY', ])->post('https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel'); $data = $response->json();
const response = await fetch('https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel', { method: 'POST', headers: { "Accept": "application/json", "Content-Type": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, }); const data = await response.json();const response = await fetch('https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel', { method: 'POST', headers: { "Accept": "application/json", "Content-Type": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, }); const data = await response.json();
import requests response = requests.request( "POST", "https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel", headers={ "Accept": "application/json", "Content-Type": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, ) data = response.json()import requests response = requests.request( "POST", "https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel", headers={ "Accept": "application/json", "Content-Type": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, ) data = response.json()
POST /v2/bulk-airtime/batchId/cancel HTTP/1.1 Host: api.paybeta.ng Accept: application/json Content-Type: application/json P-API-KEY: YOUR_SECRET_KEYPOST /v2/bulk-airtime/batchId/cancel HTTP/1.1 Host: api.sandbox.paybeta.ng Accept: application/json Content-Type: application/json P-API-KEY: YOUR_SECRET_KEY
import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel")) .header("Accept", "application/json") .header("Content-Type", "application/json") .header("P-API-KEY", "YOUR_SECRET_KEY") .method("POST", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel")) .header("Accept", "application/json") .header("Content-Type", "application/json") .header("P-API-KEY", "YOUR_SECRET_KEY") .method("POST", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());
using System.Net.Http; using System.Text; using var client = new HttpClient(); var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel"); request.Headers.TryAddWithoutValidation("Accept", "application/json"); request.Headers.TryAddWithoutValidation("P-API-KEY", "YOUR_SECRET_KEY"); var response = await client.SendAsync(request); var data = await response.Content.ReadAsStringAsync(); Console.WriteLine(data);using System.Net.Http; using System.Text; using var client = new HttpClient(); var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel"); request.Headers.TryAddWithoutValidation("Accept", "application/json"); request.Headers.TryAddWithoutValidation("P-API-KEY", "YOUR_SECRET_KEY"); var response = await client.SendAsync(request); var data = await response.Content.ReadAsStringAsync(); Console.WriteLine(data);
package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("POST", "https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel", nil) req.Header.Set("Accept", "application/json") req.Header.Set("Content-Type", "application/json") req.Header.Set("P-API-KEY", "YOUR_SECRET_KEY") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data)) }package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("POST", "https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel", nil) req.Header.Set("Accept", "application/json") req.Header.Set("Content-Type", "application/json") req.Header.Set("P-API-KEY", "YOUR_SECRET_KEY") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data)) }
require "net/http" require "json" uri = URI("https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel") request = Net::HTTP::Post.new(uri) request["Accept"] = "application/json" request["Content-Type"] = "application/json" request["P-API-KEY"] = "YOUR_SECRET_KEY" response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end data = JSON.parse(response.body)require "net/http" require "json" uri = URI("https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel") request = Net::HTTP::Post.new(uri) request["Accept"] = "application/json" request["Content-Type"] = "application/json" request["P-API-KEY"] = "YOUR_SECRET_KEY" response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end data = JSON.parse(response.body)
import okhttp3.MediaType.Companion.toMediaType import okhttp3.OkHttpClient import okhttp3.Request import okhttp3.RequestBody.Companion.toRequestBody val client = OkHttpClient() val request = Request.Builder() .url("https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel") .method("POST", "".toRequestBody(null)) .addHeader("Accept", "application/json") .addHeader("Content-Type", "application/json") .addHeader("P-API-KEY", "YOUR_SECRET_KEY") .build() client.newCall(request).execute().use { response -> println(response.body?.string()) }import okhttp3.MediaType.Companion.toMediaType import okhttp3.OkHttpClient import okhttp3.Request import okhttp3.RequestBody.Companion.toRequestBody val client = OkHttpClient() val request = Request.Builder() .url("https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel") .method("POST", "".toRequestBody(null)) .addHeader("Accept", "application/json") .addHeader("Content-Type", "application/json") .addHeader("P-API-KEY", "YOUR_SECRET_KEY") .build() client.newCall(request).execute().use { response -> println(response.body?.string()) }
import Foundation var request = URLRequest(url: URL(string: "https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel")!) request.httpMethod = "POST" request.setValue("application/json", forHTTPHeaderField: "Accept") request.setValue("application/json", forHTTPHeaderField: "Content-Type") request.setValue("YOUR_SECRET_KEY", forHTTPHeaderField: "P-API-KEY") let (data, _) = try await URLSession.shared.data(for: request) print(String(data: data, encoding: .utf8)!)import Foundation var request = URLRequest(url: URL(string: "https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel")!) request.httpMethod = "POST" request.setValue("application/json", forHTTPHeaderField: "Accept") request.setValue("application/json", forHTTPHeaderField: "Content-Type") request.setValue("YOUR_SECRET_KEY", forHTTPHeaderField: "P-API-KEY") let (data, _) = try await URLSession.shared.data(for: request) print(String(data: data, encoding: .utf8)!)
import 'package:http/http.dart' as http; final response = await http.post( Uri.parse('https://api.paybeta.ng/v2/bulk-airtime/batchId/cancel'), headers: { 'Accept': 'application/json', 'Content-Type': 'application/json', 'P-API-KEY': 'YOUR_SECRET_KEY', }, ); print(response.body);import 'package:http/http.dart' as http; final response = await http.post( Uri.parse('https://api.sandbox.paybeta.ng/v2/bulk-airtime/batchId/cancel'), headers: { 'Accept': 'application/json', 'Content-Type': 'application/json', 'P-API-KEY': 'YOUR_SECRET_KEY', }, ); print(response.body);
Response
{
"status": "successful",
"message": "Bulk request cancelled. 2 recipient(s) that had not started were skipped.",
"data": {
"reference": "PAYROLL-OCT",
"batch_id": "BLK-K3P9XQ2M7Z1A",
"description": "October staff airtime",
"status": "cancelled",
"total_recipients": 3,
"total_amount": 1700,
"total_charge": 1644,
"amount_charged": 970,
"summary": {
"successful": 1,
"pending": 0,
"failed": 0,
"queued": 0,
"cancelled": 2
},
"created_at": "2026-10-05T09:00:00+01:00",
"started_at": null,
"completed_at": null,
"cancelled_at": "2026-10-05T09:00:06+01:00",
"recipients": [
{
"row": 1,
"reference": "STAFF-OCT-ADA",
"biller": "mtn",
"phone_number": "08031234567",
"amount": 1000,
"charged_amount": 970,
"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,
"charged_amount": null,
"status": "cancelled",
"response_description": "Cancelled by merchant before processing.",
"transaction_id": null,
"processed_at": null
},
{
"row": 3,
"reference": "PAYROLL-OCT-3",
"biller": "airtel",
"phone_number": "08021234567",
"amount": 200,
"charged_amount": null,
"status": "cancelled",
"response_description": "Cancelled by merchant before processing.",
"transaction_id": null,
"processed_at": null
}
]
}
}
{
"status": "failed",
"message": "This bulk request has already finished.",
"data": null
}