SPspinwheel
Alerts & Monitoring

Subscribe to Statement Updates

API will create subscriptions for liabilities given in the POST body.This process is asynchronous and you can get results by registering for a webhooks

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

Request

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

Path parameters

userIdstring required

Request body

Example request

{
  "creditCards": [
    {
      "id": "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ],
  "homeLoans": [
    {
      "id": "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ],
  "autoLoans": [
    {
      "id": "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ],
  "studentLoans": [
    {
      "id": "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ],
  "personalLoans": [
    {
      "id": "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ],
  "miscellaneousLiabilities": [
    {
      "id": "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
    }
  ]
}

Response

Response for credit card subscription

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": [
    {
      "subscriptionId": "43ec068e-3ae0-4e40-826e-eaa007e1426f",
      "creditCardId": "fb444634-40a8-4a62-849d-4e2db7b8a9ad",
      "autoLoanId": "2200aefc-07ce-415a-9d78-6e7eb2dfa2e2",
      "homeLoanId": "27363a96-619e-4a21-9377-e920531847b3",
      "studentLoanId": "96767b68-3553-4163-9280-d713cbfd8327",
      "personalLoanId": "2c12281c-afc9-4ad3-bcea-e18894722d84",
      "miscellaneousLiabilityId": "72a1374c-97a0-45bb-991e-44b797a627e9",
      "subscriptionType": "STATEMENT_SUMMARY",
      "userId": "f6815836-0bcd-4b37-8f6c-5a0ad70360ff"
    }
  ]
}

Changes

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