SPspinwheel
Real-Time Data

Request Liability Data

This API will trigger the process of refreshing liabilities given in the POST body. This process is asynchronous and you can either poll results by using API GET /v1/users/{userId}/liabilities/refresh/{extRequestId} or register for a webhook

post/v1/users/{userId}/liabilities/refresh

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/users/{userId}/liabilities/refresh
  • Auth
    • API key in header Authorization
    • or API key in header Authorization

Path parameters

userIdstring required

Request body

extRequestIdstring required

The external ID for the liability request. Must be unique across the refreshes.

Example request

{
  "extRequestId": "a62d443a-d8a5-41c2-8d88-2022846c2cba",
  "studentLoans": [
    {
      "liabilityGroupId": "lc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ]
}

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": [
    {
      "refreshTransactionStatus": "IN_PROGRESS",
      "refreshTransactionId": "43ec068e-3ae0-4e40-826e-eaa007e1426f",
      "creditCardId": "fb444634-40a8-4a62-849d-4e2db7b8a9ad",
      "capability": "LIABILITY_GROUP_PAYOFF_QUOTE",
      "liabilityGroupId": "af82d047-98eb-46fd-b5d6-1ad02d6a4bee",
      "studentLoanIds": [
        "50ba9f11-ebf6-44dd-864d-7e9e6fe9d0a7",
        "c38b0a06-6464-4073-b5f6-3942af894c09"
      ],
      "nextEligibleRefreshOn": 1597753517524
    }
  ]
}

Changes

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