Sign in
OpenAPI 3.1.02026-08-201961,012712.7 KB

04665b9b9725

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

returnAddressstring

Optional end-user wallet address to send funds back to if a withdrawal fails, instead of returning them to the originating wallet. When it is on a different chain than the received funds (Solana USDC), the refund is routed back out through the same cross-chain provider.

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.