# Create withdrawal **POST /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals** This endpoint allows users to create a new pension withdrawal. ## Servers - https://api.fincalc.co.uk: https://api.fincalc.co.uk () ## Authentication methods - Bearer auth ## Parameters #### Path parameters - **HouseholdGUID** (string(uuid)) The HouseholdGUID of the client. - **PensionGUID** (string(uuid)) The PensionGUID you want to create a withdrawal for. Should only be linked to PensionGUID which has PensionType = 3. ## Body parameters Content-type: application/json - **TransactionType** (integer) TransactionType must be 5. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **WithdrawalStyle** (integer) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **TFCBasis** (integer | null) This field is required if the value of WithdrawalStyle = 1, 2, 3, 5 or 7. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **FundBasis** (integer | null) This field is required if the value of WithdrawalStyle = 2 or 5. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **FundAmount** (number(float) | null) This field is required if the value of FundBasis = 2 or the value of WithdrawalStyle = 7. The value must be greater than or equal to 0. - **FundPercentage** (number(float) | null) This field is required if the value of FundBasis = 3. The value must be greater than or equal to 0. - **IncomeRate** (number(float) | null) This field is required if the value of WithdrawalStyle = 5. The value must be greater than or equal to 0. - **IncomePreference** (integer | null) This field is required if the value of WithdrawalStyle = 5. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **TFCAmount** (number(float) | null) This field is required if the value of TFCBasis = 3. The value must be greater than or equal to 0. - **TFCPercentage** (number(float) | null) This field is required if the value of TFCBasis = 4. The value must be greater than or equal to 0. - **AnnuityRate** (number(float) | null) This field is required if the value of WithdrawalStyle = 2. The value can be a negative number. - **TransactionAmount** (number(float) | null) This field is required if the value of WithdrawalStyle = 7 or WithdrawalStyle = 3, 4 or 6 and the value of TransactionPercentage = 0. The value must be greater than or equal to 0. - **TransactionPercentage** (number(float) | null) This field is required if the value of WithdrawalStyle = 3, 4 or 6 and the value of TransactionAmount = 0. The value must be greater than or equal to 0. - **Frequency** (integer) This field is required if the value of WithdrawalStyle is not = 5. When the value of WithdrawalStyle = 1, Frequency must be 120. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **WithdrawalPreference** (integer | null) This field is required if the value of WithdrawalStyle = 3. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **GuaranteePeriod** (integer | null) This field is required if the value of WithdrawalStyle = 2. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **SpousePension** (number(float) | null) This field is required if the value of WithdrawalStyle = 2. The value must be greater than or equal to 0. - **MaturityAmount** (number(float) | null) This field is required if the value of WithdrawalStyle = 7. The value must be greater than or equal to 0. - **AnnuityEscalationBasis** (integer | null) This field is required if the value of WithdrawalStyle = 2 or 7. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **AnnuityEscalationPercentage** (number(float) | null) This field is required if the value of WithdrawalStyle = 2 or 7 and the value of AnnuityEscalationBasis = 3. The value must be greater than or equal to 0. - **StartBasis** (integer) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **StartEventGUID** (string(uuid) | null) This field is required if the value of StartBasis = 4. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **StartAge** (integer | null) This field is required if the value of StartBasis = 2 or 7. The value of StartAge must be in the future. - **StartDate** (string | null) This field is required if the value of StartBasis = 3. The value of StartDate must be in the future. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. - **EndBasis** (integer | null) This field is required if the value of Frequency is not = 120 and the value of WithdrawalStyle is not = 1, 2, 5 or 7. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **EndEventGUID** (string(uuid) | null) This field is required if the value of EndBasis = 4 and the value of Frequency is not = 120 and the value of WithdrawalStyle is not = 1, 2, 5 or 7. Event end must be after starting. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **EndAge** (integer | null) This field is required if the value of EndBasis = 2 or 7 and the value of Frequency is not = 120 and the value of WithdrawalStyle is not = 1, 2, 5 or 7. EndAge must be after starting. - **EndDate** (string | null) This field is required if the value of EndBasis = 3 and the value of Frequency is not = 120 and the value of WithdrawalStyle is not = 1, 2, 5 or 7. EndDate must be after starting. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. - **Term** (integer | null) This field is required if the value of WithdrawalStyle = 7. - **BackOfficeID** (string | null) - **BackOfficeSync** (integer | null) An integer representing the status of the back office sync: - 1: Yes - 2: No - 3: Only update from back office - **ExcludeFormattedValues** (string | null) If set to any value, formatted values will be excluded from the response. - **TakeNaturalIncome** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options - **DeathBasis** (integer) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options ## Responses ### 201: Success #### Body Parameters: application/json (object) - **success** (boolean) - **data** (object) ### 403: Permission error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 404: Household not found #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 422: Validation error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) - **data** (object) Example validation error message. ### 500: Internal server error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) [Powered by Bump.sh](https://bump.sh)