Spaces

Get all active savings and spending spaces

Changed on
get/api/v2/account/{accountUid}/spaces

Request

Path parameters

accountUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Account uid

Response

Successful operation

Example response

{
  "savingsGoals": [
    {
      "savingsGoalUid": "77887788-7788-7788-7788-778877887788",
      "name": "Trip to Paris",
      "target": {
        "currency": "GBP",
        "minorUnits": 123456
      },
      "totalSaved": {
        "currency": "GBP",
        "minorUnits": 123456
      },
      "savedPercentage": 100,
      "state": "ACTIVE"
    }
  ],
  "spendingSpaces": [
    {
      "spaceUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
      "name": "Shopping",
      "balance": {
        "currency": "GBP",
        "minorUnits": 123456
      },
      "cardAssociationUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
      "state": "ACTIVE"
    }
  ]
}

Changes

    • warning

      added the new CONNECTED enum value to the // response property for the response status

    • warning

      added the new U16 enum value to the // response property for the response status

    • info

      removed the CHILDCARE enum value from the // response property for the response status

    • info

      removed the CHILDCARE_V2 enum value from the // response property for the response status

    • info

      removed the HELPING_OUT enum value from the // response property for the response status

    • info

      removed the SHOPPING enum value from the // response property for the response status

    • info

      removed the SHOPPING_V2 enum value from the // response property for the response status

    • info

      removed the SPARE enum value from the // response property for the response status

    • info

      removed the SPARE_CARD enum value from the // response property for the response status

    • info

      removed the YOUNG_PERSON enum value from the // response property for the response status

    • breaking

      the response property // became optional for the status

    • info

      removed the optional write-only property spendingSpaces/items/uid from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status