Manual+backoffice
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
MANUAL DE UTILIZADOR
DO BACKOFFICE
Índice
Introdução---------------------------------------------------------------------------------------------------- 4
Lista de Versões---------------------------------------------------------------------------------------------- 4
Alteração de dados de perfil-------------------------------------------------------------------------------- 5
Onboarding--------------------------------------------------------------------------------------------------- 6
Benefíciário------------------------------------------------------------------------------------------- 6
Processo de onboarding------------------------------------------------------------------------------- 6
Informações Gerais------------------------------------------------------------------------------------------ 7
Referências Multibanco-------------------------------------------------------------------------------7
Entidade: 10611----------------------------------------------------------------------------------------- 7
Entidade 11683 ---------------------------------------------------------------------------------------- 8
Entidade 21098---------------------------------------------------------------------------------------- 8
Entidade 10111------------------------------------------------------------------------------------------ 8
Entidade 59126---------------------------------------------------------------------------------------- 8
1. Menu Beneficiário------------------------------------------------------------------------------------------ 9
2. Menu Mensagens------------------------------------------------------------------------------------------ 10
3. Menu Gestão Referências Easyref----------------------------------------------------------------------- 10
3.1 Pagas----------------------------------------------------------------------------------------------10
3.2 Transferidas-------------------------------------------------------------------------------------- 11
3.3 Facturadas---------------------------------------------------------------------------------------12
3.4 Lista de Transferências---------------------------------------------------------------------------12
3.5 Impressão de facturas---------------------------------------------------------------------------13
3.6 Download ficheiros lote--------------------------------------------------------------------------13
3.7 Arquivo 5 anos------------------------------------------------------------------------------------14
4. Menu Referências Multibanco---------------------------------------------------------------------------- 16
4.1 Nova Referência-----------------------------------------------------------------------------------16
4.2 Nova Referência MOTO Off-Line-----------------------------------------------------------------18
4.3 Listagem Referências--------------------------------------------------------------------------- 20
5. Menu Débitos Diretos------------------------------------------------------------------------------------- 21
5.1 Débitos Enviados ao Banco-----------------------------------------------------------------------21
5.2 Estado ADC------------------------------------------------------------------------------------- 22
5.3 Revogações------------------------------------------------------------------------------------- 22
5.4 Resumo cobranças------------------------------------------------------------------------------ 23
5.5 Lista Débitos Cobrados------------------------------------------------------------------------- 25
5.6 Lista Débitos NÃO Cobrados-------------------------------------------------------------------- 26
6. Menu Cartão de Crédito-----------------------------------------------------------------------------------27
6.1 Autorizações------------------------------------------------------------------------------------ 27
6.2 Pedir Pagamento-------------------------------------------------------------------------------- 28
6.3 Cancelar e Devolver----------------------------------------------------------------------------- 29
6.4 Países-------------------------------------------------------------------------------------------- 30
7. Menu MBWay----------------------------------------------------------------------------------------------- 31
7.1 Criar Autorização ou Compra---------------------------------------------------------------------31
7.2 Listar--------------------------------------------------------------------------------------------- 32
7.2.1 Autorizações e compras-------------------------------------------------------------------------32
7.2.2 Erros--------------------------------------------------------------------------------------------33
8.1 Nova Referência---------------------------------------------------------------------------------- 33
8.2 Estado das autorizações------------------------------------------------------------------------ 36
8.3 Estado dos pedidos----------------------------------------------------------------------------- 37
8.4 Resumo----------------------------------------------------------------------------------------- 38
8.5 Listagens RP------------------------------------------------------------------------------------ 38
8.6 Listagens Swift---------------------------------------------------------------------------------- 39
8.7 Datas SEPA-------------------------------------------------------------------------------------- 40
8.8 Remover com ficheiro--------------------------------------------------------------------------- 40
9. Menu Pagamentos Frequentes--------------------------------------------------------------------------- 41
9.1 Novo Token----------------------------------------------------------------------------------------41
9.2 Lista Tokens--------------------------------------------------------------------------------------41
10. Menu Inscrições------------------------------------------------------------------------------------------42
10.1 Listagem Principal------------------------------------------------------------------------------ 42
10.2 Pagos------------------------------------------------------------------------------------------- 43
10.3 Pendentes-------------------------------------------------------------------------------------- 44
10.4 Resumo Anual---------------------------------------------------------------------------------- 45
11. Menu Web Services---------------------------------------------------------------------------------------45
11.1 Configuração URL------------------------------------------------------------------------------- 45
11.2 Configuração Email----------------------------------------------------------------------------- 46
11.3 Configuração IP--------------------------------------------------------------------------------- 46
11.4 Configuração Código---------------------------------------------------------------------------- 47
11.5 Status API--------------------------------------------------------------------------------------- 47
11.6 Notificações------------------------------------------------------------------------------------- 47
11.7 Renotificar--------------------------------------------------------------------------------------- 48
11. 8 Configurações API 2.0 ------------------------------------------------------------------------ 48
11. 9 Sandbox Easypay------------------------------------------------------------------------------- 49
12. Menu Quick Easypay-------------------------------------------------------------------------------------49
13. Menu Formulários Easypay------------------------------------------------------------------------------49
14. Menu Upload 2 APIs--------------------------------------------------------------------------------------49
15. Menu Equipas---------------------------------------------------------------------------------------------49
15.1 Listar-------------------------------------------------------------------------------------------- 50
15. 2 Criar-------------------------------------------------------------------------------------------- 50
16. Menu Utilizadores---------------------------------------------------------------------------------------- 51
16.1 Listar---------------------------------------------------------------------------------------------51
16. 2 Criar---------------------------------------------------------------------------------------------51
Introdução
Este manual descreve os procedimentos necessários à correta utilização do Backoffice da easypay.
Lista de Versões
Versão Data Alterações Elaborado por Aprovado por
1.0 28/01/2019 Equipa comercial Inês Rodrigues
4
Alteração de dados de perfil
Pode mudar as definições do seu perfil acedendo a “Meu Perfil” clicando no canto superior direito onde
está localizado o nome do Beneficiário.
clique aqui
Aqui estão disponíveis as seguintes configurações:
Tabelas de dados:
• Reset definições
• Exportar com cabeçalhos
• Formato de moeda
• Alertas bloqueantes
Meu perfil:
• Nome
• Idioma de backoffice
• Senha
• Aceito receber ofertas promocionais
Membro de:
• Informa sobre a distribuição de usuários associados ao perfil
5
Onboarding
Benefíciário
Processo de onboarding
O processo de onboarding é constituído por 5 partes que deverão ser preenchidas na totalidade para poder
usufruir de imediato dos serviços easypay:
1. Preenchimento das informações gerais
2. Informação sobre os representantes legais
3. Informação bancária
4. Modelo de negócio
5. Envio de documentação comprovativa da informação fornecida
clique aqui
Após submeter os seus dados
Após submissão de toda a informação, poderá de imediato dar início à utilização dos serviços
easypay. Esta informação irá ser conferida pela equipa easypay no prazo máximo de 48h e
no caso de ser validada, irão redigir e enviar-lhe uma Proposta de Adesão que irá refletir, não
só os dados por si fornecidos, mas também preçários e as condições de utilização do serviço
easypay. A partir do momento em que o original, devidamente assinado, da proposta, chegar
aos nossos escritórios e for validado pelo nosso Departamento de Compliance, todos os
fundos existentes nas contas de pagamento easypay poderão ser transferidos para as contas
bancárias indicadas pelo cliente.
Depois de lhe serem facultados os seus Dados de Acesso ao seu Back Office e completar o
Onboarding (Registo / Criação de Conta de Pagamentos easypay), no Menu “Beneficiário”,
encontrará informação útil para a integração dos nossos Web Services no seu sistema ou
plataforma.
6
Informações Gerais
Referências Multibanco
As referências Multibanco são, actualmente, o meio de pagamento mais utilizado para quem tem conta
bancária portuguesa que permitem o processamento imediato do pagamento e envio do respetivo
comprovativo à entidade comercial relevante.
Uma das vantagens da referência Multibanco é não ser necessário o envio de comprovativo de pagamento
uma vez que a empresa emissora sabe, independentemente do seu fornecedor de pagamento, que a referida
referência é paga.
Cada referência Multibanco é constituída por 3 campos:
• Entidade
• Referência
• Montante
Existem várias tipologias de referências Multibanco e poderá escolher o tipo de referência que vai ao
encontro das especificações do seu negócio.
Numa primeira diferenciação poderá escolher se pretende definir a priori o valor a pagar pela referência,
distinguindo portanto as referências “check-digit”, com o valor fechado, e as referências por ficheiro, em
que o cliente poderá pagar o valor que quiser, as vezes que quiser.
Numa segunda diferenciação poderá definir ou não, um prazo de validade para que essa referência esteja
passível de ser paga. Caso pretenda definir o valor da referência à priori e a mesma possa ser paga as vezes
que entender sem limite temporal, estamos a falar das referências associadas à entidade 10611. Por outro
lado se pretende manter o valor fechado mas quer limitar o intervalo em que a referência pode ser paga,
definindo um prazo de validade, estamos perante referências da entidade 11683. Por último, as referências
por ficheiro permitem associar, por exemplo, uma referência a um cliente final que poderá pagar as vezes e
o valor que entender.
Se o Beneficiário oferecer artigos de diferentes valores ou quiser cobrar uma Subscrição de valor variável
ao longo do tempo e sem uma periodicidade definida, a Entidade 21098 será a mais indicada.
Entidade: 10611
As referências de pagamento criadas com esta Entidade:
• têm um valor fixo (check digit);
• não tem limite de validade;
• podem ser utilizadas múltiplas vezes;
A Entidade 10611 é prática para a reconciliação bancária no sentido em que permite ao Beneficiário associar
uma Referência de pagamento MB / CC / DD ao cliente a que se destina.
É possível parametrizar dados do cliente tais como “Nome”, “Telemóvel” e “Email”, não sendo no entanto
obrigatórios para a criação da referência.
Assim, sempre que essa referência for paga, o Beneficiário sabe que se trata de um pagamento em nome
de um determinado cliente.
Dada a sua validade infinita, esta referência poderá ser paga por qualquer pessoa através de uma caixa
automática MB ou do Home Banking. Os fundos desse pagamento serão sempre destinados ao Beneficiário
que pediu a sua criação.
7
Entidade 11683
Estas entidades, também referidas como entidades “check digit + validade” bloqueiam o valor atribuído a
uma referência (valor fixo ao longo do tempo) e tem data de validade. Depois da data de validade configurada,
a referência já não pode ser usada para pagar ao Beneficiário. Porém, durante a sua validade (72 horas, por
exemplo), os compradores poderão pagar várias vezes esse valor durante essas 72 horas.
Note-se que as referências de pagamento da easypay são construídas sobre a base de referências Multibanco.
As referências Multibanco expiram à meia noite (24h00) do dia / data de validade.
Entidade 21098
Esta Entidade, também referida como “Entidade por Ficheiro” permite o pagamento de qualquer valor a
qualquer altura. Não existe periodicidade obrigatória embora seja possível parametrizar uma periodicidade,
valor mínimo e valor máximo se o Beneficiário assim o desejar.
Estas Entidades são recomendadas para Pagamentos Frequentes e também Pagamentos Recorrentes.
Entidade 10111
É uma entidade de testes, apenas para SANDBOX, que tem um comportamento semelhante à Entidade
10611 (check digit)
Entidade 59126
Nova Entidade disponibilizada pela easypay, apenas disponível nas APIs 2.0.
As APIs 2.0 vieram simplificar o processo de pedido de pagamento e posterior notificação do estado e
finalmente conclusão do mesmo.
8
1. Menu Beneficiário
Indica os dados de conta do Beneficiário. Na tabela são apresentados os dados das contas de pagamento
abertas pelo Beneficiário.
listagem
Listagem
Conta de pagamentos - Nº da conta de pagamentos ou CIN
País - País em que está registado o Beneficiário
Entidade - Entidade disponibilizada
Qtd referências - Se=1 indica que são disponibilizadas referências ilimitadas, se <>1 são disponibilizadas o
número de referências indicadas
Primeira - Primeira referência disponível no CIN
Última - Número da última referência disponibilizada. Se igual à primeira, indica que as referências
disponibilizadas são infinitas
Início - Data de abertura de conta
Transferência - Periodicidade com que a transferência para o IBAN indicado é ordenada
IBAN - Número da conta bancária indicado para receção dos fundos a transferir da conta de pagamentos
Alerta - se “api_get”, indica que as notificações são enviadas conforme as configurações de URL definidas
no webservices e para o email configurado também no webservices. Se “email”, indica que as notificações
apenas não enviadas para o email configurado no webservices.
Visa/AMEX/DD - Campos para utilização da easypay, sem relevância para o Beneficiário.
Filtros
Este menu permite a pesquisa por filtros. Para o fazer siga os 4 passos:
Clicar no botão “Filtros”.
Selecionar as categorias que se pretende pesquisar.
Clicar no botão “Submeter”.
Clicar no botão “Aplicar”.
9
2. Menu Mensagens
Local onde são disponibilizados para download os ficheiros exportados em outras áreas do Backoffice,
entre outros tipos de mensagens, tais como a aprovação ou reprovação da documentação enviada durante
o processo de Onboarding, ou ainda o resultado de um pedido de pagamento relativo a uma autorização de
cartão de crédito.
3. Menu Gestão Referências Easyref
Este é um menu de consulta onde pode aceder à informação relativa ao histórico de pagamentos e
transferências.
3.1 Pagas
Nesta tabela são apresentadas as referências pagas que se encontram por transferir para a conta bancária
do Beneficiário desde o último Lote transferido. A partir do momento em que o valor das referências for
transferido para a conta bancária do Beneficiário, essas referências deixam de aparecer no Menu “Pagas”,
passando a constar no Menu “Transferidas” e no “Arquivo 5 anos” . As funcionalidades destes menus estão
descritas mais adiante neste manual.
Este sub-menu permite:
A. Agrupar por: “Conta de Pagamentos” ou “Data”;
B. Filtar:
Clicar no botão “Filtros”.
Selecionar as categorias que se pretende pesquisar.
Clicar no botão “Submeter”.
Inserir palavra-chave ou manter em branco
Clicar no botão “Aplicar”.
C. Exportar dados para ficheiro ao clicar no botão “Exportar Resultados”.
10
Listagem:
Data - Data em que o Cliente efetuou o pagamento
Semana - Semana em que o Cliente efetuou o pagamento
Referência - Referência do pagamento listado
Canal - Meio de pagamento utilizado (MB/CC/BB/MBW/DD)
Obs - Informação adicional sobre o pagamento introduzida aquando da geração dos dados para pagamento
Chave - Identificador único do pagamento. Pode ser introduzida manualmente ou é gerada automaticamente
quando o pagamento é gerado via webservices
Valor pago - Valor pago pelo Cliente
Valor transferir - Valor total a transferir pela easypay, deduzido da respetiva comissão quando aplicável
Data transferência - Data em que a easypay faz a transferência dos fundos para o IBAN indicado
Conta de pagamentos - Número da conta de pagamentos onde são depositados os fundos pagos pelo
Cliente
3.2 Transferidas
A transferência de fundos de uma conta de pagamentos da easypay para a conta bancária do Beneficiário é
feita por lote, numa periodicidade solicitada pelo cliente, podendo este optar por diária, semanal ou mensal.
Neste menu são apresentados os pagamentos individuais efetivamente transferidos da conta de pagamentos
para o(s) IBAN(s) definido(s) do mês corrente.
Listagem:
Data - Data em que o Cliente efetuou o pagamento
Semana - Semana em que o Cliente efetuou o pagamento
Conta de pagamentos - N.º da conta de pagamentos onde são depositados os fundos pagos pelo Cliente
Referência - Referência do pagamento listado
Canal - Meio de pagamento utilizado (MB/CC/BB/MBW/DD)
Obs - Informação adicional sobre o pagamento introduzida aquando da geração dos dados para pagamento
Chave - Identificador único do pagamento. Poder ser introduzida manualmente ou é gerada automaticamente
quando o pagamento é gerado via webservices
Valor pago - Valor pago pelo Cliente
Valor transferir - Valor total a transferir pela easypay, deduzido da respetiva comissão quando aplicável
Data transferência - Data em que a easypay faz a transferência dos fundos para o IBAN indicado
Este sub-menu permite:
*ver imagem (3.1)
A. Agrupar
B. Filtrar
C. Exportar
11
3.3 Facturadas
Neste menu são apresentados os pagamentos individuais efetivamente transferidos da conta de pagamentos
para o(s) IBAN(s) definido(s) dos meses anteriores ao corrente.
Listagem:
Data - Data em que o Cliente efetuou o pagamento
Conta de pagamentos - N.º da conta de pagamentos onde foram depositados os fundos pagos pelo Cliente
Referência - Referência do pagamento listado
Valor pago - Valor pago pelo Cliente
Valor transferir - Valor total a transferir pela easypay, deduzido da respetiva comissão quando aplicável
Valor Fixo - Valor fixo da comissão cobrada pela easypay
Valor Variável - Valor variável da comissão cobrada pela easypay, se aplicável
Valor IVA - Valor do IVA devido sobre as comissões cobradas (de acordo com a legislação em vigor)
Valor total - Somatório dos valores das comissões cobradas pela easypay incluindo o IVA.
Este sub-menu permite:
*ver imagem (3.1)
A. Agrupar
B. Filtrar
C. Exportar
3.4 Lista de Transferências
A transferência de fundos de uma conta de pagamentos da easypay para a conta bancária do Beneficiário é
feita por lote, numa periodicidade solicitada pelo cliente, podendo este optar por diária, semanal ou mensal.
Nesta tabela é indicado cada lote de transferências feitas da conta de pagamentos para o IBAN do
Beneficiário.
Listagem:
Data - Data em que a transferência foi ordenada pela easypay
Lote - Número da conta de pagamentos para onde foram depositados os fundos pagos pelo Cliente
Entidade - Entidade utilizada pelo Beneficiário
Conta de pagamentos - Número da conta de pagamentos de onde provêm os fundos transferidos
Qtd - Quantidade de pagamentos constantes do lote
Valor - Valor total transferido no lote que aparecerá no extrato bancário da conta de destino do Beneficiário
IBAN - IBAN da conta de destino dos fundos transferidos.
Este sub-menu permite:
*ver imagem (3.1)
A. Agrupar
B. Filtrar
C. Exportar
12
3.5 Impressão de facturas
O histórico de facturas emitidas pela easypay e relativas às comissões cobradas encontram-se disponíveis
para download ou consulta nesta tabela.
É importante notar que a easypay emite faturas entre os dias 8 e 10 de cada mês, relativas ao mês
transacto. Adicionalmente, as comissões apenas são cobradas quando os fundos são transferidos da conta
de pagamentos para o IBAN do Beneficiário.
Por exemplo, um pagamento que ocorra a 31 de Janeiro, só é transferido no mês seguinte, pelo que a
respetiva comissão só será faturada também no mês seguinte.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
D. Descarregar ficheiros
3.6 Download ficheiros lote
Esta tabela contém informação detalhada sobre os lotes de transferências efetuadas, possibilitando a
exportação deste detalhe para cada lote disponível, clicando no botão “Exportar Resultado”, disponível
em cada linha.
Listagem:
Lote - Número do lote transferido
Estado - pode ser “pago”, caso os fundos já tenham chegado ao IBAN do Beneficiário ou “transferido” caso
a transferência já tenha sido ordenada aguardando-se a entrada de fundos no IBAN do Beneficiário
13
N. Registos - Quantidade de pagamentos constantes do lote
Valor Pago - Valor pago pelo Cliente final
Valor Transferir - Valor total a transferir pela easypay para o IBAN do Beneficiário, deduzido da respetiva
comissão quando aplicável
Data Transferência - Data em que a transferência foi ordenada pela easypay
3.7 Arquivo 5 anos
Todas as referências pagas através da easypay ficam arquivadas no seu Arquivo de 5 Anos e disponíveis
para consulta. Nesta tabela que pode consultar todos os movimentos de entrada de fundos na conta de
pagamentos, para todos os instrumentos de pagamento utilizados.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
NOTA: Para consultar a listagem integral dos pagamentos sem aplicação filtros, deve entrar na opção “Filtros” e retirar os piscos dos campos
pesquisáveis e assegurar-se do(s) ano(s) que pretende consultar. Seguidamente deve aplicar o filtro clicando em “Aplicar”.
Listagem:
Data - Data em que o Cliente efetuou o pagamento
Entidade - Entidade utilizada no pagamento
Conta de pagamentos - Número da conta de pagamentos onde foram depositados os fundos
Referência - Referência utilizada no pagamento
N. Documento - Número identificador único (ep doc) que identifica o pagamento efetuado. É este número
que consta na notificação recebida via webservice no URL definido para o efeito.
Nome - Campo opcional. Este campo é definido pelo Beneficiário aquando da geração da referência do
pagamento. Caso esteja definido, irá mostrar o nome do cliente final.
14
Email - Campo opcional. Este campo é definido pelo Beneficiário aquando da geração da referência do
pagamento. Caso esteja definido, irá mostrar o email do cliente final.
Canal - Instrumento / meio de pagamento utilizado
MB - Referência Multibanco
MBW - MBway
CC - Cartão de Crédito
DD - Débito Direto
BB - Boleto Bancário
RP - Pagamento Recorrente
FP - Pagamento Frequente
RC - Regularização de Conta
EP - Movimento interno easypay
RV - Reversão de movimento
RF - Devolução de fundos
Obs - Campo opcional. Campo de observações disponível para preenchimento por parte do Beneficiário
aquando da geração da referência do pagamento
Chave - Campo opcional. Identificador único definido pelo Beneficiário aquando da geração da referência
Valor Pago - Valor pago pelo cliente final para a conta de pagamentos
Valor Transferir - Valor total a transferir pela easypay para o IBAN do Beneficiário, deduzido da respetiva
comissão quando aplicável
Valor Fixo - Valor fixo da comissão cobrada pela easypay
Valor Variável - Valor variável da comissão cobrada pela easypay, se aplicável
Data Transferência - Data em que a transferência foi ordenada pela easypay
Lote - Este campo é preenchido automaticamente aquando da transferência efetiva de fundos para o IBAN
do Beneficiário e identifica o lote em que o pagamento está inserido.
15
4. Menu Referências Multibanco
Apesar do nome deste menu, no Menu Referências Multibanco, o Beneficiário pode gerar dados de
pagamento para Referência Multibanco e Cartão de Crédito, bem como consultar todos os dados de
pagamento gerados para Referências Multibanco, Cartão de Crédito, MBWay e Débito Direto. Não podem
ser consultados aqui os dados de pagamento feito através de Boleto Bancário, estes estão disponibilizados
no Menu Webservices, descrito mais adiante neste manual.
4.1 Nova Referência
A geração de Referências Multibanco é normalmente feita no sistema do Cliente após integração dos nossos
serviços Web ao seu sistema / plataforma do site. No entanto, é possível gerar manualmente em Back Office
Referências Multibanco ou mesmo Referências de Pagamento por Cartão de Crédito, neste menu.
Descrição dos campos a preencher:
Começa por:
Opção: 10611 - Bloqueada ao montante sem validade
Opção: 11683 - Bloqueada ao montante com validade
Opção: 21098 - Montante em aberto sem validade
Valor: Indicar o valor do pagamento a efetuar. Este valor tem de ser obrigatoriamente superior a 1,00€
Data de Validade: Indicar a data limite do pagamento. Após esta data a referência expira automaticamente
(este campo apenas aparece na opção de entidade 11683) .
Chave: Campo opcional. Identificador único definido pelo Beneficiário aquando da geração da referência
Nome - Campo opcional. Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Email - Campo opcional. Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel - Campo opcional. Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Obs - Campo opcional. Campo de observações disponível para preenchimento por parte do Beneficiário.
Este campo apenas é visível para o Beneficiário, não sendo em nenhum momento transmitido ao cliente
final.
16
Neste menu é ainda possível consultar a tabela das últimas 100 referências geradas, bem como eliminar
referências geradas. É importante referir que que ao apagar referências, estas permanecem ativas e podem
ser pagas pelo cliente final, pelo que se desaconselha esta ação. Caso tenha o serviço easypay integrado no
seu sistema, recomenda-se a utilização de API própria para esta ação (API00). Esta API permite apagar ou
editar os dados gerados na referência.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
Listagem:
Data - Data de geração da referência
Entidade - Entidade utilizada no pagamento
Referência - Referência gerada no pagamento
Tipo de referência - Pode ser normal (Referência Multibanco, MBWay ou Cartão de Crédito) ou recorrente
(Débito Direto).
Valor - Valor do pagamento
ID - Campo opcional. Identificador único definido pelo Beneficiário aquando da geração da referência
Observações - Campo opcional. Campo de observações disponível para preenchimento por parte do
Beneficiário aquando da geração da referência do pagamento
Descrição - Campo opcional. Campo de observações disponível para preenchimento por parte do Beneficiário
aquando da geração da referência do pagamento
Nome - Campo opcional. Este campo é definido pelo Beneficiário. Este campo apenas é visível para o Beneficiário,
não sendo em nenhum momento transmitido ao cliente final.
Email - Campo opcional. Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel - Campo opcional. Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Botão “Eliminar Referência” - Esta opção só está disponível para referências geradas manualmente. De
notar que as referências eliminadas permanecem ativas e podem ser pagas pelo cliente final, pelo que se
desaconselha esta ação.
17
4.2 Nova Referência MOTO Off-Line
A geração de referências MOTO off-line (Mail Order Telephone Order) utiliza-se para os casos em que o
Beneficiário recebe a sua encomenda de forma off-line, ou seja, fora da plataforma de compras do seu site,
por exemplo, por email ou telefone.
Descrição dos campos a preencher:
Começa por:
Opção: 10611 - Bloqueada ao montante sem validade
Opção: 11683 - Bloqueada ao montante com validade
Opção: 21098 - Montante em aberto sem validade
Valor - Indicar o valor do pagamento a efetuar. Este valor tem de ser obrigatoriamente superior a 1,00€
Data de Validade: Indicar a data limite do pagamento. Após esta data a referência expira automaticamente
(este campo apenas aparece na opção de entidade 11683) .
Chave (campo opcional) - Identificador único definido pelo Beneficiário aquando da geração da referência
Nome (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Email (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Obs (campo opcional) - Campo de observações disponível para preenchimento por parte do Beneficiário.
Este campo apenas é visível para o Beneficiário, não sendo em nenhum momento transmitido ao cliente
final.
18
Neste menu é ainda possível consultar a tabela das últimas 100 referências geradas, bem como eliminar
referências geradas. É importante referir que que ao apagar referências, estas permanecem ativas e podem
ser pagas pelo cliente final, pelo que se desaconselha esta ação. Caso tenha o serviço easypay integrado no
seu sistema, recomenda-se a utilização de API própria para esta ação (API00). Esta API permite apagar ou
editar os dados gerados na referência.
Listagem:
Data - Data de geração da referência
Entidade - Entidade utilizada no pagamento
Referência - Referência gerada no pagamento
Tipo de referência - Pode ser normal (Referência Multibanco, MBWay ou Cartão de Crédito) ou recorrente
(Débito Direto).
Valor - Valor do pagamento
ID (campo opcional) - Identificador único definido pelo Beneficiário aquando da geração da referência
Observações (campo opcional) - Campo de observações disponível para preenchimento por parte do
Beneficiário aquando da geração da referência do pagamento
Descrição (Campo opcional) - Campo de observações disponível para preenchimento por parte do
Beneficiário aquando da geração da referência do pagamento
Nome (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Email (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Botão “Eliminar Referência” - Esta opção só está disponível para referências geradas manualmente. De
notar que as referências eliminadas permanecem ativas e podem ser pagas pelo cliente final, pelo que se
desaconselha esta ação
Botão “Link Visa” - Este botão direciona o utilizador para a Gateway de pagamentos por Cartão de Crédito
da easypay, se disponível
19
4.3 Listagem Referências
Nesta tabela estão apresentadas TODAS as referências que foram criadas até à data a pedido do Beneficiário
independentemente do meio de pagamento escolhido: Multibanco, MBWay, Cartão de Crédito ou Débito
Direto.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data - Data de geração da referência
Entidade - Entidade utilizada no pagamento
Referência - Referência gerada no pagamento
Valor - Valor do pagamento
Nome (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Email (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Observações (campo opcional) - Campo de observações disponível para preenchimento por parte do
Beneficiário aquando da geração da referência do pagamento.
Chave (campo opcional) - Identificador único definido pelo Beneficiário aquando da geração da referência
Botão “Link Visa” - Este botão direciona o utilizador para a Gateway de pagamentos por Cartão de Crédito
da easypay, se disponível
Botão “Editar” - Este botão permite editar os seguintes dados associados à referência de pagamento:
Nome, Email, Telemóvel, Observações e Chave
20
5. Menu Débitos Diretos
Neste Menu pode consultar toda a informação relativa aos Débitos Diretos já criados.
5.1 Débitos Enviados ao Banco
Esta tabela mostra a lista de autorizações geradas corretamente e enviadas ao banco para cobrança.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
D. Consultar Códigos SEPA
Listagem:
Data - Data de geração da Autorização de Débito em Conta (ADC)
Data de Pagamento - Data em que a cobrança é realizada na conta do cliente final
Referência ADC - Número da autorização, composto por 11 dígitos e que, dependendo do banco, pode
aparecer no extrato bancário do cliente final
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
Valor - Valor da cobrança
IBAN - Número do IBAN da conta onde é realizada a cobrança
SEPA - Indica que o pagamento é tipo RECURRING. Esta informação é para uso interno da easypay.
Periodicidade - Indica a periodicidade do Débito Direto e pode ser:
1D - Diário
1W - Semanal
2W - Bisemanal
1M - Mensal
2M - Bimestral
3M - Trimestral
4M - A cada 4 meses
6M - Bianual
1Y - Anual
21
Estado - Indica o estado do Débito Direto e pode ser “enviado”, “anulado”, “recusado”, “pago”
Obs (campo opcional) - Campo de observações disponível para preenchimento por parte do Beneficiário
aquando da criação do Débito Direto. Os Códigos podem ser consultados no botão SEPA (D).
5.2 Estado ADC
Este menu é para uso interno da easypay.
5.3 Revogações
Nesta tabela são listados os clientes que cancelaram ou inativaram as Autorizações de Débito em Conta ou
revogaram um determinado pagamento.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data - Data de geração da Autorização de Débito em Conta (ADC)
Data de cobrança - Data em que a cobrança é realizada na conta do cliente final
ADC - Número da autorização, composto por 11 dígitos e que, dependendo do banco, pode aparecer no
extrato bancário do cliente final
Chave - Campo opcional. Identificador único definido pelo Beneficiário aquando da geração da referência
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
Valor - Valor da cobrança
IBAN - Número do IBAN da conta onde é realizada a cobrança
Ficheiro - Nome do ficheiro enviado ao banco onde consta a ADC
22
5.4 Resumo cobranças
Esta tabela contém a informação sobre o sucesso das cobranças enviadas ao banco em determinado dia.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data de envio - Data de envio do ficheiro de ADC ao banco
Data de cobrança - Data em que a cobrança é realizada na conta do cliente final
SEPA -Indica que o pagamento é tipo RECURRING. Esta informação é para uso interno da easypay.
ADC - Número da autorização, composto por 11 dígitos e que, dependendo do banco, pode aparecer no
extrato bancário do cliente final
Total (número de ADC) - Número total de ADC constantes no ficheiro enviado
Cobrado (número de ADC) - Número de ADC cobradas com sucesso por ficheiro
Recusado (número de ADC) - Número de ADC recusadas por ficheiro
TX (número de ADC) - Taxa de sucesso de cobranças das ADC, calculado através da seguinte fórmula:
cobrado/total
Total (valor em euros de ADC) - Valor total de ADC constantes no ficheiro enviado
Cobrado (valor em euros de ADC) - Valor de ADC cobradas com sucesso por ficheiro
Recusado (valor em euros de ADC) - Valor de ADC recusadas por ficheiro
TX (valor em euros de ADC) - Taxa de sucesso de cobranças das ADC, calculado através da seguinte fórmula:
cobrado/total
É ainda possível ver o detalhe de cada ficheiro de ADC, clicando no botão “Detalhe”.
23
Neste sub-menu, é possível visualizar a informação de cada ficheiro enviado para cobrança ao banco:
Sumário do ficheiro: Nome do ficheiro enviado ao banco
Qt: Quantidade de ADC constantes no ficheiro por estado ou motivo
Valor: Valor das ADC por estado
Motivo: Código de estado da transação e respetiva transação
A tabela apresenta o detalhe das ADC recusadas.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Referência - Número da ADC
Valor - Valor da ADC
Erro - Código de transação, cuja descrição se encontra na tabela superior
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
IBAN - Número do IBAN da conta onde é realizada a cobrança
SWIFT - Código SWIFT associado à ADC
24
5.5 Lista Débitos Cobrados
Esta tabela detalha os Débitos Diretos cobrados com sucesso.
Para informação, estão descritos todos os códigos de estado possíveis associados a uma ADC clicando no
botão “SEPA”.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data - Data de envio do ficheiro para o banco
Referência ADC - Número da ADC
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
Valor - Valor da ADC
IBAN - Número do IBAN da conta onde é realizada a cobrança
SEPA -Indica que o pagamento é tipo RECURRING. Esta informação é para uso interno da easypay.
Periodicidade - Indica a periodicidade do Débito Direto e pode ser:
1D - Diário
1W - Semanal
2W - Bisemanal
1M - Mensal
2M - Bimestral
3M - Trimestral
4M - A cada 4 meses
6M - Bianual
1Y - Anual
Obs - Código de estado
Estado - Código de estado
25
5.6 Lista Débitos NÃO Cobrados
Esta tabela detalha os Débitos Diretos não cobrados. Para informação, estão descritos todos os códigos de
estado possíveis associados a uma ADC clicando no botão “SEPA”.
Este sub-menu permite:
(5.5 seguir imagem anterior)
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data - Data de envio do ficheiro para o banco
Referência ADC - Número da ADC
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
Valor - Valor da ADC
IBAN - Número do IBAN da conta onde é realizada a cobrança
SEPA -Indica que o pagamento é tipo RECURRING. Esta informação é para uso interno da easypay.
Periodicidade - Indica a periodicidade do Débito Direto e pode ser:
1D - Diário
1W - Semanal
2W - Bisemanal
1M - Mensal
2M - Bimestral
3M - Trimestral
4M - A cada 4 meses
6M - Bi-anual
1Y - Anual
Obs - Código de estado
Estado - Código de estado
26
6. Menu Cartão de Crédito
Neste menu é possível listar e gerir as operações feitas com recurso a Cartão de Crédito.
6.1 Autorizações
Nesta tabela encontra-se informação relativa a todos os pedidos de pagamento por Cartão de Crédito.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Notificar (envia ao cliente nova notificação de pagamento)
Listagem:
Data - Data de criação do pedido de pagamento
Nome - Nome do titular do cartão de crédito
Email - Email inserido pelo cliente final
Chave - Campo opcional. Identificador definido aquando da geração da referência no Menu “Referências
Multibanco” ou via API no sistema do Beneficiário
Entidade - Entidade gerada Menu “Referências Multibanco” ou via API no sistema do Beneficiário
Referência - Referência gerada no Menu “Referências Multibanco” ou via API no sistema do Beneficiário
Valor - Valor do pagamento
Canal - Indica o nível de segurança do pagamento em questão e pode ser:
MOTO - Não tem dupla validação
3DS - Tem dupla validação, ou seja, após inserção dos dados do cartão de crédito, o Cliente Final
recebe uma mensagem com código de validação a inserir para autorização final do pagamento
Estado - Estado do pedido de pagamento.
Descrevem-se de seguida os estados de uma compra por CC:
“Pago”: Pagamento concluido e processado
“Autorizado”: O pagamento está efetivamente autorizado, mas ainda não foi concretizado. Para
que o estado seja alterado para “Pago”, é obrigatória a intervenção do Beneficiário, caso contrário a
autorização expira passados sensivelmente 15 dias. De notar que o valor fica cativo no cartão do cliente
final durante este período.
27
A intervenção do Beneficiário pode ser uma das seguintes ações:
Caso o Beneficiário não tenha integrado os serviços da easypay no seu sistema, tem de ser feita a captura
manualmente neste backoffice (ver ponto seguinte). Para pagamentos inferiores a 150€ a captura é imediata.
Para os restantes valores poderá ser alvo de validação por parte da easypay.
Caso o Beneficiário tenha integrado a captura automática, deverá correr a API05. Em caso de falha poderá
recorrer às indicações anteriores.
“Pendente”: A comunicação de dados do cartão foi interrompida antes de ser concluída,
por exemplo, fecho inesperado ou propositado da gateway, lentidão nas comunicações de internet. O
pagamento não foi bem sucedido. Neste caso o cliente final terá de repetir o processo de inserção de dados
até este ser bem sucedido. Alternativamente pode ser utilizada a mesma entidade e referência geradas para
este movimento e proceder-se ao respetivo pagamento via opção “Pagamento de Serviços”
“Enrolled”: O pagamento não foi bem sucedido e terá de ser repetido pelo cliente final. A
causa deste estado prende-se com problemas de comunicação entre as entidades envolvidas ou porque o
cartão está preparado para o 3DS mas não está activo ou o cartão não está preparado para 3DS;
“Cancelado”: A autorização encontra-se cancelada por indicação de qualquer das partes
envolvidas no processo.
“Recusado”: O pagamento pode ser recusado caso o CC não tenha plafond, não esteja válido,
não autorizado pelo banco, entre outras razões.
6.2 Pedir Pagamento
Esta tabela apresenta todos os pedidos que se encontram no estado “Autorizado” (ver ponto acima).
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar resulados
D. Validar Pagamento
Listagem:
Data - Data de em que os dados de pagamento do cliente final foram submetidos na plataforma easypay
Semana - Semana em que os dados de pagamento do cliente final foram submetidos na plataforma easypay
no formato AA/SS
País - País em que o Beneficiário está registado
Entidade - Entidade gerada Menu “Referências Multibanco” ou via API no sistema do Beneficiário
Referência - Referência gerada no Menu “Referências Multibanco” ou via API no sistema do Beneficiário
28
Valor - Valor do pagamento
Canal - Indica o nível de segurança do pagamento em questão e pode ser:
MOTO - Não tem dupla validação
3DS - Tem dupla validação, ou seja, após inserção dos dados do cartão de crédito, o Cliente Final
recebe uma mensagem com código de validação a inserir para autorização final do pagamento
É também nesta tabela que é solicitada a captura do valor clicando no botão “Validar Pagamento”.
Este submenu apresenta, para um pagamento, os dados pré-preenchidos do Nome, Tipo de Transação,
Entidade, Referência e Valor, podendo ser editado o campo Valor.
O Beneficiário deve anexar a fatura ou nota de encomenda relativa ao pagamento e seguidamente clicar em
“Processar Pagamento”.
6.3 Cancelar e Devolver
Neste menu permite devolver fundos total ou parcialmente ao cliente final ou cancelar autorizações de
pagamento.
O processo tem os seguintes passos:
1. Inserir a Referência (9 dígito) relativa ao pagamento que se pretende devolver/cancelar e clicar em
“Lupa”; Automaticamente, é preenchida a tabela de dados desse pagamento, com os seguintes tópicos:
ID - Identificador único do pagamento ou autorização
Data - Data em que a autorização ou o pagamento foi efetuado
Cliente - Código atribuído ao Beneficiário, também referido como id_user
Entidade - Entidade gerada Menu “Referências Multibanco” ou via API no sistema do Beneficiário
Referência - Referência gerada no Menu “Referências Multibanco” ou via API no sistema do
Beneficiário
Valor - Valor do pagamento
Canal - Indica o nível de segurança do pagamento em questão e pode ser:
MOTO - Não tem dupla validação
3DS - Tem dupla validação, ou seja, após inserção dos dados do cartão de crédito, o Cliente
Final recebe uma mensagem com código de validação a inserir para autorização final do pagamento
Cartão - Número do cartão de crédito utilizado no pagamento, composto pelos primeiros 6 dígitos
do cartão, seguindo-se os últimos 4 dígitos do cartão
Nome - Nome do Cliente Final, preenchido aquando da inserção dos dados do cartão
Titular do cartão - Nome do Titular do Cartão, preenchido aquando da inserção dos dados do cartão
29
Email - Email, preenchido aquando da inserção dos dados do cartão
Telefone - Telefone, preenchido aquando da inserção dos dados do cartão
Estado - Estado do pagamento que pode ser “Pago” ou “Autorizado”
2. Seguidamente clicar no BotãoId. Os campos em baixo (“Operação”, “Devolver”) ficam
automaticamente preenchidos. Pode editá-los com valores diferentes (no caso de uma devolução parcial).
O campo “Código” tem de ser preenchido manualmente e deverá ser precisamente igual ao código sugerido
na parte inferior desse campo.
3. Por último, deverá clicar no botão “Processar”
6.4 Países
Nesta tabela são apresentados os códigos de todos os países de acordo às bases de dados oficiais disponíveis.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar resulados
Listagem:
País - Abreviatura do país composta por duas letras
Nome - Nome do país
30
7. Menu MBWay
7.1 Criar Autorização ou Compra
Neste menu é gerada a referência para pagamento por MBWay.
Descrição dos campos a preencher:
Começa por:
Opção: 10611 - Bloqueada ao montante sem validade
Opção: 11683 - Bloqueada ao montante com validade
Opção: 21098 - Montante em aberto sem validade
Valor - Indicar o valor do pagamento a efetuar. Este valor tem de ser obrigatoriamente superior a 1,00€
Data de Validade - Indicar a data limite do pagamento. Após esta data a referência expira automaticamente
(este campo apenas aparece na opção de entidade 11683) .
Chave - Campo opcional. Identificador único definido pelo Beneficiário aquando da geração da referência
Nome (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Email (campo opcional) Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Operação:
Final
- Botão “Autorização”: O valor do pagamento fica cativo, não sendo transferido da conta do Cliente
- Botão “Compra”: O valor é transferido da conta do Cliente Final
Descrição (campo opciona) - Campo de observações disponível para preenchimento por parte do
Beneficiário. Este campo apenas é visível para o Beneficiário, não sendo em nenhum momento transmitido
ao cliente final.
31
7.2 Listar
7.2.1 Autorizações e compras
Neste sub-menu, o Beneficiário pode consultar o sucesso do estado de autorização ou compra. Através do
botão “Histórico”, é possível verificar quais os estados anteriores ao descrito na tabela.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar resulados
D. Histórico
Listagem:
Criado em - Data e hora da última operação verificada e escrita na tabela
Conta de pagamentos - Número da conta onde o pagamento foi processado, também chamado CIN
Entidade - Entidade gerada Menu “Criar autorização ou compra” ou via API no sistema do Beneficiário
Referência - Referência gerada no Menu “Criar autorização ou compra” ou via API no sistema do Beneficiário
Descrição - Campo opcional, preenchido no Menu “Criar autorização ou compra” ou via API no sistema do
Beneficiário
Operação - Indica o tipo de operação realizada que pode ser “Autorização”, “Reembolso”, “compra”,
“Cancelamento”
Estado - Indica o estado da operação que pode ser “Sucesso”, “Rejeitado”, “Erro”, “Pendente”.
Mensagem -Detalhe sobre o estado reportado
Indicativo - Indicativo do telefone utilizado no pagamento
Telefone - Número de telemóvel utilizado no pagamento
Email (campo opcional) - preenchido no Menu “Criar autorização ou compra” ou via API no sistema do
Beneficiário
Valor - Indicar o valor do pagamento a efetuar. Este valor tem de ser obrigatoriamente superior a 1,00€
Moeda - Moeda utilizada no pagamento
Chave (campo opcional) - preenchido no Menu “Criar autorização ou compra” ou via API no sistema do
Beneficiário
32
7.2.2 Erros
Neste sub-menu, o Beneficiário pode consultar o erros das autorizações ou compras.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar resulados
Listagem:
Consultar campos da listagem do menu 7.2.1.
8. Menu Pagamentos Recorrentes
8.1 Nova Referência
Neste menu podem ser geradas referências para pagamentos recorrentes por débito direto.
Descrição dos campos a preencher:
Começa por:
Opção: 10611 - Bloqueada ao montante sem validade
Opção: 11683 - Bloqueada ao montante com validade
33
Opção: 21098 - Montante em aberto sem validade
Valor - Indicar o valor do pagamento a efetuar. Este valor tem de ser obrigatoriamente superior a 1,00€
Data de Validade -Indicar a data limite do pagamento. Após esta data a referência expira automaticamente
(este campo apenas aparece na opção de entidade 11683) .
Chave (campo opcional) - Identificador único definido pelo Beneficiário aquando da geração da referência
Nome (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Email (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Telemóvel (campo opcional) - Este campo é definido pelo Beneficiário. Este campo apenas é visível para o
Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Periodicidade - Deve ser indicada a periodicidade do pagamento que pode ser Mensal, Bimensal, Trimestral,
Quadrimestral, Semestral e Anual
Número máximo débitos autorizado - Número máximo de débitos autorizados para o pagamento. Caso não
pretenda atribuir um limite, deverá preencher com “0” (zero).
Valor máximo autorizado - Valor máximo autorizado para o pagamento. Caso não pretenda atribuir um
limite, deverá preencher com “0” (zero).
Data limite de autorização - Data a partir da qual a referência gerada já não é válida para pagamento. Esta
data terá de ser obrigatoriamente pelo menos 2 dias após a data de criação
Gestão easypay - Deve ser sim, se o controlo o envio de dados ao banco é da responsabilidade da easypay
ou não caso estes controlo seja feito diretamente pelo Beneficiário.
Tipo de pagamento - Indica o tipo de pagamento pretendido. De momento apenas está disponível o débito
direto
Data primeiro débito - Data em que é ordenado o primeiro débito na conta do Cliente final. Esta data terá
de ser obrigatoriamente pelo menos 2 dias após a data de criação
Nome do titular da conta (Campo obrigatório) - Deve ser inserido o nome do titular da conta onde será
processado o débito direto
IBAN - (campo obrigatório) - Deve ser inserido o IBAN onde será processado o débito direto
Após preenchimento dos campo, o formulário deverá ser enviado clicando no botão “Submeter”.
34
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
Listagem:
Data - Data de envio do ficheiro para o banco
Tipo - Instrumento de pagamento utilizado, que pode ser “DD” (Débito Direto) ou “CC” (Cartão de Crédito)
Periodicidade - Indica a periodicidade do Débito Direto e pode ser:
2W - Bisemanal
1M - Mensal
2M - Bimestral
3M - Trimestral
4M - Quadrimestral
1Y - Anual
Valor - Valor processado no pagamento
Chave - Identificador único definido pelo Beneficiário aquando da geração da referência
Ep_k1 - Chave única gerada pelo software da easypay para o pagamento indicado
Referência - Referência gerada para o pagamento em questão
IBAN/Card - Número do IBAN ou cartão de crédito onde será processado o pagamento. O número é
composto pelos primeiros 5 dígitos do IBAN ou cartão, seguindo-se os últimos 4 dígitos do IBAN ou cartão
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
Telefone - Este campo é definido aquando da criação da referência de pagamento. Este campo apenas é
visível para o Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
Última Data - Data do último pagamento processado
Próxima Data - Data de processamento o próximo pagamento
35
8.2 Estado das autorizações
Este menu disponibiliza informação detalhada sobre as autorizações dos pagamentos por débito direto.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
D. Editar Autorização Débito Conta
Listagem:
Num Autorização - Chave única associada ao pagamento e gerada automaticamente pelo sistema da
easypay
Tipo - Instrumento de pagamento utilizado, que pode ser “DD” (Débito Direto) ou “CC” (Cartão de Crédito)
Referência - Referência gerada para o pagamento em questão clicando no local da referência, este abre
uma nova aba que permite ao beneficiário editar os dados da Autorização de Débito da mesma (consultar
imagem acima).
Chave - Identificador único definido pelo Beneficiário aquando da geração da referência
Periodicidade - Indica a periodicidade do Débito Direto e pode ser:
2W - Bisemanal
1M - Mensal
2M - Bimestral
3M - Trimestral
4M - Quadrimestral
1Y - Anual
Valor - Valor processado no pagamento
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
Telefone - Este campo é definido aquando da criação da referência de pagamento. Este campo apenas é
visível para o Beneficiário, não sendo em nenhum momento transmitido ao cliente final.
IBAN/Card - Número do IBAN ou cartão de crédito onde será processado o pagamento. O número é
composto pelos primeiros 5 dígitos do IBAN ou cartão, seguindo-se os últimos 4 dígitos do IBAN ou cartão
Número máximo débitos autorizado - Número máximo de débitos autorizados para o pagamento.
36
Caso não pretenda atribuir um limite, deverá preencher com “0” (zero).
Valor máximo autorizado - Valor máximo autorizado para o pagamento. Caso não pretenda atribuir um
limite, deverá preencher com “0” (zero).
Expira - Data de expiração da autorização
Estado - Indica o estado em que se encontra o pagamento
Pedido Pagamento - Indica a resposta da entidade bancária do Cliente final ao pedido de pagamento e
pode ser “Aceite”, “Em processamento”, “Sem pedido” e “Recusado”.
8.3 Estado dos pedidos
Este menu disponibiliza informação detalhada sobre os pedidos de pagamento por débito direto.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Referência - Referência gerada para o pagamento em questão
Chave - Identificador único definido pelo Beneficiário aquando da geração da referência
Ep_k1 - Chave única gerada pelo software da easypay para o pagamento indicado quando não há integração
do sistema do Beneficiário com o sistema da easypay
SEPA - Indica que o pagamento é tipo RECURRING. Esta informação é para uso interno da easypay.
Rec_key - Chave única gerada pelo software do Beneficiário para o pagamento indicado quando há
integração do sistema do Beneficiário com o sistema da easypay
Valor - Valor processado no pagamento
Tipo - Instrumento de pagamento utilizado, que pode ser “DD” (Débito Direto) ou “CC” (Cartão de Crédito)
Data Pedido - Data do pedido de pagamento
Timestamp - Data e hora da resposta recebida por parte da entidade bancária do Cliente final
Estado pedido - Pode ser OK ou ERR, caso o pedido não tenha tido sucesso
Estado resposta - Pode ser OK ou ERR, caso o pedido não tenha tido sucesso
Mensagem - Detalhe do estado recebido
37
8.4 Resumo
Este menu permite a pesquisa de todos os dados associados a uma referência de pagamento, bastando
para isso colocar os 9 dígitos correspondentes à referência que pretende procurar, sem espaços, e clicar no
botão “Lupa”.
Os quadros em baixo são automaticamente preenchidos com a informação disponível.
8.5 Listagens RP
Este menu permite consultar todos os pagamentos identificados como Pagamentos Recorrentes,
independentemente de estarem ou não ativos.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data - Data de resposta do banco do Cliente final
Tipo - Instrumento de pagamento utilizado, que pode ser “DD” (Débito Direto) ou “CC” (Cartão de Crédito)
38
Periodicidade - Indica a periodicidade do Débito Direto e pode ser:
2W - Bissemanal
1M - Mensal
2M - Bimestral
3M - Trimestral
4M - Quadrimestral
1Y - Anual
Valor - Valor processado no pagamento
Nome - Nome da entidade a quem vai ser cobrado o Débito Direto
Email - Email da entidade a quem vai ser cobrado o Débito Direto
IBAN/Card - Número do IBAN ou cartão de crédito onde será processado o pagamento. O número é
composto pelos primeiros 5 dígitos do IBAN ou cartão, seguindo-se os últimos 4 dígitos do IBAN ou cartão
Estado - Indica o estado em que se encontra o pagamento
Pedido Pagamento - Indica a resposta da entidade bancária do Cliente final ao pedido de pagamento e
pode ser “Aceite”, “Em processamento”, “Sem pedido” e “Recusado”
Data próximo pagamento - Data de processamento o próximo pagamento
Gestão easypay - Se sim, o controlo o envio de dados ao banco é da responsabilidade da easypay, se não
este controlo seja feito diretamente pelo Beneficiário.
8.6 Listagens Swift
Neste menu é apresentada uma listagem de códigos SWIFT e a respetiva correspondência em termos da
instituição bancária a que pertencem, bem como o código do país.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
39
8.7 Datas SEPA
Esta tabela mostra as datas previstas para as operações SEPA com base na data de criação desta.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data - Data de criação da transferência SEPA
Data First - Data em que é possível ocorrer a primeira transferência após processamento da ordem pela
instituição bancária.
Data recurring - Data a partir da qual é contabilizado o próximo pedido de pagamento.
8.8 Remover com ficheiro
Neste menu é possível remover ADC em lote, por ficheiro.
Como fazer:
A. Descarregar o template do ficheiro de referências
B. No ficheiro preencher os dados : “Client_id”, “Account” e “Ref_adc”.
Client_id - número de cliente disponível no Menu Beneficiário composto por até 6 letras e 6 números,
localizado por baixo do nome do Beneficiário
Account - Número de conta de pagamentos da easypay
Ref_adc - Número da Autorização de Débito em Conta
C. Fazer o upload para processamento pelo sistema easypay
40
9. Menu Pagamentos Frequentes
9.1 Novo Token
Neste menu é criada uma representação
de um Cartão de Crédito para ser utilizada
múltiplas vezes.
O Beneficiário preenche os dados referentes
ao pagamento, incluindo o email do cliente
final e submete a informação.
Posteriormente, o Beneficiário deve aceder
ao Menu “Lista Tokens”, descrito em detalhe
em baixo, para proceder ao envio do pedido
de dados de cartão. Este pedido segue por
email, onde é apresentado um link que
direciona o cliente final para a gateway da
easypay, onde o cliente preencherá os dados
relativos ao seu cartão de crédito.
Desta forma apenas o cliente final tem
acesso aos seus dados de cartão de crédito,
dado que estes dados são automaticamente
tokenizados após submissão do formulário
existente na gateway.
9.2 Lista Tokens
Neste menu estão listados todos os tokens criados sobre os diversos meios de pagamento que permitem a
reutilização para montantes e periodicidades distintas.
Sempre que um token é gerado manualmente, o Beneficiário terá de aceder a este
menu e clicar no botão “Pedir dados” referente ao pagamento que pretende efetivar.
É neste momento que é despoletado um email automático para recolha de dados
junto do cliente final.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
E. Pedir dados
F. Pedir Pagamento
D. ep_k1number (histórico de Tokens
de Pagamentos Frequentes)
41
Listagem:
Data - Data de criação do token
Entidade - Entidade associada ao instrumento de pagamento referente ao token criado
Conta pagamentos - Conta de pagamentos easypay associada ao token criado
Nome - Nome do cliente final
Email - Email do cliente final
Telefone - Telefone do cliente final
Ep_k1 - Chave única gerada para o token em causa
Valor Máximo captura - Valor máximo autorizado para pagamento
Data Expiração - Data a partir da qual o token expira, ou seja, deixa de estar válido para utilização
Data último pedido - Data em que foi processado o último pagamento
10. Menu Inscrições
Este menu é apenas aplicável a clientes que utilizam formulário e permite consultar o detalhe de todas as
inscrições bem como o estado do pagamento destas.
10.1 Listagem Principal
Contém a listagem de todas as inscrições efetuadas.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
D. Consultar Ficha Inscrição e últimos pagamentos
Clicando no botão do campo “Nome” é ainda possível aceder aos dados de registo respetivos bem como
procurar o histórico de pagamentos feito.
Listagem:
Data registo - Data de registo no formulário
ADC - Número da referência gerada para pagamento através do formulário
Nome - Nome do cliente final
42
Email - Email do cliente final
Valor - Valor do pagamento
Periodicidade - Periodicidade do pagamento, caso seja uma autorização de débito direto
Estado - Estado do pedido de pagamento
Campanha - Campo criado no formulário pelo Beneficiário
Canal - Ambiente em que foi criado o pagamento
Tipo - Meio de pagamento utilizado (MB, CC ou DD)
Data primeiro débito - Data do primeiro pagamento processado, aplicável apenas a Débito Direto
Var_1 a var_6 - Campos opcionais fornecidos no preenchimento do formulário
Número contribuinte - Número de contribuinte do Cliente Final
Data nascimento - Data de nascimento do Cliente Final
10.2 Pagos
Contém a listagem de todos os pagamentos processados com sucesso.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data registo - Data de registo no formulário
ADC - Número da referência gerada para pagamento através do formulário
Nome - Nome do cliente final
Email - Email do cliente final
Valor - Valor do pagamento
Var_1 a var_6 - Campos opcionais fornecidos no preenchimento do formulário
Número contribuinte - Número de contribuinte do Cliente Final
Data nascimento - Data de nascimento do Cliente Final
43
10.3 Pendentes
Contém a listagem de todos os pagamentos que se encontram pendentes.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Data registo - Data de registo no formulário
Estado - Estado do pedido de pagamento
ADC - Número da referência gerada para pagamento através do formulário
Nome - Nome do cliente final
Email - Email do cliente final
Total - Valor total do pagamento
Canal - Ambiente em que foi criado o pagamento
Campanha - Campo criado no formulário pelo Beneficiário
Tipo - Meio de pagamento utilizado (MB, CC ou DD)
Data primeiro débito - Data do primeiro pagamento processado, aplicável apenas a Débito Direto
Var_1 a var_6 - Campos opcionais fornecidos no preenchimento do formulário
Número contribuinte - Número de contribuinte do Cliente Final
Data nascimento - Data de nascimento do Cliente Final
44
10.4 Resumo Anual
Contém o resumo, por Autorização de Débito em Conta de todos os pagamentos efetuados.
Este sub-menu permite:
A. Pesquisar valores sobre tabela
B. Filtrar
C. Exportar Resultados
Listagem:
Ano - Ano a que respeita o registo
ADC - Número da referência gerada para pagamento através do formulário
Nome - Nome do cliente final
Email - Email do cliente final
Total - Valor total do pagamento
Qtd - Quantidade de pagamentos efetuados
11. Menu Web Services
Este menu deve ser utilizado pelo gestor informático do Beneficiário para os seguintes temas:
1. configuração dos destinatários das notificações,
2. configuração de autenticações de comunicação
3. visualização de todas as comunicações entre o Beneficiário e a easypay
11.1 Configuração URL
Esta opção é utilizada quando o sistema da easypay e o sistema do Beneficiário comunicam via webservices.
45
Os campos a preencher são os seguintes para cada uma das contas de pagamento existentes:
VISA: Detalhe - URL para onde são enviados os detalhes sobre todos os pagamentos existentes
VISA: Forward - URL para onde o cliente final é redirecionado após pagamento por CC
URL: Notificar - URL para onde serão enviadas as notificações de todos os pagamento existentes
URL Recorrente - URL para onde serão enviadas as notificações de pagamentos recorrentes efetuados
BOLETO: Forward - URL para onde o cliente final é redirecionado após pagamento por Boleto Bancário
MBWAY Auth Notificar - URL a contactar quando existe uma notificação de autorização de pagamento por
MBWay
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
11.2 Configuração Email
Para cada uma das contas de pagamento existentes, poderá configurar emails para receção de notificações.
Caso pretenda enviar uma notificação para mais do que um email, deverá inserir todos os emails pretendidos
separados por “,” (vírgula).
Campos:
EMAIL: Notificação pagamentos - Email que será notificado sobre todos os pagamentos que sejam dados
como “Pago”
EMAIL: Notificações técnicas - Email que será notificado sempre que exista necessidade de enviar
notificações de caráter técnico. Este email deverá pertencer a um interlocutor do Beneficiário de nível
técnico.
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
11.3 Configuração IP
Para cada uma das contas de pagamento existentes pode configurar até 3 IP diferentes para receção de
notificações, bastando para isso inserir os IPs de onde são feitas as chamadas às APIs.
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
46
11.4 Configuração Código
Neste menu, para cada conta de pagamentos existente, pode ativar a receção de notificações por IP, clicando
no botão “Endereço IP” ou gerar um código de autenticação clicando em “Código Chave”, que deverá ser
utilizado em cada chamada às APIs.
11.5 Status API
Neste menu encontram-se resumidas todas as comunicações feitas entre o sistema do Beneficiário e a
easypay.
Este sub-menu permite:
A. Filtrar
11.6 Notificações
Todas as notificações de pagamentos são registadas e disponibilizadas neste menu.
Este sub-menu permite:
A. Filtrar
B. Verificar detalhes das notificações
47
Listagem:
Conta de Pagamentos - Número da conta de pagamentos ou CIN
Data - Data e hora em o Beneficiário foi notificado sobre o pagamento
Mensagem - Classificação do estado da notificação
URL - URL para onde foi enviada a notificação e definido em “URL: Notificar” concatenado com CIN,
Entidade e Número de Documento (número único que é gerado pela easypay após o pagamento e que pode
ser consultado em “Arquivo 5 anos”.
11.7 Renotificar
Sempre que a easypay não consegue comunicar com o “URL: Notificar” definido, é gerado um erro que fica
listado neste menu.
Aqui é possível reenviar estas notificações para o URL definido.
ALERTA: Deve selecionar as notificações que NÃO pretende notificar.
Seguidamente deve clicar em “Submeter” para ativar o envio.
11. 8 Configurações API 2.0
Este menu permite ativar a utilização das APIs 2.0.
O procedimento é o seguinte:
1. Configurar as chaves clicando no botão “Chaves”
a. Pode consultar e editar as chaves existentes ou criar uma nova
b. Para uma nova chave, deverá preencher um nome e o código da chave será atribuído
automaticamente pelo sistema
c. Esta chave será utilizada em todas as chamadas às APIs da easypay
2. Configurar notificações clicando no botão “Notificações”
48
Generic - URL - URL para envio de todas as notificações genéricas sem detalhe
Payment - URL - URL para receber todos os detalhes de pagamentos
Authorization URL - URL para receber todos os detalhes de autorizações de pagamentos
Generic - Header x-easypay-code - Este campo é opcional. Código definido pelo Beneficiário
que constará em todas as comunicações validando a comunicação easypay no vosso URL
Payment - Header x-easypay-code - Este campo é opcional. Código definido pelo Beneficiário
que constará em todas as comunicações validando a comunicação easypay no vosso URL
Authorization - Header x-easypay-code - Este campo é opcional. Código definido pelo
Beneficiário que constará em todas as comunicações validando a comunicação easypay no vosso URL
11. 9 Sandbox Easypay
Clicando neste menu, poderão aceder à vossa conta testes, caso esta já tenha sido configurada.
A conta testes é em tudo idêntica ao ambiente do backoffice de produção, no entanto, as transações são
“fictícias” dado que não transferidos quaisquer fundos.
12. Menu Quick Easypay
Este menu permite criar um botão de pagamento imediato sem ter dados de pagamento pré-preenchidos
e está disponível sob consulta.
A configuração deste menu deverá ser feita com o apoio da easypay, pelo que agradecemos o vosso
contacto para correio@easypay.pt.
13. Menu Formulários Easypay
Este menu permite criar formulários que podem ser embebidos no site do Beneficiário permitindo o
preenchimento de dados de pagamento sendo este processado de seguida.
A configuração deste menu deverá ser feita com o apoio da easypay, pelo que agradecemos o vosso
contacto para correio@easypay.pt.
14. Menu Upload 2 APIs
Este menu permite criar múltiplas referências de pagamento ou pagamentos com um único ficheiro que
será automaticamente processado pelo sistema da easypay.
A configuração deste menu deverá ser feita com o apoio da easypay, pelo que agradecemos o vosso
contacto para correio@easypay.pt.
15. Menu Equipas
Os acessos ao backoffice são feitos através de privilégios atribuídos por equipa e por utilizador, sendo que
uma equipa tem 1 ou mais utilizadores.
49
15.1 Listar
Neste menu é possível consultar todas as equipas associadas ao Beneficiário, bem com os privilégios de
acesso atribuídos.
É possível pesquisar por nome.
Clicando no botão existente no campo “Nome” acede aos dados e acessos dessa equipa, sendo possível
editá-los. É possível ainda a criação de uma nova equipa neste sub-menu, caso haja permissões definidas
para o efeito.
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
15. 2 Criar
Neste menu é feita a criação de novos membros da equipa que terão acesso a este backoffice e a uma conta
de pagamentos específica.
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
50
16. Menu Utilizadores
16.1 Listar
Neste menu é possível consultar todos os utilizadores associados ao Beneficiário, bem com os privilégios
de acesso atribuídos.
É possível pesquisar por nome.
Clicando no botão existente no campo “Nome” acede aos dados e acessos desse membro da equipa, sendo
possível editá-los. É possível ainda a criação de um novo utilizador neste sub-menu, caso haja permissões
definidas para o efeito.
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
16. 2 Criar
Neste menu é feita a criação de novos membros da equipa que terão acesso a este backoffice e a uma conta
de pagamentos específica.
No final, deverá clicar no botão “Submeter” para salvar os dados inseridos, caso contrário serão perdidos.
51
Morada
Rua Soares de Passos, 14 B
1300-537 Lisboa
Portugal
Contacto
(+351) 213 617 930
correio@easypay.pt
A easypay é uma instituição de pagamento autorizada pelo Banco de Portugal sob o N.º 8706.
Easypay é Merchant Agent da Visa e Payment Facilitator da MasterCard.
Temos os mais altos padrões de Certificação da Payment Card Industry (PCI) - nível 1