Skip to main content
POST
Execute a payout (balance withdrawal)

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

Idempotency-Key
string

Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.

Maximum string length: 255

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
Example: