API Reference

Criar Usuário

Ao criar um novo usuário na API, é essencial definir corretamente o tipo de usuário. Atualmente, existem dois tipos principais:

TIPO DE USUARIOINFORMAÇÃO
USUARIOUsuários do tipo USUARIO possuem acesso ao portal e podem ser utilizados para tarefas operacionais e de gestão, como: Portais dos lojistas, Ambientes administrativos,Outras interfaces visuais da plataforma.
APLICACAOUsuários do tipo APLICACAO não têm acesso ao portal do lojista, sendo restritos a chamadas de API e autenticação de dispositivos (Maquinas de Cartão).

Cada usuário criado pode possuir um conjunto de permissões, que determinam quais funcionalidades estarão disponíveis para ele — seja no Portal do Lojista ou nas Maquininhas (POS).

As permissões devem ser atribuídas de acordo com o tipo de usuário e o contexto de uso:

PERMISSÃOATRIBUIÇÃO
ADM_USUARIOQuando a opção é definida como ativa, ela recebe a capacidade de criar outros usuários e gerenciar suas permissões.
ADM_COBRANCAPermite criar cobranças, gerenciar todos os aspectos relacionados a uma cobrança
CANCELAR_COBRANCAPermissão necessária para cancelar uma cobrança. Se desativada, o usuário não poderá cancelar cobranças.
ADM_EMPRESAPermite criar empresas, editar dados de empresas ainda não aprovadas, e realizar ajustes quando necessário.
ADM_CLIENTEPermite gerenciar o cadastro de clientes, incluindo a edição de dados pessoais e comerciais.
ADM_SERVICOPermite criar e editar serviços, bem como modificar os dados associados a cada serviço.
REFORCO_CAIXAPermissão voltada para maquininhas. Habilita o usuário a registrar reforços de caixa (entrada de valores).
FECHAMENTO_CAIXAPermite ao usuário realizar o fechamento do caixa da loja. Também aplicável para uso em maquininhas.
EXTRATO_CONTAPermite consultar o saldo e o extrato bancário das empresas com as quais o usuário possui vínculo.
EMISSAO_NFSPermite emitir Nota Fiscal de Serviço (NFS-e) durante a criação de uma cobrança. Se desativada, a nota não poderá ser emitida nesse momento.
CANCELAR_TRANSACAOPermite ao usuário cancelar (estornar) transações das empresas com as quais está vinculado.
ADM_PLANOPermite criar, editar e gerenciar os planos comerciais das empresas, incluindo alterações de dados.
ALTERAR_VALOR_ITEMAutoriza a alteração do valor de um item no momento da criação da cobrança (ex: mudar um item de R$10,00 para R$20,00).
RECEBER_BOLETOPermite selecionar boleto bancário como forma de pagamento.
RECEBER_CREDITOPermite selecionar cartão de crédito como forma de pagamento.
RECEBER_DEBITOPermite selecionar cartão de débito como forma de pagamento.
RECEBER_DINHEIROPermite selecionar pagamento em dinheiro.
RECEBER_PIXPermite selecionar PIX como forma de pagamento.
CANCELAR_NFSPermite cancelar uma NFS-e já emitida, caso seja necessário e a permissão esteja ativa.
ADM_SPLITPermite gerenciar os splits de pagamento no momento da criação de uma cobrança.
ABERTURA_CAIXAPermite ao usuário realizar a abertura de caixa no início de uma operação.
SANGRIA_CAIXAAutoriza o usuário a fazer uma sangria, ou seja, retirada de valores do caixa.
FLASH_CAIXAPermite gerar um relatório instantâneo (flash) com as movimentações do caixa até o momento atual.
MAX_DESCONTODefine o desconto máximo que o usuário pode aplicar em uma venda realizada na maquininha.

🚧

Atenção :

Lembrando que é obrigatório informar pelo menos uma empresa que esteja vinculada ao usuário.

{
    "nome": "String",
    "tipo": "USUARIO",
    "status": "ATIVO",
    "email": "String",
    "telefone": "String",
    "cpf":"String",
     "marketplace": {
        "id": "String"
    },
    "empresas": [
        {
            "id": "String",
        }
    ],
    "permissoes": {
    "adm_usuario" : boolean,
    "adm_cobranca" : boolean,
    "cancelar_cobranca" : boolean,
    "adm_empresa" : boolean,
    "adm_cliente" : boolean,
    "adm_servico" : boolean,
    "reforco_caixa" : boolean,
    "fechamento_caixa" : boolean,
    "extrato_conta" : boolean,
    "emissao_nfs" : boolean,
    "cancelar_transacao" : boolean,
    "adm_plano" : boolean,
    "alterar_valor_item" : boolean,
    "receber_boleto" : boolean,
    "receber_credito" : boolean,
    "receber_debito" : boolean,
    "receber_dinheiro" : boolean,
    "receber_pix" : boolean,
    "cancelar_nfs" : boolean,
    "adm_split" : boolean,
    "abertura_caixa" : boolean,
    "sangria_caixa" : boolean,
    "flash_caixa" : boolean
  },
  "max_desconto" : int,
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!