Get Bulk Job Status

GET /secure/bulkpaymentrequests/getbulkjobbyreference

Try it

Parameters

reference*query

Request sampleLanguage

curl -X GET 'https://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreference?reference=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response exampleStatus

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "dateCreated": "2026-01-15T09:30:00Z",
    "dateModified": "2026-01-15T09:30:00Z",
    "jobStatus": "Error",
    "jobReference": "<jobReference>",
    "notifyUrl": "https://example.com/notifyurl"
  }
]

Built from the response schema. Values are placeholders, not real data.

GEThttps://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreferenceProduction

The status of a bulk job, by the job reference used when it was created. Limited to a seven day window.

Authentication

Bearer token
The token generated by the Get API token operation. The same token is used for every request until it expires.

Query parameters

reference string required
Use the Job Reference that was used when creating a new bulk job via Create endpoint
max length100

Responses

200 OK

array of BulkJobStatus

Request

curl -X GET 'https://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreference?reference=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreference?reference=string");
request.Headers.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreference?reference=string',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_ACCESS_TOKEN',
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

const response = await fetch("https://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreference?reference=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
  },
});

const data = await response.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
}

response = requests.get(
    "https://api.ozow.com/secure/bulkpaymentrequests/getbulkjobbyreference?reference=string",
    headers=headers,
)

Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "dateCreated": "2026-01-15T09:30:00Z",
    "dateModified": "2026-01-15T09:30:00Z",
    "jobStatus": "Error",
    "jobReference": "<jobReference>",
    "notifyUrl": "https://example.com/notifyurl"
  }
]

Built from the response schema. Values are placeholders, not real data.

Bad Request. The operation could not be carried out. The body is a message rather than a structured error.

There was an error processing your request

Unauthorized. The `ApiKey` header is missing or does not match the site, or for a `Secure` operation the bearer token is missing, expired or invalid.

API key is missing or invalid.