Skip to content

Create payout

Send USDC on Base from the user's wallet to an EVM address. Without `mandateId` the user approves via `approvalUrl`; with a signed USDC mandate and enough budget it is approved automatically. Track the outcome with Get payout status (`displayStatus`).

POST
/api/payouts

Request Body​

application/json

Payout request.

Your idempotency key (max 128 chars).

Max Length128

Destination EVM address (not the zero address).

Positive integer string, atomic units (1000000 = 1 USDC).

Signed USDC mandate for automatic approval.

Business reference; one live payout per bizId.

Network.

Valid values"base""base-sepolia""eip155:8453""eip155:84532"
Default"base"

Only USDC.

Valid values"USDC"
Default"USDC"

Must be the USDC contract for the network if provided.

Memo shown to the user (max 500 chars).

Max Length500

Your own JSON metadata.

Approval window, 60–604800 seconds.

Minimum60
Maximum604800
Default604800

Responses​

Idempotent repeat (same payoutId and parameters).

application/json

Created payout. Poll Get payout status for displayStatus.

Your payoutId.

Transaction hash once sent.

FluxA Wallet page for this payout (share with the user when no mandate is used).

Approval deadline (Unix seconds).

Mandate used, if any.

Business reference.

Memo.

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

Released under the MIT License.