Create payout

Agent initiates an on-chain USDC transfer (payout) from a user's FluxA Wallet. Supports optional mandateId for auto-approval and bizId for business-level deduplication. Returns 201 when newly created, or 200 on an idempotent hit with identical params.

POST

https://walletapi.fluxapay.xyz/api/payouts

Authorizations

agentJwt

Agent registration JWT. Send as Authorization: Bearer <agent-jwt>.

Type

HTTP (bearer)

Request Body

application/json

Idempotency key, unique per user. Repeat requests with the same payoutId return the existing result.

Destination address; EVM format (0x + 40 hex chars).

Amount as a positive integer string in atomic units (USDC: 1000000 = 1.0 USDC).

Pre-signed mandate ID. If provided and the budget is sufficient, the payout is auto-approved, skipping manual user approval.

Defaultnull

External business ID, unique per user. Prevents duplicate payouts — only one active payout per bizId.

Defaultnull

Blockchain network.

Valid values"base""base-sepolia"

Default"base"

Currency symbol.

Default"USDC"

Token contract address. Defaults to the network default USDC.

Free-text description.

Defaultnull

Custom JSON metadata.

Defaultnull

Callback URL.

Defaultnull

Expiry in seconds (60–604800; default 7 days).

Default604800

Minimum60

Maximum604800

Responses

Idempotent hit: an existing payout with the same payoutId and identical params was returned.

Content-Type

application/json

Payout ID.

Current status. authorized when a mandate auto-approves; pending_authorization on the standard path.

Valid values"pending_authorization""authorized""signing""signed""broadcasting""succeeded""confirmed""failed"

On-chain tx hash (available after broadcast).

User approval URL. Only returned in pending_authorization; null on auto-approve.

Expiry (Unix timestamp).

Associated mandate ID.

External business ID.

{
  "payoutId": "<string>",
  "status": "<string>",
  "txHash": "<string>",
  "approvalUrl": "<string>",
  "expiresAt": "<integer>",
  "mandateId": "<string>",
  "bizId": "<string>"
}