Schedule Payments›Setup
Bundles
Services, billers, frequencies and meter types accepted by Create, plus min_lead_minutes and the timezone used for dates.
Send your secret key in the
P-API-KEY header. Keep it on your server, never in an app or browser.Responses
- 200Success
Request
curl --request GET \ --url 'https://api.paybeta.ng/v2/scheduled-payments/options' \ --header 'Accept: application/json' \ --header 'P-API-KEY: YOUR_SECRET_KEY'curl --request GET \ --url 'https://api.sandbox.paybeta.ng/v2/scheduled-payments/options' \ --header 'Accept: application/json' \ --header 'P-API-KEY: YOUR_SECRET_KEY'
<?php use Illuminate\Support\Facades\Http; $response = Http::withHeaders([ 'Accept' => 'application/json', 'P-API-KEY' => 'YOUR_SECRET_KEY', ])->get('https://api.paybeta.ng/v2/scheduled-payments/options'); $data = $response->json();<?php use Illuminate\Support\Facades\Http; $response = Http::withHeaders([ 'Accept' => 'application/json', 'P-API-KEY' => 'YOUR_SECRET_KEY', ])->get('https://api.sandbox.paybeta.ng/v2/scheduled-payments/options'); $data = $response->json();
const response = await fetch('https://api.paybeta.ng/v2/scheduled-payments/options', { method: 'GET', headers: { "Accept": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, }); const data = await response.json();const response = await fetch('https://api.sandbox.paybeta.ng/v2/scheduled-payments/options', { method: 'GET', headers: { "Accept": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, }); const data = await response.json();
import requests response = requests.request( "GET", "https://api.paybeta.ng/v2/scheduled-payments/options", headers={ "Accept": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, ) data = response.json()import requests response = requests.request( "GET", "https://api.sandbox.paybeta.ng/v2/scheduled-payments/options", headers={ "Accept": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, ) data = response.json()
GET /v2/scheduled-payments/options HTTP/1.1 Host: api.paybeta.ng Accept: application/json P-API-KEY: YOUR_SECRET_KEYGET /v2/scheduled-payments/options HTTP/1.1 Host: api.sandbox.paybeta.ng Accept: 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/scheduled-payments/options")) .header("Accept", "application/json") .header("P-API-KEY", "YOUR_SECRET_KEY") .method("GET", 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/scheduled-payments/options")) .header("Accept", "application/json") .header("P-API-KEY", "YOUR_SECRET_KEY") .method("GET", 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("GET"), "https://api.paybeta.ng/v2/scheduled-payments/options"); 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("GET"), "https://api.sandbox.paybeta.ng/v2/scheduled-payments/options"); 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("GET", "https://api.paybeta.ng/v2/scheduled-payments/options", nil) req.Header.Set("Accept", "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("GET", "https://api.sandbox.paybeta.ng/v2/scheduled-payments/options", nil) req.Header.Set("Accept", "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/scheduled-payments/options") request = Net::HTTP::Get.new(uri) request["Accept"] = "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/scheduled-payments/options") request = Net::HTTP::Get.new(uri) request["Accept"] = "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/scheduled-payments/options") .method("GET", null) .addHeader("Accept", "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/scheduled-payments/options") .method("GET", null) .addHeader("Accept", "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/scheduled-payments/options")!) request.httpMethod = "GET" request.setValue("application/json", forHTTPHeaderField: "Accept") 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/scheduled-payments/options")!) request.httpMethod = "GET" request.setValue("application/json", forHTTPHeaderField: "Accept") 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.get( Uri.parse('https://api.paybeta.ng/v2/scheduled-payments/options'), headers: { 'Accept': 'application/json', 'P-API-KEY': 'YOUR_SECRET_KEY', }, ); print(response.body);import 'package:http/http.dart' as http; final response = await http.get( Uri.parse('https://api.sandbox.paybeta.ng/v2/scheduled-payments/options'), headers: { 'Accept': 'application/json', 'P-API-KEY': 'YOUR_SECRET_KEY', }, ); print(response.body);
Response
{
"success": true,
"data": {
"services": [
{
"key": "airtime",
"label": "Airtime",
"billers": [
{
"biller": "mtn_vtu",
"name": "MTN Airtime",
"has_bundles": false
}
]
},
{
"key": "data",
"label": "Internet Data",
"billers": [
{
"biller": "mtn_data",
"name": "MTN Data",
"has_bundles": true
}
]
},
{
"key": "cabletv",
"label": "Cable TV",
"billers": [
{
"biller": "dstv",
"name": "DStv",
"has_bundles": true
}
]
},
{
"key": "electricity",
"label": "Electricity",
"billers": [
{
"biller": "ikeja-electric",
"name": "Ikeja Electric - IKEDC",
"has_bundles": false
}
]
}
],
"frequencies": [
{
"key": "once",
"label": "One time"
},
{
"key": "daily",
"label": "Daily"
},
{
"key": "weekly",
"label": "Weekly"
},
{
"key": "monthly",
"label": "Monthly"
}
],
"meter_types": [
{
"key": "prepaid",
"label": "Prepaid Meter"
},
{
"key": "postpaid",
"label": "Postpaid Meter"
}
],
"min_lead_minutes": 10,
"timezone": "Africa/Lagos"
}
}