API ReferenceWithdraw

Get Quote

Gets a quote in USD cents for a particular token and amount.

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

x-coinflow-auth-merchant-idstring
The merchant ID the session should be generated for
OR
x-coinflow-auth-user-idstring

The external identifier 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

Query parameters

tokenstringRequired
  • The token address or contract of the token which the user is withdrawing.
amountdoubleRequired
  • The amount of that token which the user is withdrawing.
merchantIdstringRequired
  • The merchant that this quote is for.
usePermitbooleanOptionalDefaults to true
  • [EVM only] whether the user’s wallet supports signing permit messages.
accountTokenstringOptional
  • The token of the account to use

Response

Ok
asapobject
Represents the fees and limits associated with a withdrawal quote.
same_dayobject
Represents the fees and limits associated with a withdrawal quote.
standardobject
Represents the fees and limits associated with a withdrawal quote.
cardobject
Represents the fees and limits associated with a withdrawal quote.
ibanobject
Represents the fees and limits associated with a withdrawal quote.
pixobject
Represents the fees and limits associated with a withdrawal quote.
eftobject
Represents the fees and limits associated with a withdrawal quote.
venmoobject
Represents the fees and limits associated with a withdrawal quote.
paypalobject
Represents the fees and limits associated with a withdrawal quote.
wireobject
Represents the fees and limits associated with a withdrawal quote.
interacobject
Represents the fees and limits associated with a withdrawal quote.
quoteobject
gasFeesobject or null
Represents an estimate of gas fees for a transaction.
swapFeesobject or null