Skip to content

get_payout_status — check the status of a payout

Available via MCP and HTTP API.

  • MCP: call get_payout_status with the payout_id.
  • HTTP: call GET /api/payouts/{payoutId} (see Get payout status).

Purpose
Retrieves the latest status of a payout previously created via request_payout.

What it does

  • Calls a public status endpoint in the FluxA Wallet App to retrieve the payout’s current state.
  • Returns the full status payload (e.g., pending_authorization, in_progress, completed, failed) along with any relevant metadata.
  • Records an audit entry for each check.

Typical agent usage

  • After creating a payout with request_payout, store the returned payout_id.
  • Periodically call get_payout_status with that payout_id until the payout moves to a terminal state.
  • Surface the result to the user or use it to drive downstream logic (e.g., marking an invoice as paid once the payout is completed).

Key input

  • payout_id — the identifier used when the payout was created.

Released under the MIT License.