Skip to main content
POST
/
api
/
apps
/
{app_id}
/
payout
/
settings
Update payout settings POST /api/apps/:app_id/payout/settings
curl --request POST \
  --url https://api.example.com/api/apps/{app_id}/payout/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_payout_enabled": true,
  "locked_balance": 1,
  "min_payout": 1,
  "payout_destination": "<string>",
  "payout_threshold": 1
}
'

Path Parameters

​
app_id
string
required

Application ID

Body

application/json

Request body for updating payout settings

​
auto_payout_enabled
boolean | null

Enable automatic payouts when threshold is reached

​
locked_balance
integer<int64> | null

Locked balance that cannot be withdrawn (in utia) Can only be set once during initial configuration or increased

Required range: x >= 0
​
min_payout
integer<int64> | null

Minimum payout amount (in utia)

Required range: x >= 0
​
payout_destination
string | null

Destination address for payouts

​
payout_threshold
integer<int64> | null

Balance threshold that triggers auto-payout (in utia)

Required range: x >= 0

Response

Payout settings updated successfully