Get withdrawal options

GET /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options
Bearer auth

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

  • HouseholdGUID string(uuid) Required

    The GUID of the household you wish to get options for.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • TransactionType object

        Additional properties are allowed.

        Hide TransactionType attribute Show TransactionType attribute object
        • 5 string

          Value is Pension Income.

      • WithdrawalStyle object

        Additional properties are allowed.

        Hide WithdrawalStyle attributes Show WithdrawalStyle attributes object
        • 1 string

          Value is Tax Free Cash Only.

        • 2 string

          Value is Lifetime Annuity.

        • 3 string

          Value is Flexible Access Drawdown.

      • TFCBasis object

        Additional properties are allowed.

        Hide TFCBasis attributes Show TFCBasis attributes object
        • 1 string

          Value is None.

        • 2 string

          Value is Max.

        • 3 string

          Value is £.

      • Frequency object

        Additional properties are allowed.

        Hide Frequency attributes Show Frequency attributes object
        • 120 string

          Value is One-off.

        • 52 string

          Value is Paid Weekly.

        • 26 string

          Value is Paid Fortnightly.

      • WithdrawalPreference object

        Additional properties are allowed.

        Hide WithdrawalPreference attributes Show WithdrawalPreference attributes object
        • 1 string

          Value is Tax free.

        • 2 string

          Value is Taxable Income.

        • 3 string

          Value is Tax free only.

      • StartBasis object

        Additional properties are allowed.

        Hide StartBasis attributes Show StartBasis attributes object
        • 1 string

          Value is Current.

        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

      • StartEventGUID object

        Additional properties are allowed.

        Hide StartEventGUID attributes Show StartEventGUID attributes object
      • EndBasis object

        Additional properties are allowed.

        Hide EndBasis attributes Show EndBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • EndEventGUID object

        Additional properties are allowed.

        Hide EndEventGUID attributes Show EndEventGUID attributes object
      • AnnuityEscalationBasis object

        Additional properties are allowed.

        Hide AnnuityEscalationBasis attributes Show AnnuityEscalationBasis attributes object
        • 1 string

          Value is CPI.

        • 2 string

          Value is RPI.

        • 3 string

          Value is Fixed.

      • BackOfficeSync object

        Additional properties are allowed.

        Hide BackOfficeSync attributes Show BackOfficeSync attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

        • 3 string

          Value is Only update from back office.

      • IncomePreference object

        Additional properties are allowed.

        Hide IncomePreference attributes Show IncomePreference attributes object
        • 1 string

          Value is Take income.

        • 2 string

          Value is Reinvest income.

      • FundBasis object

        Additional properties are allowed.

        Hide FundBasis attributes Show FundBasis attributes object
        • 1 string

          Value is Total Fund.

        • 2 string

          Value is £.

        • 3 string

          Value is %.
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": "%"
    }
  }
}