Get withdrawal options
This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.
Path parameters
-
The GUID of the household you wish to get options for.
GET /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options
curl \
-X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/withdrawals/options \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"success": true,
"data": {
"TransactionType": {
"5": "Pension Income"
},
"WithdrawalStyle": {
"1": "Tax Free Cash Only",
"2": "Lifetime Annuity",
"3": "Flexible Access Drawdown"
},
"TFCBasis": {
"1": "None",
"2": "Max",
"3": "£"
},
"Frequency": {
"120": "One-off",
"52": "Paid Weekly",
"26": "Paid Fortnightly"
},
"WithdrawalPreference": {
"1": "Tax free",
"2": "Taxable Income",
"3": "Tax free only"
},
"StartBasis": {
"1": "Current",
"2": "Specific Age",
"3": "Specific Date"
},
"StartEventGUID": {
"8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
"1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
"E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
},
"EndBasis": {
"2": "Specific Age",
"3": "Specific Date",
"4": "Event"
},
"EndEventGUID": {
"8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
"1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
"E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
},
"AnnuityEscalationBasis": {
"1": "CPI",
"2": "RPI",
"3": "Fixed"
},
"BackOfficeSync": {
"1": "Yes",
"2": "No",
"3": "Only update from back office"
},
"IncomePreference": {
"1": "Take income",
"2": "Reinvest income"
},
"FundBasis": {
"1": "Total Fund",
"2": "£",
"3": "%"
}
}
}