Get withdrawal options

GET /api/v2/household/{HouseholdGUID}/savings/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
      Hide data attributes Show data attributes object
      • TransactionType object
        Hide TransactionType attributes Show TransactionType attributes object
        • 6 string

          Value is Dividend Income.

        • 7 string

          Value is Savings Income.

      • Frequency object
        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.

      • StartBasis object
        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
        Hide StartEventGUID attributes Show StartEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • EndBasis object
        Hide EndBasis attributes Show EndBasis attributes object
        • 1 string

          Value is Current.

        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

      • EndEventGUID object
        Hide EndEventGUID attributes Show EndEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • BackOfficeSync object
        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.

      • ReduceFund object
        Hide ReduceFund attributes Show ReduceFund attributes object
        • NULL string

          Value is No.

        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • TakeNaturalIncome object
        Hide TakeNaturalIncome attributes Show TakeNaturalIncome attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.
GET /api/v2/household/{HouseholdGUID}/savings/withdrawals/options 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/savings/withdrawals/options' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "TransactionType": {
      "6": "Dividend Income",
      "7": "Savings Income"
    },
    "Frequency": {
      "120": "One-off",
      "52": "Paid Weekly",
      "26": "Paid Fortnightly"
    },
    "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": {
      "1": "Current",
      "2": "Specific Age",
      "3": "Specific Date"
    },
    "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"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    },
    "ReduceFund": {
      "NULL": "No",
      "1": "Yes",
      "2": "No"
    },
    "TakeNaturalIncome": {
      "1": "Yes",
      "2": "No"
    }
  }
}