Sign in

v4

latestOpenAPI 3.1.02026-08-08186985685.3 KB
merchant

Create Crypto Withdraw Deposit

Create a crypto deposit session for a payout. Returns a deposit address where the merchant can send funds. Once funds are received via the deposit webhook, the payout is automatically initiated.

post/withdraw/crypto-deposit-address

Headers

x-coinflow-auth-user-idstring required

The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request body

accountstring required

The payout account token (e.g., bank account or debit card token)

speed'asap' | 'same_day' | 'standard' | 'card' | 'iban' | 'pix' | 'eft' | 'venmo' | 'paypal' | 'wire' | 'interac' | 'swift' required
chainstring required

The supported chain name (e.g., "Ethereum", "Polygon", "Solana")

tokenstring required

The token symbol to deposit (e.g., "USDC")

Response

Ok

depositAddressstring required
paymentChainNamestring required
paymentCurrencySymbolstring required
paymentAmountstring required
chainLogoUrlstring required
currencyLogoUrlstring required
idempotencyKeystring required

The id for this deposit. Use it as the search value on GET /api/merchant/withdraws to look up the resulting payout once funds are received.