Reverse a balance credit

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "Credited in error",
  "accountIds": [
    "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  ],
  "preview": false
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse"

payload = {
    "reason": "Credited in error",
    "accountIds": ["7c9e6679-7425-40de-944b-e07fc1f90ae7"],
    "preview": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reason: 'Credited in error',
    accountIds: ['7c9e6679-7425-40de-944b-e07fc1f90ae7'],
    preview: false
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Credited in error',
    'accountIds' => [
        '7c9e6679-7425-40de-944b-e07fc1f90ae7'
    ],
    'preview' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse"

	payload := strings.NewReader("{\n  \"reason\": \"Credited in error\",\n  \"accountIds\": [\n    \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n  ],\n  \"preview\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Credited in error\",\n  \"accountIds\": [\n    \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n  ],\n  \"preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/balance-adjustments/{batchId}/reverse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Credited in error\",\n  \"accountIds\": [\n    \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n  ],\n  \"preview\": false\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "preview": true,
    "total": 838,
    "totalAmount": 186010.25
  }
}

{
  "success": true,
  "data": {
    "batchId": "5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60",
    "kind": "credit",
    "tag": "incident-2026-10-21",
    "reason": "US-open outage, 21 October",
    "status": "completed",
    "windowStart": "2026-10-21T13:30:00.000Z",
    "windowEnd": "2026-10-21T14:15:00.000Z",
    "policy": {
      "lossBasis": "net_after_fees",
      "shiftDailyBaseline": true,
      "highWaterMarkMode": "unchanged",
      "requireFlat": false,
      "skipAlreadyCredited": true,
      "maxCreditPerAccount": null
    },
    "requestedBy": "ops@yourfirm.com",
    "total": 840,
    "processed": 840,
    "applied": 838,
    "failed": 2,
    "skipped": 410,
    "totalAmount": 186420.75,
    "appliedAmount": 186010.25,
    "reversesBatchId": null,
    "createdAt": "2026-10-25T15:02:11.000Z",
    "lastProgressAt": "2026-10-25T15:04:52.000Z",
    "completedAt": "2026-10-25T15:04:52.000Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No applied, unreversed credit in this batch matches",
  "code": "NOTHING_TO_REVERSE"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Your role does not have write access to \"Traders & accounts\"",
  "code": "INSUFFICIENT_PERMISSIONS"
}

{
  "success": false,
  "statusCode": 404,
  "error": "Not Found",
  "message": "Balance adjustment batch not found",
  "code": "BATCH_NOT_FOUND"
}

{
  "success": false,
  "statusCode": 409,
  "error": "Conflict",
  "message": "The batch is still being applied; reverse it once it has finished",
  "code": "BATCH_RUNNING"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

{
  "success": false,
  "statusCode": 503,
  "error": "Error",
  "message": "Balance adjustments are not available yet; nothing was changed",
  "code": "FEATURE_NOT_READY"
}