Simula as taxas e os totais de um meio de pagamento
/v1/simulators/payment-methodsAutentique 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.
installmentintegerNúmero de parcelas (cartão e NuPay).
methodstringobrigatórioO meio de pagamento a simular.
Valores:nupaycreditbilletpixbrandstringAceito por compatibilidade; não muda os totais.
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.
installmentsobjectobrigatórioUm link para uma operação relacionada.
+2 campos de
installmentshrefstringobrigatórioURL absoluta da operação.
methodstringobrigatórioMétodo HTTP da operação.
amountobjectobrigatórioO que o comprador paga.
+2 campos de
amountcentsintegerobrigatórioEm centavos.
decimalnumberobrigatórioEm reais (decimal).
planIdstringobrigatóriopode ser nuloO plano de taxas usado;
nullquando a conta não tem.isCustombooleanobrigatórioSe um
feepersonalizado foi usado no lugar da configuração da conta.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.
originalobjectobrigatórioO valor simulado.
+2 campos de
originalcentsintegerobrigatórioEm centavos.
decimalnumberobrigatórioEm reais (decimal).
resourcestringobrigatórioO meio simulado.
Valores:nupaycreditbilletpixtotalFeesobjectobrigatórioAs taxas por cima do valor.
+2 campos de
totalFeescentsintegerobrigatórioEm centavos.
decimalnumberobrigatórioEm reais (decimal).
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