Skip to main content
POST
Withdraw to a bank

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
currency
enum<string>
required

The stablecoin to pay from.

Available options:
usdc,
usdt
Example:

"usdc"

amount
number
required

How much to pay out, in currency.

Example:

100

payoutCurrency
string
required

The local currency the recipient receives.

Example:

"NGN"

country
string
required

The recipient's country, as an ISO code.

Example:

"NG"

beneficiary
object
required

The bank account to pay.

channel
string

How the payout is sent.

Example:

"BANK_TRANSFER"

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_5511"

note
string

A note for your records.

Example:

"Payout to supplier #INV-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