merchant

Create Crypto Withdraw Deposit

Changed on

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

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/withdraw/crypto-deposit-address
  • Auth
    API key in header x-coinflow-auth-user-id

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' | 'crypto' 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.

idempotencyKeystring

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.

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-user-id

    • info

      the endpoint scheme security userId was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id create-crypto-withdraw-deposit removed and replaced with merchant_CreateCryptoWithdrawDeposit