SPspinwheel
Use of Funds

Get a List of Use of Funds Objects

This API will allow you to get list of the useOfFunds created for a user with a userId.

get/v1/payments/useOfFunds

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/payments/useOfFunds
  • Auth
    API key in header Authorization

Query parameters

userIdstring required

User Id of the user you added useOfFunds allocation to.

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": [
    {
      "useOfFundsId": "435ed671-28ee-4000-8e72-21aa7e65faf1",
      "userId": "858abaaf-9ac5-4938-85ef-de00a98a597b",
      "allocation": [
        {
          "homeLoanId": "435ed671-2800-4a7f-8e72-21aa7e65faf1",
          "percentage": 50,
          "liabilityType": "HOME_LOAN"
        }
      ],
      "createdOn": 1614602485926,
      "updatedOn": 1614602485926
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.