Skip to main content
POST
Withdraw to a wallet

Authorizations

x-api-key
string
header
required

Your secret key. fpay_test_… keys use the sandbox; fpay_live_… keys move real money.

Body

application/json
amount
number
required

How much to send, in asset.

Example:

250

network
string
required

The network to send on.

Example:

"base"

asset
enum<string>
required

The token to send.

Available options:
usdc,
usdt
Example:

"usdc"

address
string
required

The wallet to send to, on network.

Example:

"0x8Ba1f109551bD432803012645Ac136ddd64DBA72"

reference
string

Your unique ID for this payout. Sending the same one again returns 409 and sends nothing, so retries are safe. Generated if you leave it out.

Example:

"payout_5510"

note
string

A note for your records.

Example:

"Supplier payout, invoice 2024-001"

callbackUrl
string

Send this payout's webhooks here instead of your usual webhook URL.

Example:

"https://your-server.com/hooks/flipeet"

metadata
object

Your own data, returned as-is in the webhook.

Example:

Response

Withdrawal initiated.

message
string
Example:

"Withdrawal initiated"

status
string
Example:

"success"

statusCode
number
Example:

201

data
object