Schedule Payments›Manage
Get schedule
One schedule including its full run history (runs).
Send your secret key in the
P-API-KEY header. Keep it on your server, never in an app or browser.Path parameters
-
schedulereference string RequiredExample:
SCH-9SC5QIH5GNLC
Responses
- 200Success
- 404Error
Request
curl --request GET \ --url 'https://api.paybeta.ng/v2/scheduled-payments/{schedulereference}' \ --header 'Accept: application/json' \ --header 'P-API-KEY: YOUR_SECRET_KEY'curl --request GET \ --url 'https://api.sandbox.paybeta.ng/v2/scheduled-payments/{schedulereference}' \ --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/{schedulereference}'); $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/{schedulereference}'); $data = $response->json();
const response = await fetch('https://api.paybeta.ng/v2/scheduled-payments/{schedulereference}', { 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/{schedulereference}', { 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/{schedulereference}", 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/{schedulereference}", headers={ "Accept": "application/json", "P-API-KEY": "YOUR_SECRET_KEY", }, ) data = response.json()
GET /v2/scheduled-payments/{schedulereference} HTTP/1.1 Host: api.paybeta.ng Accept: application/json P-API-KEY: YOUR_SECRET_KEYGET /v2/scheduled-payments/{schedulereference} 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/{schedulereference}")) .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/{schedulereference}")) .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/{schedulereference}"); 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/{schedulereference}"); 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/{schedulereference}", 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/{schedulereference}", 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/{schedulereference}") 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/{schedulereference}") 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/{schedulereference}") .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/{schedulereference}") .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/{schedulereference}")!) 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/{schedulereference}")!) 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/{schedulereference}'), 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/{schedulereference}'), headers: { 'Accept': 'application/json', 'P-API-KEY': 'YOUR_SECRET_KEY', }, ); print(response.body);
Response
{
"status": "successful",
"data": {
"reference": null,
"schedule_id": "SCH-9SC5QIH5GNLC",
"service": "airtime",
"service_label": "Airtime",
"biller": "mtn_vtu",
"biller_label": "MTN Airtime",
"biller_code": null,
"product_name": "MTN Airtime VTU",
"customer_id": "08123456780",
"customer_name": null,
"amount": 100,
"frequency": "once",
"frequency_label": "One time",
"starts_at": "2026-10-05T03:40:00+01:00",
"ends_at": null,
"next_run_at": null,
"status": "completed",
"failure_reason": null,
"can_retry": false,
"can_cancel": false,
"can_pause": false,
"can_pay_now": false,
"can_resume": false,
"resume_needs_start_at": false,
"paused_at": null,
"can_edit": false,
"archived": false,
"can_reactivate": false,
"can_delete": false,
"reactivation_needs_start_at": false,
"cancelled_at": null,
"total_runs": 1,
"last_run_at": "2026-10-05T03:40:47+01:00",
"last_run": {
"cycle": 1,
"attempt": 1,
"trigger": "auto",
"due_at": "2026-10-05T03:40:00+01:00",
"status": "delivered",
"response_description": "TRANSACTION SUCCESSFUL",
"transaction_id": "API-1791168046493950345",
"transaction_reference": "SCH-9SC5QIH5GNLC-B9AP46D6",
"amount": 100,
"charged_amount": 97,
"token": null,
"started_at": "2026-10-05T03:40:44+01:00",
"finished_at": "2026-10-05T03:40:47+01:00"
},
"description": "Airtime for Dad",
"summary": "Airtime scheduled for the beneficiary 08138539550",
"created_at": "2026-10-05T03:25:41+01:00",
"runs": [
{
"cycle": 1,
"attempt": 1,
"trigger": "auto",
"due_at": "2026-10-05T03:40:00+01:00",
"status": "delivered",
"response_description": "TRANSACTION SUCCESSFUL",
"transaction_id": "API-1791168046493950345",
"transaction_reference": "SCH-9SC5QIH5GNLC-B9AP46D6",
"amount": 100,
"charged_amount": 97,
"token": null,
"started_at": "2026-10-05T03:40:44+01:00",
"finished_at": "2026-10-05T03:40:47+01:00"
}
]
}
}
{
"success": false,
"message": "Schedule not found."
}