Organization

Execute a payout (balance withdrawal)

Withdraw balance from a trading account synchronously — the trade engine deducts the amount in-memory within milliseconds and persists in the background.

Idempotency (recommended): send an Idempotency-Key header (or the equivalent x-idempotency-key — both spellings work everywhere). Replays with the same key return the original payout and never withdraw twice — safe to retry on timeouts. The key is honored at two layers: the API-wide idempotency cache (uniform across every mutating endpoint) and the trade engine itself (which guarantees the same key can never withdraw twice, HTTP 200 with duplicate: true).

What a payout does to the account:

Deducts amount from the balance. The daily baseline and high-water mark shift down by the same amount, so the withdrawal never appears as a trading loss or phantom drawdown.
moveMllToLock (optional): locks the loss floor at initial balance + payoutMllLockOffset (rule default, e.g. +$100) or at your explicit lockBalance. From then on, equity at/below the floor is a max-loss violation.
consistencyReset (optional): starts a new payout cycle — the funded consistency rule resets to $0 cycle profit.
enforceConsistency (optional): pre-checks the funded consistency rule and rejects the payout with the full status if any day in the cycle reaches the daily cap.

Requirements: the account must be flat (no open positions or working orders) and tradable.

Webhooks: account.payout_processed fires on every executed payout; account.max_payouts_reached fires when the account hits the rule’s maxPayouts (e.g. “goes live after 5 payouts”).

Example:

curl -X POST ".../v1/organization/accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/payouts" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "x-idempotency-key: payout-2026-07-13-acc7c9e" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 1600, "moveMllToLock": true, "consistencyReset": true, "enforceConsistency": true }'

Error codes:

Code	Meaning
`OPEN_EXPOSURE`	Account has open positions/working orders — flatten first
`CONSISTENCY_BLOCKED`	Funded consistency rule fails right now (response includes the full consistency status with the blocking days)
`INVALID_AMOUNT`	Amount exceeds balance, or post-payout balance would breach the requested loss floor
`ACCOUNT_NOT_TRADABLE`	Account is violated/completed/paused
`ENGINE_UNREACHABLE`	Engine did not respond — the payout was NOT executed; retry with the same idempotency key

POST

organization

accounts

{accountId}

payouts

Execute a payout (balance withdrawal)

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1600,
  "moveMllToLock": true,
  "lockBalance": 50100,
  "consistencyReset": true,
  "enforceConsistency": true
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts"

payload = {
    "amount": 1600,
    "moveMllToLock": True,
    "lockBalance": 50100,
    "consistencyReset": True,
    "enforceConsistency": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1600,
    moveMllToLock: true,
    lockBalance: 50100,
    consistencyReset: true,
    enforceConsistency: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts', 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/accounts/{accountId}/payouts",
  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([
    'amount' => 1600,
    'moveMllToLock' => true,
    'lockBalance' => 50100,
    'consistencyReset' => true,
    'enforceConsistency' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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/accounts/{accountId}/payouts"

	payload := strings.NewReader("{\n  \"amount\": 1600,\n  \"moveMllToLock\": true,\n  \"lockBalance\": 50100,\n  \"consistencyReset\": true,\n  \"enforceConsistency\": true\n}")

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

	req.Header.Add("Authorization", "<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/accounts/{accountId}/payouts")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1600,\n  \"moveMllToLock\": true,\n  \"lockBalance\": 50100,\n  \"consistencyReset\": true,\n  \"enforceConsistency\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1600,\n  \"moveMllToLock\": true,\n  \"lockBalance\": 50100,\n  \"consistencyReset\": true,\n  \"enforceConsistency\": true\n}"

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

{
  "success": true,
  "message": "Payout processed successfully",
  "data": {
    "payoutId": "e5f6a7b8-c9d0-1234-ef01-234567890abc",
    "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "amount": 1600,
    "balanceBefore": 52500,
    "balanceAfter": 50900,
    "payoutCount": 1,
    "mllLockedTo": 50100,
    "consistencyReset": true,
    "maxPayoutsReached": false,
    "duplicate": false
  }
}

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

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Account not found in your organization",
  "code": "ACCOUNT_NOT_FOUND"
}

{
  "success": false,
  "code": "CONSISTENCY_BLOCKED",
  "message": "Best day $1,290.00 reaches the $1,290.00 daily cap (50% of $2,500.00 + $40.00 buffer). Spread gains across more days to dilute it.",
  "consistency": {}
}

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

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Path Parameters

accountId

string

required

Trading account to withdraw from

Body

application/json

amount

number

required

Amount to withdraw from the account balance ($)

Example:

1600

moveMllToLock

boolean

default:false

Lock the max-loss floor after the withdrawal: floor = initial balance + the rule's payoutMllLockOffset (or lockBalance when provided). Equity at/below the locked floor fails the account.

Example:

true

lockBalance

number

Explicit loss-floor balance for moveMllToLock (overrides the rule's payoutMllLockOffset).

Example:

50100

consistencyReset

boolean

default:false

Start a new consistency payout cycle at the post-withdrawal balance. The funded consistency rule then measures against profit made after this payout.

Example:

true

enforceConsistency

boolean

default:false

Reject the payout (409 CONSISTENCY_BLOCKED, with the full consistency status in the response) when the account currently fails its funded consistency rule.

Example:

true

Response

Payout processed

success

boolean

Example:

true

message

string

Example:

"Payout processed successfully"

data

object

Show child attributes

Example:

{
  "payoutId": "e5f6a7b8-c9d0-1234-ef01-234567890abc",
  "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "amount": 1600,
  "balanceBefore": 52500,
  "balanceAfter": 50900,
  "payoutCount": 1,
  "mllLockedTo": 50100,
  "consistencyReset": true,
  "maxPayoutsReached": false,
  "duplicate": false
}

⌘I

Execute a payout (balance withdrawal)

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1600,
  "moveMllToLock": true,
  "lockBalance": 50100,
  "consistencyReset": true,
  "enforceConsistency": true
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts"

payload = {
    "amount": 1600,
    "moveMllToLock": True,
    "lockBalance": 50100,
    "consistencyReset": True,
    "enforceConsistency": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1600,
    moveMllToLock: true,
    lockBalance: 50100,
    consistencyReset: true,
    enforceConsistency: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts', 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/accounts/{accountId}/payouts",
  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([
    'amount' => 1600,
    'moveMllToLock' => true,
    'lockBalance' => 50100,
    'consistencyReset' => true,
    'enforceConsistency' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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/accounts/{accountId}/payouts"

	payload := strings.NewReader("{\n  \"amount\": 1600,\n  \"moveMllToLock\": true,\n  \"lockBalance\": 50100,\n  \"consistencyReset\": true,\n  \"enforceConsistency\": true\n}")

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

	req.Header.Add("Authorization", "<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/accounts/{accountId}/payouts")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1600,\n  \"moveMllToLock\": true,\n  \"lockBalance\": 50100,\n  \"consistencyReset\": true,\n  \"enforceConsistency\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/accounts/{accountId}/payouts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1600,\n  \"moveMllToLock\": true,\n  \"lockBalance\": 50100,\n  \"consistencyReset\": true,\n  \"enforceConsistency\": true\n}"

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

{
  "success": true,
  "message": "Payout processed successfully",
  "data": {
    "payoutId": "e5f6a7b8-c9d0-1234-ef01-234567890abc",
    "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "amount": 1600,
    "balanceBefore": 52500,
    "balanceAfter": 50900,
    "payoutCount": 1,
    "mllLockedTo": 50100,
    "consistencyReset": true,
    "maxPayoutsReached": false,
    "duplicate": false
  }
}

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

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Account not found in your organization",
  "code": "ACCOUNT_NOT_FOUND"
}

{
  "success": false,
  "code": "CONSISTENCY_BLOCKED",
  "message": "Best day $1,290.00 reaches the $1,290.00 daily cap (50% of $2,500.00 + $40.00 buffer). Spread gains across more days to dilute it.",
  "consistency": {}
}

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

Platform API

Trade API

Market Data API

Execute a payout (balance withdrawal)

Authorizations

Path Parameters

Body

Response