Skip to main content
POST
Create a bank deposit

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

The amount the customer pays, in currency.

Example:

150000

currency
string
required

The currency the customer pays in.

Example:

"NGN"

country
string

ISO country code. Defaults to your business's country.

Example:

"NG"

asset
string

The stablecoin you're settled in. Defaults to usdc.

Example:

"usdc"

network
string

The network you're settled on. Defaults to base.

Example:

"base"

channel
string

How the customer pays.

Example:

"BANK"

reference
string

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

Example:

"inv_2202"

callbackUrl
string

Send this payment'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

Fiat transaction initialized.

message
string
Example:

"Fiat transaction initialized"

status
string
Example:

"success"

statusCode
number
Example:

201

data
object