Skip to main content
GET
Get a balance adjustment by reference

Authorizations

X-API-Key
string
header
required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Path Parameters

accountId
string
required

Trading account ID

reference
string
required

Your reference for this adjustment, for example your deposit or withdrawal ID: 1 to 128 characters, letters, digits and . _ : @ + = ~ -, starting with a letter or digit. Unique within your organization and case-sensitive.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@+=~-]{0,127}$

Response

Adjustment retrieved

success
boolean
Example:

true

data
object