API Reference

Generate preapproved offers

post
https://partners.staging-youlendapi.com/preapproval/PreApproval/offers
📘

Good to know

variableFactorRate defaults as false if not populated. When set to true, the size of the object returned by this endpoint can increase significantly.

Validation codes

The response can include payment data and renewal validation codes explaining why eligibility checks failed. These are separate from HTTP response statuses.

Payment-data validation

  • PV000: No settlement data was provided, or all settlement amounts are zero.
  • PV001: Settlement data does not cover the minimum required period.
  • PV002: The settlement history contains too many consecutive days with zero total settlement amounts.
  • PV003: The latest settlement data is too old.

Renewal validation

  • AOR001: The existing loan status is not eligible for renewal.
  • AOR002: Repayments on the existing funding are behind expectations.
  • AOR003: More of the existing funding must be repaid before renewal.

Body Params Formatting

ParamFormatExample
dateUTC2025-01-16T16:16:51.154Z
amountRegular amounts£100 should be inputted as 100
€120.50 should be inputted as 120.50
Body Params

A YL.Web.Api.ThirdParty.PreApproval.Models.PreApprovalRequestModel containing the data required to generate pre-approved offers

Model containing the pre-approval request body

string
required
length ≥ 1

Gets or sets the third party unique merchant identifier

string
enum
string | null

Gets or sets the unique merchant MCC

string
enum
required

Gets or sets the merchant payment data

paymentData
array of objects
required

Gets or sets the merchant payment data

paymentData*
boolean

Gets or sets the boolean indicating whether the customer has had a Loan in the past.

boolean

Gets or sets the boolean indicating whether the desired pre approved offers are provided for a unique factor rate or a range of different factor rates

boolean

Gets or sets the boolean indicating whether the partner would like to recieve a prequalification offer in addition to pre-approval

string
enum
required

Gets or sets the increment type that is used to generate the offer grid (sweep or loan amount)

Allowed:
secondaryLendingPartnerDetails
object
additionalInfo
object | null

Gets or sets additional info.

string

Gets or sets Customer Data.

Headers
string
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

Server Error

Updated 3 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 3 days ago

Did this page help you?