Get withdrawal

GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}

Bearer auth

This endpoint allows users to retrieve a withdrawal for a clients household saving.

Path parameters

HouseholdGUID string(uuid) Required

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

The SavingsGUID for the withdrawal you want to retrieve.
WithdrawalGUID string(uuid) Required

The WithdrawalGUID 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
  
  SavingsGUID string(uuid)
  
  TransactionAmount number(float)
  
  TransactionPercentage number(float)
  
  Frequency integer
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  EndBasis integer
  
  EndEventGUID string(uuid)
  
  EndAge integer
  
  EndDate string
  
  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}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}

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

Response examples (200)

{
  "success": true,
  "data": [
    {
      "TransactionGUID": "61895427-011A-9214-B13E-FCE305CB4112",
      "TransactionType": 7,
      "SavingsGUID": "9DC78406-6FE4-3DE3-F3CF-0B8948F567E4",
      "TransactionAmount": 100,
      "TransactionPercentage": 12,
      "Frequency": 52,
      "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",
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "FormattedValues": {
        "EndDate": "01/01/2025",
        "EndBasis": "Specific Age",
        "Frequency": "Paid Weekly",
        "StartBasis": "Current",
        "SavingsGUID": "API Test",
        "TransactionType": "Savings Income",
        "TransactionAmount": "£100",
        "TransactionPercentage": "12%"
      }
    }
  ]
}

Response examples (403)

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

Response examples (404)

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