Generate operation by a simulation

The generate operation by simulation route initiates the process of generating an operation based on a simulation.

🚧

Attention point:

  • To consume the route it is necessary to pass the simulation code as a parameter.
  • Every simulation requires a CPF/CNPJ for consumption, at the time of formalizing the operation and it is necessary to consume the customer registration routes to proceed with the launch of the operation.
  • Operations that are not in status 5, 7, or 35 will be automatically canceled within 5 days, except for FGTS operations.
  • FGTS operations that are not in status 5, 7 or 35 will be automatically canceled within 48 hours.
  • After launching the operation, the operator will be able to consume the payment, subscription and movement routes with the code that will be made available.
  • If the operation is for an individual client, they will be automatically linked as the borrower subscriber of the operation.

Response

Http CodeReturn CodeMessage
200200-01Success.
400400-01Something unexpected happened.
400400-25The simulation hash is not available.
400400-28Error launching the installments FGTS.
400400-35Invalid installment, code 'X' for the FGTS installment has already been used in another release. Therefore the current simulation code is being deactivated.
400400-43Error when registering the result of the installments.
400400-46Error when registering the result of the operation.
400400-52Customer was not found.
401401-05Unauthorized or token invalid
429429-01Too many requests

Response Parameters

ParameterFormatDescription
request_codestringThe unique code identifying the request.
returnbooleanIndicates if the request was successful (true/false).
return_codestringCode indicating the status of the request.
messagestringMessage indicating the result of the request.
data.codestringUnique code identifying the simulation.
data.code_operationnumberCode identifying the operation.

Request Parameters

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!