merchant

Activate Passive Deposit Address

Changed on

Activate a passive deposit address so it accepts new payments. If a deposit address already exists for this merchant + withdrawer + chain + token, that address is re-activated and returned. Otherwise a new session is created and its address is activated.

post/withdraw/crypto-deposit-address/activate

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/withdraw/crypto-deposit-address/activate
  • 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
status'active' | 'paused' required

Changes

    • warning

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

    • info

      the endpoint scheme security userId was added to the API

    • info

      api operation id activate-passive-deposit-address removed and replaced with merchant_ActivatePassiveDepositAddress