`useCashout`

Overview

useCashout is a custom React hook that manages the state and logic for the credit cashout flow. It fetches available giftcard options, filters them, provides brand data and completes the flow by building and broadcasting the required blockchain transaction to obtain the link to the giftcard.

Important:
useCashout must be used within a CashoutProvider.

Values & State Variables

Name	Type	Description
`cashoutMethod`	`string`	Method used for cashout
`minCashoutAmount`	`number`	Minimum possible amount for cashout
`maxCashoutAmount`	`number`	Maximum possible amount for cashout (dependent on the user’s balance)
`tilloStage`	`string`	Current stage of the cashout flow with tillo (`filter`, `brand`, `giftcard`)
`giftcardAmount`	`number`	Amount set to request giftcard cashout
`giftcardLink`	`string`	Link to giftcard
`tilloCountryOptions`	`array`	List of countries available for Tillo cashout
`tilloCurrencyOptions`	`array`	List of currencies available for tillo cashout
`tilloBrands`	`array`	All giftcard brands available for Tillo cashout
`tilloSelection`	`array`	Filtered giftcard brands based on country, currency and amount
`brandData`	`object`	Detailed data for a single selected brand

Functions

Function	Parameters	Return Type	Description
`checkBalance`	`()`	`boolean`	Checks if balance is sufficiently high for a cashout
`filterTilloBrands`	`(country: string, currency: string )`	`array`	Filters Tillo brands and stores them in `tilloSelection` and additionally returns it.
`handleTilloBrandChange`	`(e: Event)`	`void`	Stores selected Tillo brand from `brand-form` in `brandData`
`getGiftcardLink`	`(brand: string, onError: function)`	`string`
`setGiftcardAmount`	`(amount: number)`	`void`	Stores currently selected amount for giftcard cashout
`setTilloStage`	`(stage: string)`	`void`	State can be used to move from one tillo stage to the next one (‘filter’, ‘brand’, ‘giftcard’)