API ReferenceWithdraw

Get Message (EVM USDC/SBC/EuroE only)

Gets any messages to be signed by the user, the signed message is then passed as the evmPermitMessage body property into the /api/withdraw/evm/transaction endpoint.

This is only necessary for EVM chains.

Authentication

x-coinflow-auth-walletstring
The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
x-coinflow-auth-blockchainstring
The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
x-coinflow-auth-session-keystring
The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.
amountdoubleRequired
tokenobjectOptional
From T, pick a set of properties whose keys are in the union K
userLocationobjectOptional

End-user geographic coordinates captured at the moment of the withdrawal request. Consumed by BlockingRuleMethod.GEOLOCATION enforcement.

Replay-of-different-coords bypass is prevented server-side: the first resolved {country, state} for a given (merchant, user) pair is pinned in Redis, and subsequent requests are evaluated against that pinned value regardless of the lat/lng they submit.

Response

Ok
messagestring or null
The message that needs to be typed signed by the user's EVM wallet.