POST api/ConsumerBorrower/v1/GetConsumerLoanOffer

Returns initial generic loan offer with given loan amount and loan duration. Use this for loan calculator etc. Does not do any credit decision.

Request Information

URI Parameters

None.

Body Parameters

GetConsumerLoanOfferRequest
NameDescriptionTypeAdditional information
brandCode

Brand code of loan: FF, FP, ...

string

None.

loanAmount

Loan amount

decimal number

None.

installmentCount

Loan duration in months

integer

None.

interestRate

Intrest rate used for calculation

decimal number

None.

OrganizationCode

string

None.

UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "brandCode": "sample string 1",
  "loanAmount": 2.0,
  "installmentCount": 3,
  "interestRate": 1.0,
  "OrganizationCode": "sample string 4",
  "UserName": "sample string 5",
  "Password": "sample string 6"
}

application/xml, text/xml

Sample:
<GetConsumerLoanOfferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.ConsumerBorrower">
  <OrganizationCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 6</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 5</UserName>
  <brandCode>sample string 1</brandCode>
  <installmentCount>3</installmentCount>
  <interestRate>1</interestRate>
  <loanAmount>2</loanAmount>
</GetConsumerLoanOfferRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetConsumerLoanOfferRequest'.

Response Information

Resource Description

GetConsumerLoanOfferReply
NameDescriptionTypeAdditional information
Reply

LoanOffer

None.

Ok

boolean

None.

ErrorMessage

string

None.

ErrorCode

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Reply": {
    "LoanAmount": 1.0,
    "InstallmentCount": 2,
    "InstallmentAmount": 3.0,
    "InterestRate": 4.0,
    "ActualYearlyInterestRate": 5.0,
    "OpeningFee": 6.0,
    "InstallmentFee": 7.0
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<GetConsumerLoanOfferReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.ConsumerBorrower">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Message>
  <Ok xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">true</Ok>
  <Reply>
    <ActualYearlyInterestRate>5</ActualYearlyInterestRate>
    <InstallmentAmount>3</InstallmentAmount>
    <InstallmentCount>2</InstallmentCount>
    <InstallmentFee>7</InstallmentFee>
    <InterestRate>4</InterestRate>
    <LoanAmount>1</LoanAmount>
    <OpeningFee>6</OpeningFee>
  </Reply>
</GetConsumerLoanOfferReply>