Get Site Settlements

GET /secure/settlements/getsitesettlements

Try it

Parameters

fromDate*querytoDate*query

Request sampleLanguage

curl -X GET 'https://api.ozow.com/secure/settlements/getsitesettlements?fromDate=string&toDate=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response exampleStatus

[
  {
    "settlementId": "00000000-0000-0000-0000-000000000000",
    "settlementDate": "<settlementDate>",
    "toReference": "<toReference>",
    "amount": 0,
    "bankReference": "<bankReference>",
    "status": 1,
    "siteCode": "<siteCode>",
    "transactionCreatedDate": "<transactionCreatedDate>",
    "transactionId": "00000000-0000-0000-0000-000000000000",
    "transactionReference": "<transactionReference>"
  }
]

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

GEThttps://api.ozow.com/secure/settlements/getsitesettlementsProduction

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

The settlements created for a merchant site over a selected period.

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

fromDate string required
Desired start date to retrieve respective merchant site settlements. Format: yyyy-mm-dd
toDate string required
Desired end date to retrieve respective merchant site settlements. Format: yyyy-mm-dd

Responses

200 OK

application/json

array of SiteSettlement

application/xml

array of SiteSettlement

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/getsitesettlements?fromDate=string&toDate=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/secure/settlements/getsitesettlements?fromDate=string&toDate=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/settlements/getsitesettlements?fromDate=string&toDate=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/settlements/getsitesettlements?fromDate=string&toDate=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/settlements/getsitesettlements?fromDate=string&toDate=string",
    headers=headers,
)

Response

[
  {
    "settlementId": "00000000-0000-0000-0000-000000000000",
    "settlementDate": "<settlementDate>",
    "toReference": "<toReference>",
    "amount": 0,
    "bankReference": "<bankReference>",
    "status": 1,
    "siteCode": "<siteCode>",
    "transactionCreatedDate": "<transactionCreatedDate>",
    "transactionId": "00000000-0000-0000-0000-000000000000",
    "transactionReference": "<transactionReference>"
  }
]

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.