Get Settlements · Payments API

GEThttps://api.ozow.com/secure/settlementsProduction

Build with AI 1 package

A build package is every page for one task, with the API operations they use. Copy the prompt into a coding assistant, or hand it the package itself: slim links to each page, full inlines all of them in one document.

Reconcile a settlementEverything needed to match the money Ozow pays into your bank account against the payments you collected, line item by line item, including the fees that make the two differ.
View package

Retrieve the latest settlements created for the merchant.

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

count integer
The number of settlements to return. The max allowed value is 100.
min1max100

Responses

200 Success

application/json

settlements array of Settlement required
The latest settlements for the merchant.
Fields of Settlement
- id string uuid required
  The settlement identifier.
- date string required
  The settlement date and time. The value carries no timezone designator.
- originalAmount number double required
  The amount in the original transaction currency.
  min0
- originalCurrencyCode string required
  The original transaction currency code (ISO 4217 3 letter code).
  min length3max length3
- bankReference string required
  The Ozow alphanumeric reference for the settlement.
  max length20
- amount number double required
  The amount in the settlement currency.
  min0
- currencyCode string required
  The settlement currency code (ISO 4217 3 letter code).
  min length3max length3
- conversionRate number double required
  The currency conversation rate at the time the settlement was created.
  min0
- accountNumber string required
  The destination account number for the settlement.
  max length50
- status string required
  The settlement status. Possible values are:
  
  Pending - Settlement was created
  
  Submitted - Settlement has been submitted for processing
  
  Complete - Settlement payment has been initiated
  max length50
- createdByUserName string required
  The user that created the settlement.
  max length50
- createdDate string required
  The date and time the settlement was created, in South African Standard Time (UTC+2). The value carries no timezone designator. createdDateUtc carries the same instant in UTC and is the field to compute with.
- createdDateUtc string required
  The UTC date and time the settlement was created. The value carries no timezone designator.
Open Settlement on its own page
errors array of string required
Any errors that occurred for the request.

application/xml

settlements array of Settlement required
The latest settlements for the merchant.
Fields of Settlement
- id string uuid required
  The settlement identifier.
- date string required
  The settlement date and time. The value carries no timezone designator.
- originalAmount number double required
  The amount in the original transaction currency.
  min0
- originalCurrencyCode string required
  The original transaction currency code (ISO 4217 3 letter code).
  min length3max length3
- bankReference string required
  The Ozow alphanumeric reference for the settlement.
  max length20
- amount number double required
  The amount in the settlement currency.
  min0
- currencyCode string required
  The settlement currency code (ISO 4217 3 letter code).
  min length3max length3
- conversionRate number double required
  The currency conversation rate at the time the settlement was created.
  min0
- accountNumber string required
  The destination account number for the settlement.
  max length50
- status string required
  The settlement status. Possible values are:
  
  Pending - Settlement was created
  
  Submitted - Settlement has been submitted for processing
  
  Complete - Settlement payment has been initiated
  max length50
- createdByUserName string required
  The user that created the settlement.
  max length50
- createdDate string required
  The date and time the settlement was created, in South African Standard Time (UTC+2). The value carries no timezone designator. createdDateUtc carries the same instant in UTC and is the field to compute with.
- createdDateUtc string required
  The UTC date and time the settlement was created. The value carries no timezone designator.
Open Settlement on its own page
errors array of string required
Any errors that occurred for the request.

401 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.

string

example 1

API key is missing or invalid.

Guides

Reconcile settlementsPull settlement data from the Payments API, the legacy path, and tie it back to the deposits in your bank account and the orders in your own system.

Request

curl -X GET 'https://api.ozow.com/secure/settlements' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/secure/settlements");
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/settlements',
    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/settlements", {
  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/settlements",
    headers=headers,
)

curl -X GET 'https://api.ozow.com/secure/settlements?count=1' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/secure/settlements?count=1");
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/settlements?count=1',
    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/settlements?count=1", {
  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/settlements?count=1",
    headers=headers,
)

Response

Success

{
  "settlements": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "date": "2024-01-27T09:00:25.331625",
      "originalAmount": 5000,
      "originalCurrencyCode": "<originalCurrencyCode>",
      "bankReference": "ONLINESHOP002",
      "amount": 0,
      "currencyCode": "<currencyCode>",
      "conversionRate": 0,
      "accountNumber": "0000000000",
      "status": "<status>",
      "createdByUserName": "<createdByUserName>",
      "createdDate": "2024-01-23T11:54:21.499945",
      "createdDateUtc": "2024-01-23T09:54:21.499945"
    }
  ],
  "errors": [
    "<errors>"
  ]
}

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.