Skip to main content

​
Overview

The Akatus.ConsultaMeiosPagamento.Consulta class allows you to retrieve all payment methods (bandeiras) that are enabled for your Akatus account. This includes credit card brands and their respective installment options.

​
Class: Consulta

Namespace: Akatus.ConsultaMeiosPagamento

​
Methods

​
consultaMeiosDePagamentoDisponiveis()

Retrieves all available payment methods configured for your Akatus account. Signature: 
public List<Akatus.ConsultaMeiosPagamento.Retorno> consultaMeiosDePagamentoDisponiveis()
Returns: List<Retorno> - A list of available payment methods Throws:
  • System.ArgumentException - When the XML response is invalid or contains no payment method nodes

​
Response Structure

​
Retorno Class

Represents an available payment method (bandeira).
​
Codigo
string
required
The payment method code (key identifier)
​
Descricao
string
required
The payment method description (e.g., “Visa”, “MasterCard”)
​
Parcelas
int
required
Maximum number of installments available for this payment method

​
Usage Example

using Akatus.ConsultaMeiosPagamento;

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

// Query available payment methods
List<Retorno> retorno = consulta.consultaMeiosDePagamentoDisponiveis();

// Iterate through available payment methods
foreach (var meioPagamento in retorno)
{
    Console.WriteLine($"Code: {meioPagamento.Codigo}");
    Console.WriteLine($"Description: {meioPagamento.Descricao}");
    Console.WriteLine($"Max Installments: {meioPagamento.Parcelas}");
}

​
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: https://www.akatus.com/api/v1/meios-de-pagamento.xml
  • Testing: https://dev.akatus.com/api/v1/meios-de-pagamento.xml
The SDK automatically selects the appropriate endpoint based on your AkatusAmbiente configuration.

Build docs developers (and LLMs) love

Get started for freeTalk to us