Simula a tabela de parcelamento de um valor
/v1/simulators/installmentsAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros de consulta
amountintegerobrigatórioValor a simular, em centavos (mínimo 500).
feenumberJuros a simular, como percentual (0–100), no lugar dos configurados na sua conta.
resourcestringcreditounupay.Valores:creditnupaymodelstringAceito por compatibilidade; sem efeito.
Respostas
200Sucesso
_linksobjectobrigatórioLinks para os outros simuladores.
+3 campos de
_linksselfobjectobrigatórioUm link para uma operação relacionada.
+2 campos de
selfhrefstringobrigatórioURL absoluta da operação.
methodstringobrigatórioMétodo HTTP da operação.
installmentobjectobrigatórioUm link para uma operação relacionada.
+2 campos de
installmenthrefstringobrigatórioURL absoluta da operação.
methodstringobrigatórioMétodo HTTP da operação.
paymentMethodsobjectobrigatórioUm link para uma operação relacionada.
+2 campos de
paymentMethodshrefstringobrigatórioURL absoluta da operação.
methodstringobrigatórioMétodo HTTP da operação.
planIdstringobrigatóriopode ser nuloO plano de taxas usado;
nullquando a conta não tem.merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
resourcestringobrigatórioO meio simulado.
Valores:creditnupayinstallmentsobject[]obrigatórioAs opções de parcelamento, de 1 até o máximo da sua conta.
+5 campos de
installmentsextraFeebooleanobrigatórioSe o comprador paga juros nesta opção.
descriptionstringobrigatórioA opção, em texto (ex.:
3x de R$ 17,20).installmentintegerobrigatórioNúmero de parcelas.
totalAmountCentsintegerobrigatórioTotal pago pelo comprador, em centavos (igual a
amountquando sem juros).installmentAmountCentsintegerobrigatórioValor de cada parcela, em centavos.
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório