Get withdrawals

GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals

This endpoint retrieves a list of all pension withdrawals belonging to the household. The response data will be an array of objects with each object being the data for one pension withdrawal

Path parameters

HouseholdGUID string(uuid) Required

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

The PensionGUID for the withdrawals you want to retrieve.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data array[object]
  
  Hide data attributes Show data attributes object
  
  TransactionGUID string(uuid)
  
  TransactionType integer
  
  PensionGUID string(uuid)
  
  WithdrawalStyle integer
  
  TFCBasis integer
  
  FundBasis integer
  
  FundAmount number(float)
  
  FundPercentage number(float)
  
  IncomeRate number(float)
  
  IncomePreference integer
  
  TFCAmount number(float)
  
  TFCPercentage number(float)
  
  AnnuityRate number(float)
  
  TransactionAmount number(float)
  
  TransactionPercentage number(float)
  
  Frequency integer
  
  WithdrawalPreference integer
  
  GuaranteePeriod integer
  
  SpousePension number(float)
  
  MaturityAmount number(float)
  
  AnnuityEscalationBasis integer
  
  AnnuityEscalationPercentage number(float)
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  EndBasis integer
  
  EndEventGUID string(uuid)
  
  EndAge integer
  
  EndDate string
  
  Term integer
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  FormattedValues object
403 application/json

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

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

GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals

curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "TransactionGUID": "61895427-011A-9214-B13E-FCE305CB4112",
      "TransactionType": 5,
      "PensionGUID": "76895427-011A-9214-B13E-FCE305CB4467",
      "WithdrawalStyle": 2,
      "TFCBasis": 2,
      "FundBasis": 1,
      "FundAmount": 100,
      "FundPercentage": 12,
      "IncomeRate": 12,
      "IncomePreference": 1,
      "TFCAmount": 100,
      "TFCPercentage": 12,
      "AnnuityRate": -2,
      "TransactionAmount": 100,
      "TransactionPercentage": 12,
      "Frequency": 26,
      "WithdrawalPreference": 1,
      "GuaranteePeriod": 12,
      "SpousePension": 1.1,
      "MaturityAmount": 1000,
      "AnnuityEscalationBasis": 3,
      "AnnuityEscalationPercentage": 1.1,
      "StartBasis": 3,
      "StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "StartAge": 42,
      "StartDate": "2024-01-01",
      "EndBasis": 3,
      "EndEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "EndAge": 65,
      "EndDate": "2025-01-01",
      "Term": 10,
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "FormattedValues": {
        "TFCBasis": "Max",
        "Frequency": "Paid Fortnightly",
        "FundBasis": "Total Fund",
        "StartDate": "01/01/2024",
        "TFCAmount": "£100",
        "FundAmount": "£100",
        "IncomeRate": "12%",
        "StartBasis": "Specific Date",
        "AnnuityRate": "-2%",
        "PensionGUID": "My Pension",
        "SpousePension": "1%",
        "TFCPercentage": "12%",
        "FundPercentage": "12%",
        "MaturityAmount": "£1000",
        "TransactionType": "Pension Income",
        "WithdrawalStyle": "Lifetime Annuity",
        "TransactionAmount": "£100",
        "WithdrawalPreference": "Tax free",
        "AnnuityEscalationBasis": "Fixed",
        "AnnuityEscalationPercentage": "1%"
      }
    }
  ]
}

Response examples (403)

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

Response examples (404)

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