Get request approval

Perform a request to approve a previously created client's quote.

Request

Endpoint

Sandbox: http://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
Production: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}

Accepted Methods

POST

Authentication

This API requires authorization with shopId and X-Auth-Token header .

Prerequisites

A call to POST /api/shops/{shopId}/requests is required.

Parameters

Parameter Mandatory Type Format Description
amount Yes Integer Loan amount to be requested, in euro cents
instalments Yes Integer Number of instalments, from 3 to 60
loanFinality Yes String Loan finality
email Yes String Valid email address
lastname Yes String
firstname Yes String
iban No String
mobilePhone Yes String Do not include +39
countryCallingCode No String International prefix. Example: +39. Default value: +39
city Yes String
address Yes String Es. via roma, with no commas
province Yes String 2 uppercase chars Es: MI
postalCode Yes String Es: 20100
civicNumber Yes String 5 cifre
citizenship Yes String Citizenship - es: italian, eu for non-italian european citizenship, outside_eu for any citizenship outside Europe.
zeroInterestRate No Boolean Defaults on the shop settings
orderToken No String A token to match an existing order
residence No String Type of residence - Mandatory if additionalDataNeeded is true - es: 'rent', 'home_ownership', 'home_ownership_mortgage', 'home_business', 'with_relatives'
residenceStartDate No String MM/YYYY Residence start date - Mandatory if additionalDataNeeded is true - es: '01/2001'
educationalQualification No String Educational Qualification - Mandatory if additionalDataNeeded is true - es: 'middle_school', 'diploma', 'graduation', 'master', 'doctorate'
children No String Number of children - Mandatory if additionalDataNeeded is true - es: '1', '2' or '5+'
salaryType No String Salary type - Mandatory if additionalDataNeeded is true - es. 'net-monthly', 'gross-yearly'
salary No Integer Salary amount in euro without cents - Mandatory if additionalDataNeeded is true - es. 20000
paymentDayOfMonth No String Payment day of month

Response

This API returns a JSON object.

HTTP Response codes

Code Description
201 Resource has been created
400 A domain error occurred
403 Forbidden
500 System error

Valid response

{
     "approved": true,
     "approvalMessageApiFull": "Congratulations, your monthly payment has been approved.",
     "approvalMessageApiSemiFull": "Congratulations, your monthly payment has been approved. We've sent you an email with the instructions to complete your payment.",
     "email": "name@example.com",
     "lastname": "Rossi",
     "firstname": "Carlo",
     "fiscalCode": "SCOREP85R02C521Z",
     "mobilePhone": "3491234567",
     "city": "Milano",
     "address": "Via Sassetti",
     "province": "MI",
     "postalCode": "00200",
     "civicNumber": "32",
     "citizenship": "italian",
     "iban": "IT40S0542811101000000123456",
     "amount": 100000,
     "netAmount": 95000,
     "instalments": 12,
     "zeroInterestRate": true,
     "orderToken": "aafku7asdufjahg3",
     "paymentDayOfMonth": 15
}

Error response

{
 "errors": {
     "domain": [
         0: "Invalid fiscalCode."
         ]
     }
}