Simular um status da proposta (só sandbox)

POST

/v1/links/{id}/proposta/simular

curl --request POST \
  --url https://sandbox-api.eagleix-corban.com.br/v1/links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/proposta/simular \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "FORMALIZADA" }'

• Sandbox (só ambiente de teste)

Aplica um status à proposta de um link sandbox, como se o banco o tivesse informado, para você testar o recebimento de cada webhook. Segue as regras de transição: o status só avança (FORMALIZADA → APROVADA), nunca volta; RECUSADA e CANCELADA valem em qualquer ponto ativo e encerram a proposta.

Autorizações

• canalOAuth

Parâmetros

Path Parameters

id

required

string format: uuid

Corpo da requisição^required

Tipo de mídiaapplication/json

object

status

required

string

Allowed values: FORMALIZADA APROVADA RECUSADA CANCELADA

Respostas

200

Status aplicado (ou já estava nele, com alterado falso).

Tipo de mídiaapplication/json

object

status

string

alterado

boolean

Example ^generated

{
  "status": "example",
  "alterado": true
}

400

Status inválido (status_invalido).

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}

401

Token ausente, inválido ou expirado.

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized",
  "message": "token inválido ou expirado",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}

Headers

WWW-Authenticate

string

Example

Bearer error="invalid_token"

404

Link não encontrado.

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}

409

O cliente ainda não enviou a proposta (sem_proposta) ou a transição não é permitida (transicao_invalida).

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}