Sign in

v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB
PreApproval

Generate preapproved offers

post/PreApproval/offers

Headers

api-versionstring

Request body

thirdPartyCustomerIdstring required

Gets or sets the third party unique merchant identifier

companyType'Ltd' | 'Plc' | 'Llp' | 'SoleTrader' | 'Partnership' | 'Llc' | 'BusinessCorporation' | 'Dac' | 'Eenmanszaak' | 'NaamlozeVennootschap' | 'Bv' | 'Cv' | 'Nv' | 'Vof' | 'SpZoo' | 'SpkSpj' | 'Scspp' | 'SaSKA' | 'Jdg' | 'GmbhUg' | 'EK' | 'Gewerbebetrieb' | 'GbrOhg' | 'Gbr' | 'EGbr' | 'Ohg' | 'Kg' | 'Aktiengesellschaft' | 'SlSlne' | 'SociedadColectiva' | 'SociedadComanditaria' | 'EIAutonomo' | 'SociedadCivil' | 'SociedadCooperativa' | 'SNC' | 'EINomPropre' | 'SARL' | 'SocieteCooperative' | 'SA' | 'SAS' | 'EURL' | 'SCP' | 'SCS' | 'SASU' | 'EnterpriseIndividuelle' | 'SocieteAnonyme' | 'SRL' | 'SComm' | 'AS' | 'ApS' | 'KS' | 'PS' | 'Fmba' | 'Andelsselskab' | 'Amba' | 'ErhvervsdrivendeFond' | 'IS' | 'Smba' | 'SI' | 'SelvstændigOffentligVirksomhed' | 'Partrederi' | 'Filial' | 'Enkeltmandsvirksomhed' | 'PMV' | 'Forening'
merchantMccstring nullable

Gets or sets the unique merchant MCC

countryISOCode'GBR' | 'USA' | 'NLD' | 'BEL' | 'DEU' | 'FRA' | 'DNK' | 'IRL' | 'POL' required

Gets or sets the merchant payment data

isRenewalboolean

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

variableFactorRateboolean

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

requestPreQualificationboolean

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

regularIncrementTypeForOfferGrid'LoanAmount' | 'Sweep' required

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

additionalInfoobject nullable

Gets or sets additional info.

{"stackTrail":"components:schemas:PreApprovalRequestModel:properties:customerData","oasType":"schema","type":"unknown","description":"Gets or sets Customer Data.","nullable":true}

Response

Success

merchantIsEligibleForPreApprovalboolean

Gets or sets the boolean indicating whether the merchant is eligible for pre approved offers. If this is false, the PreApprovedOffersModel will be null

merchantIsInControlGroupboolean

Gets or sets the boolean indicating whether the merchant is in the control group, this is an indicator that the merchant is not eligible for pre-approved offers.

loanTypestring nullable

Gets or sets the type of loan (Initial, Renewal, Early Renewal)

isRepaymentHolidayboolean

Gets or sets the repayment holiday flag