HandToHuman CLI reference All commands
DocsCLImarketmarket payout-request

Public command

market payout-request

Reserve available worker balance for an external payout.

Exact invocation
handtohuman market payout-request <WORKER_ID> --amount-cents N --currency C
01

Inputs and options

<WORKER_ID>

Required existing worker or dual-role account.

--amount-cents <CENTS>

Required positive payout amount.

--currency <CODE>

Required three-letter alphabetic code the payout is in; a payout leaves the currency it was earned in.

payout_destination

Read from the worker’s account, not passed here. Record it with market account-payout-destination, or let the worker name it from the app with POST /v1/mobile/me/payout-destination.

02

Output and state effect

Result

Atomically records a negative payout_requested ledger entry, creates a payout in requested state, and prints it. The command does not move external money.

Serialization

Successful output is pretty-printed JSON. Commands with --output <FILE> write it there instead of stdout; marketplace leaves always print to stdout.

Refusals

  • Refuses a worker with no payout destination on their account, naming the command that records one.
  • Refuses non-positive amounts, invalid currencies, non-worker accounts, insufficient available balance, and empty destinations.