Delete withdrawal

DELETE /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}

Bearer auth

This endpoint allows users to delete a household pension withdrawal.

Path parameters

HouseholdGUID string(uuid) Required

The HouseholdGUID of the client.
PensionGUID string(uuid) Required

The PensionGUID for the withdrawal you want to delete.
PensionWithdrawalGUID string(uuid) Required

The PensionWithdrawalGUID you want to delete.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- message string
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Withdrawal not found
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

DELETE /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}

curl \
 --request DELETE 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "message": "Withdrawal deleted successfully"
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to edit the household."
}

Response examples (404)

{
  "success": false,
  "message": "Withdrawal not found."
}