Pular para o conteúdo principal

Carteira - Aprovação

Aprova ou reprova a carteira de validação. Só é aceito para carteiras no status pending_confirmation — o status em que a carteira fica quando está pronta para a sua análise e em que a gestora recebe o webhook de mudança de status.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiEscrita

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/composition/fund_class/FUND_CLASS_KEY/composition/COMPOSITION_KEY
MÉTODO
PUT
Request Body — aprovar
{
"new_status": "confirmed"
}
Request Body — reprovar
{
"new_status": "reproved_by_agent",
"reproved_reason": "Cota divergente do controle interno da gestora."
}
CampoTipoObrigatórioDescrição
new_statusstringSimNovo status da carteira. Ver enumeradores abaixo.
reproved_reasonstringSim, quando new_status é reproved_by_agentMotivo da reprovação, de 1 a 255 caracteres.

Enumeradores do "new_status"​

EnumeradorDescrição
confirmedAprova a carteira.
reproved_by_agentReprova a carteira, registrando o motivo informado em reproved_reason.
reprovedReprova a carteira sem exigir motivo. Prefira reproved_by_agent.

O motivo da reprovação fica registrado no histórico da carteira: o campo status_events da consulta da carteira traz cada mudança de status com o seu metadata.

Response​

Em caso de sucesso, a API devolve 204 No Content, sem corpo. Consulte a carteira para ver o novo status.

Erros​

StatusCódigoQuando acontece
404CMP000013A carteira não está em pending_confirmation (já foi aprovada, reprovada ou ainda está em processamento).
404CMP000010new_status diferente de confirmed, reproved_by_agent ou reproved.
404CMP000025new_status é reproved_by_agent e reproved_reason não foi enviado.
404CMP000012Não existe carteira com essa composition_key na classe informada.
404CMP000001Não existe classe com essa fund_class_key.
409CMP000022Já existe outra carteira da mesma classe, data e tipo no status pedido.
400QIT000001Corpo fora do contrato: new_status ausente ou fora dos valores aceitos, ou campo não previsto.
400QIT000004A fund_class_key é de uma classe de outra gestora.

Erros de autenticação, permissão e host: veja Erros da API.