Get Quote (Exact Out)

GET

https://api-sandbox.coinflow.cash/api/withdraw/quote/exact-out

GET

/api/withdraw/quote/exact-out

$ curl -G https://api-sandbox.coinflow.cash/api/withdraw/quote/exact-out \
>      -H "x-coinflow-auth-wallet: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d exactAmountOut=2500 \
>      -d speed=same_day \
>      -d inputToken=0x6B175474E89094C44Da98b954EedeAC495271d0F \
>      -d merchantId=merchant_987654321 \
>      -d currency=USD \
>      -d usePermit=true \
>      -d accountToken=0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48

200Retrieved

1 {
2   "inputAmount": 0.0357,
3   "exactAmountOut": {
4     "cents": 2500,
5     "currency": "USD"
6   },
7   "quote": {
8     "fee": {
9       "cents": 75,
10       "currency": "USD"
11     },
12     "limit": {
13       "cents": 100000,
14       "currency": "USD"
15     },
16     "finalSettlement": {
17       "cents": 2575,
18       "currency": "USD"
19     },
20     "expectedDeliveryDate": "2024-06-15",
21     "expectedDeliveryDateISO": "2024-06-15T18:00:00Z",
22     "customFee": {
23       "cents": 25,
24       "currency": "USD",
25       "label": "Processing Fee"
26     }
27   }
28 }

Destination-amount (“reverse”) quote. Given a target fiat payout (exactAmountOut) for a specific delivery speed, returns how much of the input token the merchant needs to send so that — after swap, gas and withdraw fees — the withdrawer nets exactly that payout.

This is the inverse of GET /withdraw/quote.

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

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

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

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

exactAmountOutdoubleRequired

The fiat payout amount (in cents) the withdrawer should receive.

- The fiat payout amount (in cents) the withdrawer should receive.

speedenumRequired

The withdraw delivery speed the payout is for.

inputTokenstringRequired

The token address or contract of the token which the user is withdrawing.

- The token address or contract of the token which the user is withdrawing.

merchantIdstringRequired

The merchant that this quote is for.

currencyenumOptional

The currency of exactAmountOut. Defaults to the account/withdrawer currency.

- The currency of `exactAmountOut`. Defaults to the account/withdrawer currency.

usePermitbooleanOptionalDefaults to true

[EVM only] whether the user’s wallet supports signing permit messages.

- [EVM only] whether the user's wallet supports signing permit messages.

accountTokenstringOptional

The token of the account to use

Response

inputAmountdouble

exactAmountOutobject

quoteobject

Represents the fees and limits associated with a withdrawal quote.