ResponseWrapperSimulationDto
statusstring
Status of the response
Possible values: [SUCCESS, ERROR]
Example:
ERROR/SUCCESSmessagestring
Message describing the response
Example:
Request failed/Request successfulcodeMessagestring
Code message describing the response
Example:
ERR-001/SUC-001data object
monthlyPaymentnumber
financingTypestring
Possible values: [REAL_ESTATE, VEHICLE, EQUIPMENT, TREASURY, CREDIT_LINE, CREDIT_LINE_DRAW, CARTE_EM]
financingTypeLabelstring
professionalSituationstring
professionalSituationLabelstring
segmentstring
Possible values: [P_SegmentClientContrat, E_SegmentClientContrat, PR_SegmentClientContrat]
segmentLabelstring
assetPricenumber
assetPriceFormattedstring
personalContributionnumber
personalContributionFormattedstring
financingAmountnumber
financingAmountFormattedstring
durationMonthsinteger<int32>
totalSalePricenumber
totalSalePriceFormattedstring
marginnumber
marginFormattedstring
additionalFeesnumber
additionalFeesFormattedstring
monthlyPaymentFormattedstring
error object
Detailed information about the error response
codestring
Error code
Example:
ERR-142messagestring
Error message
Example:
Resource not found / Internal server errordetails object[]
List of error details
Array [
codestring
Error code
Example:
ER4001messagestring
Detailed error message
Example:
Invalid inputtargetstring
Target of the error
Example:
username]
suggestionsstring[]
List of suggestions for resolving the error
Example:
["Check the resource ID","Ensure the resource exists"]metaData object
Additional metadata about the error, that could help in debugging
property name*string
Additional metadata about the error, that could help in debugging
Example:
{"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}timestampstring<date-time>
Timestamp of when the response was generated
ResponseWrapperSimulationDto
{
"status": "ERROR/SUCCESS",
"message": "Request failed/Request successful",
"codeMessage": "ERR-001/SUC-001",
"data": {
"monthlyPayment": 0,
"financingType": "REAL_ESTATE",
"financingTypeLabel": "string",
"professionalSituation": "string",
"professionalSituationLabel": "string",
"segment": "P_SegmentClientContrat",
"segmentLabel": "string",
"assetPrice": 0,
"assetPriceFormatted": "string",
"personalContribution": 0,
"personalContributionFormatted": "string",
"financingAmount": 0,
"financingAmountFormatted": "string",
"durationMonths": 0,
"totalSalePrice": 0,
"totalSalePriceFormatted": "string",
"margin": 0,
"marginFormatted": "string",
"additionalFees": 0,
"additionalFeesFormatted": "string",
"monthlyPaymentFormatted": "string"
},
"error": {
"code": "ERR-142",
"message": "Resource not found / Internal server error",
"details": [
{
"code": "ER4001",
"message": "Invalid input",
"target": "username"
}
],
"suggestions": [
"Check the resource ID",
"Ensure the resource exists"
],
"metaData": {
"requestId": "3c5e4cebf39cbc5b",
"operationId": "66fd4d2ae6b6"
}
},
"timestamp": "2024-07-29T15:51:28.071Z"
}