Show / Hide Table of Contents

    Title

    Serviço responsável pela visualização de sócios e cobranças de um título

    Apenas contas de acesso que possuem um título poderão utilizar estes serviços.

    GetMembers

    Consulta todos os sócios para o título informado.

    Parâmetros

    Nome Tipo Descrição
    data MemberData Dados para identificação do título. Obrigatório.

    Retorno

    Tipo Descrição
    MemberResult[] Se informado conta de acesso e título válidos, retorna os dados dos sócios do título. Senão dispara erro.

    GetMemberPhoto

    Consulta foto de um sócio

    Parâmetros

    Nome Tipo Descrição
    data MemberPhotoData Dados para identificação do sócio. Obrigatório.

    Retorno

    Tipo Descrição
    MemberPhotoResult Retorna a foto do sócio, em seu tamanho original.
            É possivel informar um tamanho, caso queira redimensionar foto (Tamanho máximo 3000).
            Se for informado a última data de atualização, e a foto do sócio possuir mesma data, foto não será retornada para reduzir consumo de dados. |
    

    GetDuns

    Consulta todas as cobranças do título para o ano informado

    Parâmetros

    Nome Tipo Descrição
    data DunData Dados para identificação das cobranças. Obrigatório.

    Retorno

    Tipo Descrição
    DunResult[] Retorna todas as cobranças do título para o ano informado.

    GetDunsYears

    Consulta os anos que o título possui cobrança

    Parâmetros

    Nome Tipo Descrição
    data MemberData Dados para identificação do título. Obrigatório.

    Retorno

    Tipo Descrição
    Int32[] Retorna todos os anos no qual o título possue cobranças

    PayDuns

    Realiza pagamento para todas as cobranças informadas.

    Parâmetros

    Nome Tipo Descrição
    data PerformPaymentData Dados para pagamento de cobranças. Obrigatório.

    Retorno

    Tipo Descrição
    PaymentResult Retorna status da tentativa de pagamento. Senão dispara erro.

    GetMemberCard

    Retorna as imagens das carteirinhas digitais.

    Parâmetros

    Nome Tipo Descrição
    data MemberCardData Dados para identificação do título. Obrigatório.

    Retorno

    Tipo Descrição
    MemberCardResult Se informado conta de acesso e título válidos, retorna as imagens das carteirinhas. Senão dispara erro.

    Error codes

    Códigos de erro retornados pelo serviço

    Valores

    Nome Valor Descrição
    InvalidTitle 0 Título inválido.
    MemberNotFound 1 Sócio não encontrado.
    PhotoWidthResizeOverMaximum 2 Redimensionamento de largura de foto acima do limite máximo. Tamanho máximo 3000.
    PhotoHeightResizeOverMaximum 3 Redimensionamento de altura de foto acima do limite máximo. Tamanho máximo 3000.
    DunsNotFound 4 Redimensionamento de altura de foto acima do limite máximo. Tamanho máximo 3000.
    DunAlreadyPaid 5 Cobrança informada já foi paga.
    CloudCancelProcessingError 6 Erro no cancelamento de cobranças de assinatura recorrente.
    OfflineCloud 7 Nuvem offline.
    InvalidPaymentValue 8 Valor de pagamento inválido.
    ActiveMembersNotFound 9 Nenhum sócio ativo encontrado.
    TemplateNotFound 10 Um template ainda não foi gerado para o modelo de carteirinha
    AuthenticationKeyMissing 901 Chave de autenticação não informada.
    AuthenticationKeyInvalid 902 Fornecido como parâmetro uma chave de autenticação inválida. Este erro ocorre quando, a chave não é encontrada, quando a chave informada está incorreta ou quando o usuário associado a chave não possui permissão para utilizar a API.
    IntegrationDisabled 903 A integração com o aplicativo está desativada. Este erro ocorre devido a configuração na administração do servidor.
    IntegratedUserInvalid 904 Usuário de integração inválido.
    AuthenticationKeyUserMismatch 905 O nome de usuário de integração no MultiVendas não é igual ao nome de usuário da chave no MultiClubes.
    Back to top Um produto MultiClubes