Affordability Check

Affordability API evaluates whether a customer can reasonably afford a requested short-term loan based on their financial profile. By providing the loan amount, number of instalments, and duration in days, the API calculates a simple affordability score and returns a clear decision (approve, review, or decline) along with a reason if the loan is not affordable. This helps lenders make quick, transparent, and responsible credit decisions.

Check affordability & decision for a short‑term loan

post

Return a simple affordability score and suggested decision for the requested loan.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

numberOfInstalmentsinteger · min: 1 · max: 12RequiredExample: 3

loanDurationDaysinteger · min: 1 · max: 365RequiredExample: 90

emailstringRequired

Customer registered email

Responses

200

Affordability result

application/json

401

Unauthorized

404

Customer or transactions not found

422

Invalid request (e.g., negative amount)

post

/api/v2/partner/affordability/check

HTTPcURLJavaScriptPython

POST /api/v2/partner/affordability/check HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "loanAmount": {
    "amount": 350,
    "currency": "GBP"
  },
  "numberOfInstalments": 2,
  "loanDurationDays": 90,
  "email": "[email protected]"
}

{
  "affordabilityScore": 720,
  "decision": "approve",
  "reason": null
}