Serviços

Account

Nome	Descrição
Login	Valida um nome de usuário e uma senha para autenticação da conta de acesso.
RememberPassword	Solicita o lembrete de senha. Ao solicitar o lembrete, será enviada um e-mail contendo a senha no corpo do e-mail. A conta de acesso existente será localizada pelo e-mail informado.
Create	Cria uma nova conta de acesso.
EditCadaster	Altera o cadastro de uma conta de acesso existente.
EditEmail	Altera o e-mail de uma conta de acesso existente.
EditPassword	Altera a senha de autenticação de uma conta de acesso existente.
LoadCards	Retorna os cartões vinculados a conta do usuário.
RemoveCard	Remove o cartão da conta do usuário.
GenerateToken	Gera um token para autenticação integrada que pode ser utilizado na Loja Web e Portal. O token gerado deve ser passado por QueryString para a página de autenticação dos produtos da seguinte forma: Loja Web https://[endereco_loja]?token=[token_gerado] Portal https://[endereco_portal]/login.aspx?token=[token_gerado]
RemoveAccount	Remove/bloqueia a conta do usuário.
RefreshUser	Remove/bloqueia a conta do usuário.

Consumption

Nome	Descrição
Connect	Testa a conectividade com o serviço.
AddAccount	Adiciona uma nova conta de consumo para ser monitorada em uma conta de acesso. As contas de consumos criadas a partir dos ingressos adquiridos pela loja do cliente através da conta de acesso serão automaticamente vinculadas. O campo NfcUid é obrigatório, caso o código da conta de consumo informado esteja criptografado O campo NfcUid é opcional, caso o código da conta de consumo informado não esteja criptografado
RemoveAccount	Remove uma ou mais contas de consumo do monitoramento de uma conta de acesso. As contas de consumos criadas a partir dos ingressos adquiridos pela loja do cliente através da conta de acesso não poderão ser removidos.
Refresh	Recebe as atualizações das contas de consumo monitoradas por uma conta de acesso, recebendo: 1. Saldo das contas de consumo monitoradas por uma conta de acesso. 2. As configurações atualizadas que orientam as ações que devem ser realizadas pelo aplicativo. Tais configurações podem ser alteradas a qualquer momento e o aplicativo deve ser preparado para mudanças a cada chamada. Contas de consumo não retornadas devem ser removidas da visualização do usuário. Esta situação ocorre quando a conta de consumo for removida da conta de acesso através de outro aparelho logado.
LoadMovements	Consulta os movimentos de consumo dos últimos 30 dias de uma conta de consumo. O saldo dos movimentos anteriores a 30 dias são retornados como saldo anterior.
LoadPayment	Carrega os dados necessários o pagamento de pós-pago ou recarga de pré-pago nas contas de consumo monitoradas por uma conta de acesso. Além disso, esse método recebe eventuais atualizações realizadas nas contas de consumo. Este comportamento tem objetivo de evitar nova consulta ao servidor caso tenha havido atualizações e garantir que a função de pagamento seja sempre ativada com as contas de consumo atualizadas.
LoadAcquirerAuthentication	Carrega os parâmetros necessários para compor os dados que serão utilizados no processo de autenticação do SDK (https://developercielo.github.io/manual/3ds) O processo de autenticação deverá ser implementado de acordo com a documentação da adquirente Cielo, seja para plataforma Android, IOS ou JavaScript. Android: https://developercielo.github.io/manual/integracao-sdk-android IOS: https://developercielo.github.io/manual/integracao-sdk-ios JavaScript: https://developercielo.github.io/manual/integracao-javascript Fluxo resumido: 1) Realizar chamada ao método LoadAcquirerAuthentication da API antes da efetivação do pagamento, depois de todas as informações do cartão/pagamento terem sido capturadas. 2) Realizar o processo de autenticação do SDK utilizando os parâmetros retornados no método LoadAcquirerAuthentication, juntamente com os parâmetros existentes na própria aplicação, dados do cartão, valores, etc... 3) Usuário poderá interagir (gerenciado pelo SDK) com o popup do desafio (onde algumas informações serão requeridas/confirmadas) 4) Independente do resultado da autenticação no SDK, recomendamos realizar chamada aos métodos de pagamento (PerformPayment/PerformRecharge) passando todas as informações do resultado da autenticação (através do campo AcquirerAuthenticationData) juntamente com o restante das informações de pagamento. 5) A decisão do processamento do pagamento (processar ou descartar, de acordo com o resultado da autenticação) será guiado pela configuração 'Autenticação 3DS' nas configurações da API no MultiClubes. Para ter acesso ao aplicativo de exemplo da implementação SDK Android, clique aqui.
PerformPayment	Paga um saldo negativo de uma conta de consumo pós-paga. Caso a transação de cartão de crédito seja aprovada pela adquirente, o pagamento é realizado e as atualizações serão retornadas. Dentre as atualizações haverá o movimento de consumo de pagamento. Caso a transação de cartão de crédito seja negada pela adquirente, o pagamento não será realizado e será retornada mensagem de erro contendo o motivo que deve ser exibido para o usuário.
PerformRecharge	Recarrega um valor em uma conta de consumo pré-paga. Caso a transação de cartão de crédito seja aprovada pela adquirente, a inclusão do valor como recarga é realizado e as atualizações serão retornadas. Dentre as atualizações haverá o movimento de consumo de recarga. Caso a transação de cartão de crédito seja negada pela adquirente, a inclusão do valor não será realizada e será retornada mensagem de erro contendo o motivo que deve ser exibido para o usuário.
LoadLimit	Carrega os dados necessários para a alteração de limite crédito em contas de consumo pós-pagas. O limite máximo de crédito pode ser distribuído entre todas as contas de consumo com limite de crédito, incluindo contas com limite nulos ou zerado. Contas de consumo não retornadas por este método não podem ter seu limite de crédito alterado.
EditLimit	Altera o limite de crédito em contas de consumo pós-pagas. Retorna as atualizações acumuladas incluindo a alteração de limite realizada. Somente contas de consumo retornadas por Consumption.LoadLimit podem ter seus limites de créditos alterados.
Transfer	Transfere saldo para contas de consumo. Retorna os números de movimentos e a atualização de saldo.
ReverseTransfer	Reverte a transferência de saldo para contas de consumo.
LoadVouchers	Carrega os dados dos vouchers de uma conta.

Disciplines

Nome	Descrição
GetAvailabilities	Consulta sócios e as turmas disponíveis para matrícula para um título.
GetRegisters	Consulta os sócios de um título e suas respectivas matrículas.
Register	Efetua a matrícula de um sócio.
GetContract	Emite o contrato de matrícula ou cancelamento de matrícula de um sócio
Queue	Inserir sócio na fila de espera de uma turma.
Unregister	Desmatricula um sócio de uma turma.
Unqueue	Retira o sócio da fila de espera de uma turma.
GetParcels	Retorna os valores por parcela

Parking

Nome	Descrição
Load	Retorna os pagamento de estacionamento realizadas e o valor a ser pago em novos pagamentos.
PerformPayment	Realiza o pagamento de estacionamento.

Title

Nome	Descrição
GetMembers	Consulta todos os sócios para o título informado.
GetMemberPhoto	Consulta foto de um sócio
GetDuns	Consulta todas as cobranças do título para o ano informado
GetDunsYears	Consulta os anos que o título possui cobrança
PayDuns	Realiza pagamento para todas as cobranças informadas.
GetMemberCard	Retorna as imagens das carteirinhas digitais.

Invitations

Nome	Descrição
GetInvitations	Consulta os convites disponíveis.
GetMapLocations	Consulta os locais disponíveis de um mapa para uma determinada data.
GetAvailableQuantity	Consulta a quantidade disponível do convite para uma determinada data.
GetSales	Consulta convites comprados, com seus detalhes e código.
Sell	Realiza vendas de convites.
CancelSale	Cancela uma venda de convite efetuada.
GetInvitationPrint	Imprime convites comprados.
GetParcels	Retorna as parcelas possíveis para venda

Support

Nome	Descrição
Send	Realiza atendimento através de envio de e-mail para o clube.

RewardPoints

Nome	Descrição
Load	Consulta os dados de acesso para do clube de vantagens.