Skip to main content

​
Overview

The Akatus.ConsultaParcelamento.Consulta class enables you to retrieve installment options for a specific transaction amount and payment method. This allows customers to see all available installment plans before completing a purchase.

​
Class: Consulta

Namespace: Akatus.ConsultaParcelamento

​
Methods

​
consultaParcelamento()

Queries installment options for a given amount and payment method. Signature: 
public Akatus.ConsultaParcelamento.Retorno consultaParcelamento(
    decimal amount, 
    Akatus.Enums.MeioDePagamento payment_method
)
​
amount
decimal
required
The transaction amount to calculate installments for
​
payment_method
MeioDePagamento
required
The payment method enum value (e.g., cartao_visa, cartao_master, boleto)
Returns: Retorno - Object containing installment options and details Throws:
  • System.ArgumentException - When the XML response is invalid or contains no installment nodes

​
consultaParcelamento() with Cache

Queries installment options with caching support to improve performance. Signature: 
public Akatus.ConsultaParcelamento.Retorno consultaParcelamento(
    decimal amount,
    Akatus.Enums.MeioDePagamento payment_method,
    DateTime dataExpiracaoEmCache,
    out bool retornouDoCache
)
​
amount
decimal
required
The transaction amount to calculate installments for
​
payment_method
MeioDePagamento
required
The payment method enum value
​
dataExpiracaoEmCache
DateTime
required
Cache expiration date/time
​
retornouDoCache
bool
required
Output parameter indicating if the result was retrieved from cache

​
Response Structure

​
Retorno Class

Contains the installment query response.
​
Descricao
string
required
Description of the installment plan (includes interest rate percentage)
​
ParcelasAssumidas
int
required
Number of installments with fees assumed by the merchant
​
Parcelas
List<RetornoParcela>
required
List of available installment options

​
RetornoParcela Class

Represents a single installment option.
​
Quantidade
int
required
Number of installments
​
Valor
decimal
required
Value of each individual installment
​
Total
decimal
required
Total amount to be paid (including any interest)

​
MeioDePagamento Enum

Common payment method values:
  • cartao_visa - Visa credit card
  • cartao_master - MasterCard credit card
  • cartao_amex - American Express credit card
  • cartao_diners - Diners Club credit card
  • cartao_elo - Elo credit card
  • boleto - Bank slip (boleto bancário)

​
Usage Example

using Akatus.ConsultaParcelamento;
using Akatus.Enums;

// Create consultation instance
Consulta consulta = new Consulta();

// Query installment options for 10.39 BRL with Visa
Retorno retorno = consulta.consultaParcelamento(
    10.39m, 
    MeioDePagamento.cartao_visa
);

// Display installment information
Console.WriteLine($"Description: {retorno.Descricao}");
Console.WriteLine($"Merchant-assumed installments: {retorno.ParcelasAssumidas}");

// Iterate through installment options
foreach (var parcela in retorno.Parcelas)
{
    Console.WriteLine($"{parcela.Quantidade}x of R$ {parcela.Valor:F2} = R$ {parcela.Total:F2}");
}

​
Example with Cache

using Akatus.ConsultaParcelamento;
using Akatus.Enums;

Consulta consulta = new Consulta();

// Set cache expiration to 1 hour from now
DateTime cacheExpiration = DateTime.Now.AddHours(1);
bool fromCache;

// Query with caching
Retorno retorno = consulta.consultaParcelamento(
    100.00m,
    MeioDePagamento.cartao_master,
    cacheExpiration,
    out fromCache
);

if (fromCache)
{
    Console.WriteLine("Result retrieved from cache");
}
else
{
    Console.WriteLine("Result retrieved from API");
}

​
Configuration Requirements

Before using this API, ensure your Web.config contains the required Akatus configuration: 
<appSettings>
  <!-- Akatus - Environment ('producao' or 'testes') -->
  <add key="AkatusAmbiente" value="testes"/>
  
  <!-- Akatus - API Key -->
  <add key="AkatusApiKey" value="YOUR-API-KEY"/>
  
  <!-- Akatus - Account Email -->
  <add key="AkatusEmail" value="[email protected]"/>
</appSettings>

​
API Endpoints

  • Production: http://www.akatus.com/api/v1/parcelamento/simulacao.xml
  • Testing: http://dev.akatus.com/api/v1/parcelamento/simulacao.xml
The SDK automatically constructs the full URL with query parameters based on your configuration and method arguments.

Build docs developers (and LLMs) love

Get started for freeTalk to us