Simulador de Recebimento

GET/v1/payments-simulator

Retorna o valor a ser cobrado em diferentes formas de parcelamento para receber um valor líquido específico.

O valor enviado e o retorno deste endpoint estão no formato decimal (com casas decimais), ao contrário dos endpoints de pagamento e cancelamento que utilizam centavos (inteiro).

Realizar Simulação de Recebimento

Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://api.enoqpay.com.br/gateway/v1/payments-simulator?Brand={brand}&netValue={netValue}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

{
  "installments": [
    { "installment": 1, "amount": 1035.24 },
    { "installment": 2, "amount": 1046.98 },
    { "installment": 3, "amount": 1052.82 },
    { "installment": 4, "amount": 1058.72 },
    { "installment": 5, "amount": 1064.68 },
    { "installment": 6, "amount": 1070.71 },
    { "installment": 7, "amount": 1083.51 },
    { "installment": 8, "amount": 1089.72 },
    { "installment": 9, "amount": 1096.00 },
    { "installment": 10, "amount": 1102.36 },
    { "installment": 11, "amount": 1108.78 },
    { "installment": 12, "amount": 1115.29 }
  ]
}

Dicionário de dados

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

[
  {
    "tag": "",
    "description": "Bandeira não identificada"
  }
]

Observado em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

[
  {
    "tag": "NetValue",
    "description": "O valor precisa ser maior do que 0"
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.