Pular para o conteúdo principal

Simular parcelas

GET/api/v1/bank/public/charge/{uuid}/simulate-installment
Endpoint público

Este endpoint é chamado pela página de checkout ou SDK para exibir ao pagador as opções de parcelamento disponíveis. Não requer Bearer token — o UUID da cobrança fornece o contexto.


Cabeçalhos da requisição

CabeçalhoValorObrigatório
Acceptapplication/jsonRecomendado

Parâmetros de caminho

CampoTipoObrigatórioDescrição
uuidstring (UUID)SimUUID da cobrança para simular parcelas

Campos da resposta

CampoTipoDescrição
charge_uuidstringIdentificador da cobrança
total_amountnumberValor original da cobrança
currencystringCódigo da moeda
installmentsarrayOpções de parcelamento disponíveis
installments[].countintegerNúmero de parcelas (1, 2, 3, …12)
installments[].installment_valuenumberValor por parcela
installments[].total_amountnumberTotal com juros (se aplicável)
installments[].interest_ratenumberTaxa de juros mensal (0 para sem juros)
installments[].interest_freebooleanSe esta opção tem juros zero

Códigos de status HTTP

StatusDescrição
200Simulação de parcelamento retornada
404Cobrança não encontrada ou expirada
422Tipo de cobrança não suporta parcelamento
429Limite de requisições excedido
500Erro interno do servidor

Exemplos de código

curl -s -X GET "https://core-manager.a55.tech/api/v1/bank/public/charge/a1b2c3d4-e5f6-7890-abcd-ef1234567890/simulate-installment"

Exemplo de resposta de erro

{
"status": "error",
"message": [
{
"code": "CHARGE_NOT_FOUND",
"source": "simulation",
"description": "Charge a1b2c3d4-e5f6-7890-abcd-ef1234567890 not found or expired"
}
]
}