Submit refund · Payments API

POSThttps://api.ozow.com/secure/refunds/submitProduction

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

Submit refunds to Ozow for processing.

Authentication

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

Request body

An array of refund requests.

array of RefundRequest

Responses

200 OK

application/json

refundId string uuid required
The identifier for the refund that was created. No identifier is returned if there was an error creating the refunds.
transactionId string uuid required
The transaction identifier. This will correspond to one of the transaction identifiers passed through in the request.
refundAmount string required
The refund amount.
errors array of string
Validation errors for the specific refund.

application/xml

refundId string uuid required
The identifier for the refund that was created. No identifier is returned if there was an error creating the refunds.
transactionId string uuid required
The transaction identifier. This will correspond to one of the transaction identifiers passed through in the request.
refundAmount string required
The refund amount.
errors array of string
Validation errors for the specific refund.

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

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 POST 'https://api.ozow.com/secure/refunds/submit' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "transactionId": "00000000-0000-0000-0000-000000000000",
    "amount": 20.44,
    "hashCheck": "<hashCheck>"
  }
]'

using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.ozow.com/secure/refunds/submit");
request.Headers.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN");

var payload = new[]
{
    new RefundRequest
    {
        TransactionId = "00000000-0000-0000-0000-000000000000",
        Amount = 20.44m,
        HashCheck = "<hashCheck>",
    },
};

request.Content = new StringContent(
    JsonSerializer.Serialize(payload),
    Encoding.UTF8,
    "application/json");

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

record RefundRequest
{
    [JsonPropertyName("transactionId")]
    public required string TransactionId { get; init; }

    [JsonPropertyName("amount")]
    public required decimal Amount { get; init; }

    [JsonPropertyName("hashCheck")]
    public required string HashCheck { get; init; }
}

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ozow.com/secure/refunds/submit',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_ACCESS_TOKEN',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
[
  {
    "transactionId": "00000000-0000-0000-0000-000000000000",
    "amount": 20.44,
    "hashCheck": "<hashCheck>"
  }
]
JSON,
]);

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

const response = await fetch("https://api.ozow.com/secure/refunds/submit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify([
    {
      "transactionId": "00000000-0000-0000-0000-000000000000",
      "amount": 20.44,
      "hashCheck": "<hashCheck>"
    }
  ]),
});

const data = await response.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json",
}

payload = [
    {
        "transactionId": "00000000-0000-0000-0000-000000000000",
        "amount": 20.44,
        "hashCheck": "<hashCheck>",
    },
]

response = requests.post(
    "https://api.ozow.com/secure/refunds/submit",
    headers=headers,
    json=payload,
)

curl -X POST 'https://api.ozow.com/secure/refunds/submit' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "transactionId": "00000000-0000-0000-0000-000000000000",
    "amount": 20.44,
    "refundReason": "Customer requested a refund",
    "notifyUrl": "https://example.com/notifyurl",
    "hashCheck": "<hashCheck>",
    "isRtc": false
  }
]'

using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.ozow.com/secure/refunds/submit");
request.Headers.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN");

var payload = new[]
{
    new RefundRequest
    {
        TransactionId = "00000000-0000-0000-0000-000000000000",
        Amount = 20.44m,
        RefundReason = "Customer requested a refund",
        NotifyUrl = "https://example.com/notifyurl",
        HashCheck = "<hashCheck>",
        IsRtc = false,
    },
};

request.Content = new StringContent(
    JsonSerializer.Serialize(payload),
    Encoding.UTF8,
    "application/json");

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

record RefundRequest
{
    [JsonPropertyName("transactionId")]
    public required string TransactionId { get; init; }

    [JsonPropertyName("amount")]
    public required decimal Amount { get; init; }

    [JsonPropertyName("refundReason")]
    public required string RefundReason { get; init; }

    [JsonPropertyName("notifyUrl")]
    public required string NotifyUrl { get; init; }

    [JsonPropertyName("hashCheck")]
    public required string HashCheck { get; init; }

    [JsonPropertyName("isRtc")]
    public required bool IsRtc { get; init; }
}

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ozow.com/secure/refunds/submit',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_ACCESS_TOKEN',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
[
  {
    "transactionId": "00000000-0000-0000-0000-000000000000",
    "amount": 20.44,
    "refundReason": "Customer requested a refund",
    "notifyUrl": "https://example.com/notifyurl",
    "hashCheck": "<hashCheck>",
    "isRtc": false
  }
]
JSON,
]);

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

const response = await fetch("https://api.ozow.com/secure/refunds/submit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify([
    {
      "transactionId": "00000000-0000-0000-0000-000000000000",
      "amount": 20.44,
      "refundReason": "Customer requested a refund",
      "notifyUrl": "https://example.com/notifyurl",
      "hashCheck": "<hashCheck>",
      "isRtc": false
    }
  ]),
});

const data = await response.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json",
}

payload = [
    {
        "transactionId": "00000000-0000-0000-0000-000000000000",
        "amount": 20.44,
        "refundReason": "Customer requested a refund",
        "notifyUrl": "https://example.com/notifyurl",
        "hashCheck": "<hashCheck>",
        "isRtc": False,
    },
]

response = requests.post(
    "https://api.ozow.com/secure/refunds/submit",
    headers=headers,
    json=payload,
)

curl -X POST 'https://api.ozow.com/secure/refunds/submit' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&hashCheck=%3ChashCheck%3E'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.ozow.com/secure/refunds/submit");
request.Headers.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN");

request.Content = new FormUrlEncodedContent(new Dictionary<string, string>
{
    ["transactionId"] = "00000000-0000-0000-0000-000000000000",
    ["amount"] = "20.44",
    ["hashCheck"] = "<hashCheck>",
});

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/submit',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_ACCESS_TOKEN',
        'Content-Type: application/x-www-form-urlencoded',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&hashCheck=%3ChashCheck%3E
JSON,
]);

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

const response = await fetch("https://api.ozow.com/secure/refunds/submit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/x-www-form-urlencoded",
  },
  body: `transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&hashCheck=%3ChashCheck%3E`,
});

const data = await response.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/x-www-form-urlencoded",
}

payload = """transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&hashCheck=%3ChashCheck%3E"""

response = requests.post(
    "https://api.ozow.com/secure/refunds/submit",
    headers=headers,
    data=payload,
)

curl -X POST 'https://api.ozow.com/secure/refunds/submit' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&refundReason=Customer%20requested%20a%20refund&notifyUrl=https%3A%2F%2Fexample.com%2Fnotifyurl&hashCheck=%3ChashCheck%3E&isRtc=false'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.ozow.com/secure/refunds/submit");
request.Headers.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN");

request.Content = new FormUrlEncodedContent(new Dictionary<string, string>
{
    ["transactionId"] = "00000000-0000-0000-0000-000000000000",
    ["amount"] = "20.44",
    ["refundReason"] = "Customer requested a refund",
    ["notifyUrl"] = "https://example.com/notifyurl",
    ["hashCheck"] = "<hashCheck>",
    ["isRtc"] = "false",
});

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/submit',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_ACCESS_TOKEN',
        'Content-Type: application/x-www-form-urlencoded',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&refundReason=Customer%20requested%20a%20refund&notifyUrl=https%3A%2F%2Fexample.com%2Fnotifyurl&hashCheck=%3ChashCheck%3E&isRtc=false
JSON,
]);

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

const response = await fetch("https://api.ozow.com/secure/refunds/submit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/x-www-form-urlencoded",
  },
  body: `transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&refundReason=Customer%20requested%20a%20refund&notifyUrl=https%3A%2F%2Fexample.com%2Fnotifyurl&hashCheck=%3ChashCheck%3E&isRtc=false`,
});

const data = await response.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/x-www-form-urlencoded",
}

payload = """transactionId=00000000-0000-0000-0000-000000000000&amount=20.44&refundReason=Customer%20requested%20a%20refund&notifyUrl=https%3A%2F%2Fexample.com%2Fnotifyurl&hashCheck=%3ChashCheck%3E&isRtc=false"""

response = requests.post(
    "https://api.ozow.com/secure/refunds/submit",
    headers=headers,
    data=payload,
)

Response

{
  "refundId": "00000000-0000-0000-0000-000000000000",
  "transactionId": "00000000-0000-0000-0000-000000000000",
  "refundAmount": "<refundAmount>",
  "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.