brighty-payouts

Brighty Payouts

Tools to move money out of Brighty business accounts: batched payouts (CREATED container with N transfers, committed in one shot), one-off internal/external transfers attached to a payout, and FX between two of the business's own accounts (intent + execute).

Activate this skill when the user wants to pay people or vendors, sweep funds between currencies, or stage and run payroll.

Tools provided

Payouts (6) — container + transfers + commit:

• brighty_list_payouts — list payouts. The API takes no input filter parameters. Returns { payouts: Payout[], nextPage? }. Each Payout has id, createdAt, state (CREATED | STARTED | COMPLETED), paidTransfers, totalTransfers, optional name, description, paidAmount, totalAmount, startedAt, completedAt. Capture createdAt from this list — every other payout call needs it.
• brighty_create_payout — open a CREATED container. Optional name and description. Returns the new Payout (note createdAt — keep it for follow-up calls).
• brighty_get_payout — fetch one payout. Requires payoutId AND createdAt (the API rejects without createdAt). Returns { payout, transfers } where each transfer is discriminated by type (Crypto | Fiat | Internal).
• brighty_create_internal_transfer — add a Brighty-to-Brighty transfer to a payout. Recipient is identified by receiverUsername (the @-tag on the recipient's Brighty profile, not a customer/account id). Source account currency must equal transfer currency; this tool does not FX. Idempotency-Key is required by the API; the tool auto-generates a UUIDv4 when none is supplied. Returns { transfer: { id, createdAt }, idempotencyKey }.
• brighty_create_external_transfer — add a fiat (IBAN/BIC/account number) or crypto (on-chain address + transferNetworkId) transfer to a payout. Provide either an inline beneficiary (with kind: "FIAT" | "CRYPTO") or a saved beneficiaryId. The API requires createdAt (the payout's timestamp) as a query param — pass it via payoutCreatedAt. Idempotency-Key is required and auto-generated. Returns { transfer: { id, createdAt }, idempotencyKey }.
• brighty_start_payout — commit a payout (POST /payouts/{id}/start?createdAt=...). Runs a local preflight balance check first: sum per-source-account requirements, fetch each source's balance, abort with a per-account shortfall list if any account is short. Requires payoutId and createdAt. The API returns 204 on success; the tool returns { ok: true }. skipPreflight=true is dangerous and only used when the user has explicitly accepted partial-failure risk.