Get refunds

GET /secure/refunds/getrefunds

Try it

Parameters

refundDate*querystatus*query

Request sampleLanguage

curl -X GET 'https://api.ozow.com/secure/refunds/getrefunds?refundDate=string&status=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response exampleStatus

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdDate": "2026-01-15T09:30:00Z",
    "createdDateUtc": "2026-01-15T09:30:00Z",
    "merchantCode": "<merchantCode>",
    "siteCode": "<siteCode>",
    "siteName": "<siteName>",
    "bankToName": "<bankToName>",
    "currencyCode": "<currencyCode>",
    "amount": 15.2,
    "statementReference": "<statementReference>",
    "status": 1,
    "toAccount": "<toAccount>",
    "paymentDate": "2026-01-15T09:30:00Z",
    "transactionReference": "<transactionReference>",
    "customer": "<customer>",
    "lastEvent": "<lastEvent>",
    "refundCompletedDate": "2026-01-15T09:30:00Z",
    "createdBy": "<createdBy>",
    "isRtc": true
  }
]

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

GEThttps://api.ozow.com/secure/refunds/getrefundsProduction

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.

Migrate refunds from the Payments API to One APIEverything needed to move an existing refunds integration onto One API, with the legacy guide and its One API counterpart side by side.
View package

List refunds by date and status.

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

refundDate string required
The date of the refunds you would like to be returned.
status string required
The status of the refunds you would like to be returned.

Responses

200 OK

application/json

array of Refund

application/xml

array of Refund

Guides

Refund a paymentIssue a refund on the Payments API, the legacy path. Refunds are merchant-initiated backend operations, funded from your float balance.

Request

curl -X GET 'https://api.ozow.com/secure/refunds/getrefunds?refundDate=string&status=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/secure/refunds/getrefunds?refundDate=string&status=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/refunds/getrefunds?refundDate=string&status=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/refunds/getrefunds?refundDate=string&status=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/refunds/getrefunds?refundDate=string&status=string",
    headers=headers,
)

Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdDate": "2026-01-15T09:30:00Z",
    "createdDateUtc": "2026-01-15T09:30:00Z",
    "merchantCode": "<merchantCode>",
    "siteCode": "<siteCode>",
    "siteName": "<siteName>",
    "bankToName": "<bankToName>",
    "currencyCode": "<currencyCode>",
    "amount": 15.2,
    "statementReference": "<statementReference>",
    "status": 1,
    "toAccount": "<toAccount>",
    "paymentDate": "2026-01-15T09:30:00Z",
    "transactionReference": "<transactionReference>",
    "customer": "<customer>",
    "lastEvent": "<lastEvent>",
    "refundCompletedDate": "2026-01-15T09:30:00Z",
    "createdBy": "<createdBy>",
    "isRtc": true
  }
]

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.