Menu
API - create request
API - create request
Create a payment request on the Soisy platform.
Request
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests
Produzione: https://api.soisy.it/api/shops/{shopId}/requests
Accepted methods
POST
Authentication
This API requires authentication viashopId and header X-Auth-Token.Prerequisites
To access this endpoint, you must have successfully completed creating an order.Parameters
| Parameter | Obligatory | Guy | Format | Description |
|---|---|---|---|---|
| amount | Yes | Entire | Total to be requested, in € cents | |
| instalments | Yup | Entire | Number of installments, from 3 to 60 | |
| privacy | Yes | Boolean | User approval of the privacy policy | |
| marketing | No | Boolean | Approval of the marketing policy by the user | |
| fiscal Code | Yes | String | 16 characters | Tax ID code |
| jobDescription | Yes | String | Job type. Allowed values: student, retired, unemployed, inheritance, entrepreneur, self_employed, seasonal_worker,freelance_professional ,employee_open_ended_contract ,employee_fixed_term_contract . | |
| actualJobEndingDate | No* | String | MM / YYYY | End of work date. Required if jobDescription is employee_fixed_term_contract |
| vatId | No* | String | 11 characters | VAT number. Mandatory if jobDescription is entrepreneur |
| vatCountry | No* | String | 2 uppercase characters | VAT number country. Required if jobDescription is entrepreneur |
| zeroInterestRate | No | Boolean | Enable zero rate. (#) If omitted, the Sales Channel setting will be used. |
Answer
The API returns a JSON object.HTTP response codes
| Code | Description |
|---|---|
| 201 | Resource created |
| 400 | Syntax or domain error |
| 403 | Failed to authenticate the request |
| 404 | Resource not found |
| 500 | System error |
Valid answer
The API returns a JSON object containing the data from the newly created request. The returned parameters are:
{
"apr": <float>,
"fiscalCode": <stringa>,
"totalRepayment": <intero>,
"instalmentAmount": <intero>,
"zeroInterestRate": <booleano>
"additionalDataNeeded": <booleano>
}
Where :
| Parameter | Guy | Description |
|---|---|---|
| apr | Entire | APR, in € cents |
| fiscal Code | String | Tax ID code |
| totalRepayment | Entire | Total to be repaid, in € cents |
| instalmentAmount | Entire | installment to be paid, in € cents |
| zeroInterestRate | Boolean | Indicates if the zero rate is active |
| additionalDataNeeded | Boolean | Indicates whether additional information is required in calls toRichiesta approvazione And Invio documenti |
Error response
The JSON object returned in the event of an error varies depending on the HTTP response code.Error 400
Responses with this HTTP code indicate a client-side error. The submitted request contained a formally incorrect parameter.
{
"errors": {
{parametro}: [
{messaggio}
]
}
}
Possible errors are listed below:
| Parameter | Message |
|---|---|
| amount | This value should be between 5000 and 1500000 |
| privacy | This value should be equal to “true”. |
| jobDescription | This value should not be empty |
| actualJobEndingDate | Invalid date format. The correct format is as follows: MM / YYYY |
| vatId | The VAT number must be a string |
| The country code of the VAT number must be a string | |
| The country code of the VAT number is not valid | |
| The VAT number is not valid for the country | |
| fiscal Code | Invalid tax code |
| instalments | The number of installments must be between 3 and 60 |
Error 403
The sent request contains invalid credentials. Check the shopId and headerX-Auth-Token . Find more info on credentials in the authentication paragraph.
{
"errors": "Authentication Failed"
}
Error 409
The submitted request could not be completed. More information is contained in the error message.
{
"errors": "messaggio"
}
Error 500
Responses with this HTTP code indicate that a system error has occurred.
{
"errors": "System error"
}
