Realizar um pedido de benefício
A integração via API é uma das soluções que a Flash oferece para que as empresas possam conectar-se à nossa plataforma e disponibilizar benefícios aos seus colaboradores de forma eficiente.
Premissas para realizar um pedido de benefícios via API
- Configuração dos benefícios
- Os benefícios devem estar previamente configurados no cadastro da empresa. Essa configuração não pode ser realizada via API. Entre em contato conosco para que essa configuração esteja disponível
- Cadastro de Colaboradores
- Os colaboradores precisam estar cadastrados antes de fazer um pedido de benefícios. Utilize a API Cadastro de colaboradores para realizar este processo.
Os pedidos de benefícios podem ser direcionados tanto para o cartão Flash quanto para um produto virtual. O pagamento de um pedido pode ser realizado via boleto ou utilizando o saldo Flash Cash (débito imediato).
O fluxo de utilização da API de pedidos deve seguir a ordem abaixo, que será detalhada nas próximas seções:
- Criação de um Pedido
- Inclusão de Depósitos ao Pedido
- Confirmação do Pedido
Criação de um Pedido
O objetivo desta etapa é iniciar o processo de solicitação de benefícios. Nesta fase, é criado um identificador de pedido vinculado a um companyId e adminId. Esse identificador será utilizado nas etapas subsequentes.
Inclusão de Depósitos ao Pedido
Nesta etapa, todos os depósitos desejados devem ser adicionados ao pedido criado anteriormente. Para isso, é necessário identificar o pedido, o colaborador, o benefício e o valor a ser creditado. Esta etapa pode ser repetida quantas vezes forem necessárias até que todos os colaboradores e seus respectivos valores de depósito de benefício estejam incluídos no pedido.
Confirmação do Pedido
A terceira e última etapa é a confirmação do pedido. Nesta fase, você deve informar o meio de pagamento utilizado para concluir o pedido e fornecer outros detalhes relevantes para finalizar o processo.