Manual de Especificação Técnica Webservice - Comparador de Comissões

ANEXO II
BANCO NACIONAL DE ANGOLA
Manual de Especificação Técnica
Mecanismo de Reporte no âmbito do comparador

de comissões
Versão 1.0
Dezembro de 2023
CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 5 de 36

Índice
1. INTRODUÇÃO ....................................................................................................................... 5
1.1. Âmbito do Documento .............................................................................................................. 5
1.2. Glossário e acrónimos .............................................................................................................. 5
2. INFORMAÇÃO A REPORTAR ................................................................................................... 6

2.1. Validações implementadas ........................................................................................................ 6
3. SERVIÇOS ............................................................................................................................ 7
4. SERVIÇOS DE SUBMISSÃO..................................................................................................... 8
4.1. Serviço de Autenticação ........................................................................................................... 8
4.2. Submissão de comissão ............................................................................................................ 9
4.3. Submissão de comissão em massa .......................................................................................... 12
4.4. Eliminar Comissão .................................................................................................................. 14
4.5. Actualizar Comissão ............................................................................................................... 15
5. SERVIÇOS DE LISTAGEM E PESQUISA .................................................................................. 17

5.1. Consultar Comissões .............................................................................................................. 17
5.2. Total de comissões ................................................................................................................ 18
5.3. Consultar Bases ..................................................................................................................... 19
5.4. Total base de serviços ............................................................................................................ 20
5.5. Consultar Periodos de Cobranças ............................................................................................ 21
5.6. Total Período de Cobrança ...................................................................................................... 21
5.7. Consultar Produtos ................................................................................................................. 22
5.8. Total de produtos .................................................................................................................. 24
5.9. Consultar Serviços ................................................................................................................. 24
5.10. Total de serviços .................................................................................................................. 25
5.11. Consultar Tipos de produtos .................................................................................................. 26
5.12. Total Tipos de Produtos ........................................................................................................ 27
5.13. Consultar Medidas ................................................................................................................ 28
5.14. Total Medidas ...................................................................................................................... 29
Anexo 1 – Tabelas de Códigos Auxiliares .........................................................................30

Anexo 2 – Mensagens de Erro ........................................................................................32
Anexo 3 – Próximos passos ............................................................................................33

REGISTO DE ALTERAÇÕES
VERSÃO DATA OBSERVAÇÕES

Versão Final Aprovada.
1.0 01-12-2023
Alteração da codificação dos Serviços, Produtos e dos Tipos de produtos

1. Introdução
1.1. Âmbito do Documento

O presente documento descreve as especificações técnicas e respectiva estrutura de informação
adoptada no desenvolvimento do Webservice para a submissão das comissões relativas a
serviços associados a contas de depósito, cartões, transferências e prestações de serviço
transversais as Instituições Financeiras Bancárias do sistema financeiro angolano. Para tal,
procurar-se-á documentar com o maior rigor e detalhe os requisitos.
Para tornar mais fácil a leitura, o documento encontra-se organizado em 2 capítulos:
• No capítulo 1 encontra-se a introdução do documento e o devido enquadramento;
• No capítulo 2 encontra-se a descrição técnica dos requisitos de cada serviço
apresentado.
1.2. Glossário e acrónimos

Em seguida são apresentadas as abreviaturas, definições e conceitos utilizados ao longo do
documento:
BNA – Banco Nacional de Angola
DTI – Departamento de Tecnologias de Informação
DCF – Departamento de Conduta Financeira
WEBSERVICE - é uma solução utilizada na integração de sistemas e na comunicação entre
aplicações diferentes.
JSON – um acrônimo de JavaScript Object Notation, é um formato compacto, de padrão aberto
independente, de troca de dados simples e rápida (parsing) entre sistemas.
REST (Representational State Transfer ) – transferência Representacional de Estado, é
um estilo de arquitetura de software que define um conjunto de restrições a serem usadas
para a criação de web services (serviços Web).

2. Informação a reportar
A informação a ser reportada ao BNA deverá ser efectuada segundo o modelo de comunicação
especificado neste documento, permitindo às Instituições Financeiras reportarem ao BNA a
informação das comissões selecionadas.
2.1. Validações implementadas
Nesta secção são apresentadas de forma genérica as validações que serão efectuadas à informação
enviada.
Validações gerais
Todos os campos dos reportes serão alvo de um conjunto de validações gerais, nomeadamente:
■ Obrigatoriedade ou não dos campos;

■ Validação de tamanho máximo permitido para o campo;
■ Validação do tipo de dados, quando esperado um número; montantes e saldos devem
separar a parte decimal com um ‘.’, etc);
■ Validação de conteúdos dos campos restritivos, com base nas Tabelas de Códigos
Auxiliares especificadas nos Anexos.
Os valores numéricos enviados nos vários reportes devem seguir as seguintes parametrizações de
formatação:
■ Devem usar o ‘ponto’ como separador decimal;

■ Não podem conter separadores de milhares;
■ Informação a Reportar.

3. Serviços
• Autenticação
Para consumo de alguns serviços descritos nesse documento é necessária uma

autenticação. A autenticação é feita mediante esquema Bearer Token.
• Volume esperado
É esperado um número por página de cerda de 100 registos de forma sequencial.
• Frequência e horário
O webservice será executado sempre que necessário para registo da informação.
• Tipo de Comunicação
o ( ) Síncrono
o (X) Assíncrono
o ( ) One Way
• Protocolo de Transporte
o HTTP/HTTPS
• Formato da Mensagem
o REST

4. Serviços de Submissão
Os serviços de submissão seguem uma interdependência lógica, sendo que, só pode ser
reportado os dados de actualização de uma determinada informação caso a mesma já tenha sido
reportada previamente.
4.1. Serviço de Autenticação
Descrição: Este serviço tem como objectivo a obtenção do token que permite a autenticação no
serviço.
Estrutura do Objecto JSON
EndPoint Rest Teste:

https://comissoesbancariastst.bna.ao/api/authenticate
EndPoint Rest Produção:

https://comissoesbancarias.bna.ao/api/authenticate
Método: POST
{
"username": "Utilizador",
"password": "Senha"
}
NOME DESCRIÇÃO PREENCH* TIPO
Username Identificador do Usuário. O String
Password Password de acesso. O String
Resposta do serviço
{
"genericResponse": {
"codigo": "0000",
"id": 115,
"nome": "BANCO TESTE",
"sigla": "BT"
},
"token": "XxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXx
XxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXx
XxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXx
XxXxXxXxXxXxXx"
}

NOME DESCRIÇÃO TIPO
codigo Código da instituição Integer
id Identificação da instituição Integer
nome Nome da instituição String
sigla Sigla da instituição String
Token Código gerado para utilização do serviço String
4.2. Submissão de comissão
Descrição: Este serviço tem como objectivo submissão das comissões de uma determinada
Instituição.

https://comissoesbancariastst.bna.ao/api/comissoes

https://comissoesbancarias.bna.ao/api/comissoes
Método: POST
{
"servicoID": "6c3y",
"baseServicoID": 1,
"periodoCobrancaID": 2,
"medidaID": 3,
"moedaID": 1,
"nomeProduto": "Cartões de crédito",
"valorMinimo": 0.87,
"Comentarios": "",
"dataEntradaVigor": "2022-10-11"
}

REGRAS A OBSERVAÇÕES
NOME DESCRIÇÃO PREENCH* TIPO OBSERVAR/LIMITE
MÁXIMO
Note Tabela de
Códigos Auxiliares
servicoID Código do serviço O String
“Anexo A –
Serviços”
Note Tabela de
Código da base do Códigos Auxiliares
baseServicoID O Integer
serviço “Anexo E –
Bases
do Serviço”
Note Tabela de
Códigos Auxiliares
Código do período
periodoCobrancaID O Integer “Anexo F –
base de cobrança Períodos de
Cobrança”
Note Tabela de
Código da medida Códigos Auxiliares
medidaID utilizada para reporte O Integer
“Anexo D –
do valor da comissão Medidas”
nomeProduto Nome do produto O String 150
Valor mínimo da 10 dígitos
valorMinimo comissão de um 10,2 numéricos, sendo
determinado serviço O Decimal
2 decimais
Note Tabela de
Códigos
moedaID Código da moeda Auxiliares
O Integer “Anexo G –
Moedas”
Comentarios Comentários adicionais
F 50
sobre a comissão String
dataEntradaVigor Data de entrada em
O "AAAA-MM-DD"
vigor da comissão Date
* O - Obrigatório; F - Facultativo; C – Condicionado
Resposta do serviço:

{
"sucess": true,
"data": {
"comissaoID": 6,
"baseServicoID": 6,
"medidaID": 3,
"moedaID": 1,
"comentarios": "",
"dataEntradaVigor": "2022-10-11T00:00:00"
}
}
comissaoID Código da comissão Integer
servicoID Código do serviço String
baseServicoID Código da base do serviço Integer
periodoCobrancaID Código do período base de cobrança Integer
medidaID Código da medida utilizada para reporte do valor da comissão Integer
nomeProduto Nome do produto String
valorMinimo Valor mínimo da comissão de um determinado serviço Decimal
moedaID Código da moeda Integer
Comentarios Comentários adicionais sobre a comissão String
dataEntradaVigor Data de entrada em vigor da comissão Date

4.3. Submissão de comissão em massa
Descrição: Este serviço tem como objectivo submissão das comissões de uma
determinada Instituição em massa, permite ao banco a submissão de todas as comissões
de uma única vez.

https://comissoesbancariastst.bna.ao/api/comissoes/range

https://comissoesbancarias.bna.ao/api/comissoes/range
Método: POST
{
"dataEntradaVigor": "2023-01-10",
"data":[
{
"servicoID": "7b2z",
"baseServicoID": 1,
"medidaID": 2,
"MoedaID": 1,
"Comentarios": ""
},
{
"baseServicoID": 1,
"medidaID": 1,
"MoedaID": 1,
"nomeProduto": "Contas de crédito",
"Comentarios": ""
}
]
}

MÁXIMO
Data de entrada em
Date "AAAA-MM-DD"
dataEntradaVigor vigor da comissão O
Note Tabela de
servicoID Código do serviço Códigos Auxiliares
O String “Anexo A –
Serviços”
Note Tabela de
Bases
do Serviço”
Note Tabela de
Códigos Auxiliares
periodoCobrancaID Código do período
O Integer “Anexo F –
base de cobrança Períodos de
Cobrança”
Código da medida Note Tabela de
utilizada para Códigos Auxiliares
medidaID O Integer
reporte do valor da “Anexo D –
comissão Medidas”
Note Tabela de
Códigos Auxiliares
moedaID Código da moeda O Integer
“Anexo G –
Moedas”
numéricos, sendo 2
valorMinimo comissão de um O Decimal
10,2 decimais
determinado serviço
Comentarios Comentários
adicionais sobre a F String 50
comissão
{
"sucess": true,
"data": [
{
"comissaoID": 3401,
"baseServicoID": 1,
"medidaID": 2,
"moedaID": 1,
"comentarios": null,

},
{
"comissaoID": 3402,
"baseServicoID": 1,
"medidaID": 1,
"moedaID": 1,
"nomeProduto": "Contas de crédito",
"valorMinimo": 3050,
"comentarios": null,
}
]
}
4.4. Eliminar Comissão
Descrição: Este serviço tem como objectivo a eliminação de uma comissão submetida.
Parâmetros de Entrada

Id Identificador da comissão O Int

https://comissoesbancariastst.bna.ao/api/comissoes/delete/{Id}

https://comissoesbancarias.bna.ao/api/comissoes/delete/{Id}
Método: DELETE
{
"sucess": true,
}

4.5. Actualizar Comissão
Descrição: Este serviço tem como objectivo actualização dos dados de comissões
previamente submetidas.

Id Identificador da comissão O Int

https://comissoesbancariastst.bna.ao/api/comissoes/{Id}

https://comissoesbancarias.bna.ao/api/comissoes/{Id}
Método: PUT
{
"servicoID": "8a1x",
"baseServicoID": 1,
"medidaID": 1,
"MoedaID": 1,
"nomeProduto": "Contas bancárias",
"Comentarios": "Equiv.",
"dataEntradaVigor": "2022-11-14"
}

MÁXIMO
Note Tabela de
Códigos Auxiliares
servicoID Código do serviço O String “Anexo A –
Serviços”
Note Tabela de
Bases
do Serviço”
Note Tabela de
Códigos Auxiliares
Código do período base
periodoCobrancaID
de cobrança
O Integer “Anexo F –
Períodos de
Cobrança”
Note Tabela de
Código da medida Códigos Auxiliares
medidaID utilizada para reporte O Integer
do valor da comissão
“Anexo D –
Medidas”

valorMinimo comissão de um 10,2 numéricos, sendo
O Decimal 2 decimais
determinado serviço
Note Tabela de
Códigos Auxiliares
moedaID Código da moeda “Anexo G –
O Integer
Moedas”
Comentarios Comentários adicionais

F String 50
sobre a comissão
dataEntradaVigor Data de entrada em
O Date "AAAA-MM-DD"
vigor da comissão
{
"sucess": true,
"data": {
"comissaoID": 3402,
"baseServicoID": 1,
"medidaID": 1,
"moedaID": 1,
"nomeProduto": "Contas bancárias",
"comentarios": "Equiv.",
}
}

5. Serviços de Listagem e Pesquisa
Os serviços de listagem e pesquisa apresentam no máximo 39 registos, que corresponde a uma
página. Caso haja necessidade de listar a próxima página, deverá ser utilizado os parâmetros
opcionais skip e take. Assim sendo, se o parâmetro skip for preenchido com o valor 10 o serviço
vai saltar os 10 primeiros registos e apresentar a partir do 11º até ao 49º registo. Se adicionar o
parâmetro take e defini-lo com o valor 60, o serviço irá saltar 10 registos e retornar os próximos
60 registos.

skip quantidade de registos a saltar F Int
take quantidade de registos a apresentar F Int
5.1. Consultar Comissões
Descrição: Este serviço tem como objectivo listar todas as comissões já submetidos. Também há a
possibilidade de consulta única, utilizando o id da comissão como parâmetro.
NOME DESCRIÇÃO PREENCH* TIPO OBS

Trata-se de um parâmetro da URL,
Id Identificador da comissão F Int permite efectuar pesquisa pelo código
da comissão
Permite efectuar pesquisa pelo
servicoId Identificador do serviço F String
código do serviço
Pesquisa pela data de entrada em
dataEntradaVigor Data de entrada em vigor F Date
vigor “AAAA-MM-DD”
https://comissoesbancariastst.bna.ao/api/comissoes
https://comissoesbancariastst.bna.ao/pi/comissoes/{id}
https://comissoesbancariastst.bna.ao/api/comissoes?servicoId={servicoId}&dataEntradaVigor={dataEntradaVigor}
https://comissoesbancarias.bna.ao/api/comissoes
https://comissoesbancarias.bna.ao/api/comissoes/{id}
https://comissoesbancarias.bna.ao/api/comissoes?servicoId={servicoId}&dataEntradaVigor={dataEntradaVigor}

Método: GET
{
"sucess": true,
"data": [
{
"comissaoID": 1,
"servico": "Manutenção de conta com gestor dedicado",
"baseServico": "Pontual",
"periodoCobranca": "Mensal",
"valorMinimo":
456.87, "medida":
"Montante",
"moeda": "USD",
"comentarios": "",
"descricao": "Todos os encargos bancários suportados para
que…", "dataEntradaVigor": "2022-12-11T00:00:00"
}
]
}

comissaoID Código da comissão Integer
servicoID Código do serviço String
servico Nome do serviço bancário String
baseServico Base do serviço String
periodoCobranca Período base de cobrança String
nomeProduto Nome do produto String
valorMinimo Valor mínimo da comissão de um determinado serviço Decimal
medida Descrição da medida String
moeda Descrição da moeda String
Comentarios Comentários adicionais sobre a comissão String
descricao Descrição do serviço String
dataEntradaVigor Data de entrada em vigor da comissão Date
5.2. Total de comissões
Descrição: Este serviço tem como objectivo apresentar o total de comissões de serviços registadas.


https://comissoesbancariastst.bna.ao/api/comissoes/total

https://comissoesbancarias.bna.ao/api/comissoes/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 1
}
]
}
5.3. Consultar Bases
Descrição: Este serviço tem como objectivo listar as bases definidas para os serviços.

Id Identificador da base F Int Trata-se de um parâmetro da URL, permite
efectuar pesquisa pelo código da base
https://comissoesbancariastst.bna.ao/api/baseServicos
https://comissoesbancariastst.bna.ao/api/baseServicos/{Id}
https://comissoesbancarias.bna.ao/api/baseServicos
https://comissoesbancarias.bna.ao/api/baseServicos/{Id}
Método: GET

{
"sucess": true,
"data": [
{
"baseServicoID": 1,
"nome": "Pontual"
}
…
]
}

baseServicoID Código da base do serviço Integer
nome Descrição da base do serviço String
5.4. Total base de serviços

Descrição: Este serviço tem como objectivo apresentar o total de bases de serviços registadas.

https://comissoesbancariastst.bna.ao/api/baseServicos/total

https://comissoesbancarias.bna.ao/api/baseServicos/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 5
}
]
}

5.5. Consultar Periodos de Cobranças
Descrição: Esse serviço tem como objectivo listar os períodos de cobranças de determinados
serviços.

Identificador do período
Id F Int permite efectuar pesquisa pelo código
de cobrança
do período de cobrança.
https://comissoesbancariastst.bna.ao/api/periodosCobrancas
https://comissoesbancariastst.bna.ao/api/periodosCobrancas/{Id}
https://comissoesbancarias.bna.ao/api/periodosCobrancas
https://comissoesbancarias.bna.ao/api/periodosCobrancas/{Id}
Método: GET
{
"sucess": true,
"data": [
{
"nome": "Trimestral"
}
…
]
}
NOME DESCRIÇÃO PREENCH*

periodosCobrancasID Identificador do período de cobrança Integer
nome Descrição do período de cobrança String
5.6. Total Período de Cobrança

Descrição: Este serviço tem como objectivo apresentar o total de períodos de cobrança registados.


https://comissoesbancariastst.bna.ao/api/periodosCobrancas/total

https://comissoesbancarias.bna.ao/api/periodosCobrancas/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 6
}
]
}
5.7. Consultar Produtos
Descrição: Esse serviço tem como objectivo listar todos os produtos e os serviços associados aos
mesmos.

Id Identificador do produto F Int permite efectuar pesquisa pelo código
do produto.
https://comissoesbancariastst.bna.ao/api/produtos
https://comissoesbancariastst.bna.ao/api/produtos/{Id}
https://comissoesbancarias.bna.ao/api/produtos
https://comissoesbancarias.bna.ao/api/produtos/{Id}

Método: GET
{
"sucess":
true,
"data": [
{
"produtoID": 1,
"tipoProdutoID": 1,
"nome": "Depósito à
Ordem", "servicos": [
{
"nome": "Manutenção de conta com gestor dedicado",
"descricao": "Todos os encargos bancários suportados para que
a
conta esteja activa e operacional."
},
{
"nome": "Levantamento de Númerário em MN no balcão",
"descricao": "Levantamento de numerário disponível na conta
ào
rdem na agência em moeda nacional no balcão."
},
{
"nome": "Levantamento de Númerário em ME no balcão",
"descricao": "Levantamento de numerário disponível na conta
ào
rdem na agência em moeda estrangeira no balcão."
},
{
"servicoID": "5d4w",
"nome": "Emissão de extracto (2ª via)",
"descricao": "Emissão da listagem dos movimentos realizados na
conta durante o período solicitado"
}
]
}
]
}

produtoID Código do produto Integer
tipoProdutoID Codigo do tipo de produto Integer
nome Nome do produto String
servicosID Codigo do serviço String
nome Nome do serviço String
5.8. Total de produtos
Descrição: Este serviço tem como objectivo apresentar o total de produtos registados.

https://comissoesbancariastst.bna.ao/api/produtos/total

https://comissoesbancarias.bna.ao/api/produtos/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 11
}
]
}
5.9. Consultar Serviços
Descrição: Esse serviço tem como objectivo listar todos os serviços definidos.

Id Identificador do serviço F Int permite efectuar pesquisa pelo
código do serviço.
https://comissoesbancariastst.bna.ao/api/servicos
https://comissoesbancariastst.bna.ao/api/servicos/{Id}
https://comissoesbancarias.bna.ao/api/servicos
https://comissoesbancarias.bna.ao/api/servicos/{Id}
Método: GET
{
"sucess": true,
"data": [
{
"produtoID": 1,
"nome": "Levantamento de Númerário em ME no balcão",
"descricao": "Levantamento de numerário disponível na conta à ordem
na agência em moeda estrangeira no balcão."
}
…
]
}

servicosID Código do serviço String
nome Nome do serviço String
5.10. Total de serviços
Descrição: Este serviço tem como objectivo apresentar o total de produtos registados.


https://comissoesbancariastst.bna.ao/api/servicos/total

https://comissoesbancarias.bna.ao/api/servicos/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 30
}
]
}
5.11. Consultar Tipos de produtos
Descrição: Esse serviço tem como objectivo apresentar os tipos de produtos.
Identificador do Trata-se de um parâmetro da URL,

Id F Int permite efectuar pesquisa pelo
tipo de produto
código do tipo de produto.
EndPoint Rest Teste: https://comissoesbancariastst.bna.ao/api/tiposProdutos

https://comissoesbancariastst.bna.ao/api/tiposProdutos/{Id}
EndPoint Rest Produção: https://comissoesbancarias.bna.ao/api/tiposProdutos

https://comissoesbancarias.bna.ao/api/tiposProdutos/{Id}
Método: GET

{
"sucess":
true,
"data": [
{
"tipoProdutoID"
: 2, "nome":
"Cartões",
"produtos": [
{
"produtoID": 2,
"nome": "Cartões de Crédito"
},
{
"produtoID": 3,
"nome": "Cartões de Débito"
},
{
"produtoID": 4,
"nome": "Cartões Pré-pago"
},
{
"produtoID": 5,
"nome": "Operações com Cartões"
}
]
}
]
}

tipoProdutoID Código do tipo de produto Integer
nome Nome do tipo de produto String
nome Nome do produto String
5.12. Total Tipos de Produtos
Descrição: Este serviço tem como objectivo apresentar o total de tipo de produtos registados.

https://comissoesbancariastst.bna.ao/api/tiposProdutos/total

https://comissoesbancarias.bna.ao/api/tiposProdutos/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 20
}
]
}
5.13. Consultar Medidas
Descrição: Esse serviço tem como objectivo listar todas as medidas definidas.

Id Identificador da medida F Int permite efectuar pesquisa pelo
código da medida.
https://comissoesbancariastst.bna.ao/api/medidas
https://comissoesbancariastst.bna.ao/api/medidas/{Id}
https://comissoesbancarias.bna.ao/api/medidas
https://comissoesbancarias.bna.ao/api/medidas/{Id}
Método: GET

{
"sucess": true,
"data": [
{
"medidaID": 2,
"nome": "USD"
}
…
]
}

medidaID Código da medida Integer
nome Nome da medida String
5.14. Total Medidas
Descrição: Este serviço tem como objectivo apresentar o total de medidas registadas.

https://comissoesbancariastst.bna.ao/api/medidas/total

https://comissoesbancarias.bna.ao/api/medidas/total
Método: GET
{
"sucess": true,
"data": [
{
"total": 20
}
]
}

Anexo 1 – Tabelas de Códigos Auxiliares
Anexo A – Serviços
# Código Descrição OBS
1 8a1x Manutenção de conta com gestor dedicado
2 7b2z Levantamento de Númerário em MN no balcão
3 6c3y Levantamento de Númerário em ME no balcão
4 5d4w Emissão de extracto (2ª via)
5 4e5v Anuidade 1.º Ano 1.º Titular
6 3f6u Anuidade 1.º Ano Outros Titulares
7 2g7t Emissão de cartão
8 1h8s Substituição de cartão
9 0i9r Anuidade 1.º Ano 1.º Titular
10 9c2y Anuidade 1.º Ano Outros Titulares
11 8d3z Emissão de cartão
12 7e4w Substituição de cartão
13 6f5v Anuidade 1.º Ano 1.º Titular
14 5g6u Anuidade 1.º Ano Outros Titulares
15 4h7t Emissão de cartão
16 3i8s Substituição de cartão
17 2j9r Carregamento
1k0o Levantamento à Crédito - 'Cash advance' ATM - Fora do País/
18
Cartões de Crédito
0g2z Levantamento à Crédito - 'Cash advance' ATM - Fora do País/
19
Cartões Pré-pago
20 9h3y Compras TPA - Fora do Pais/ Cartões de Crédito
21 8i4w Compras TPA - Fora do Pais/ Cartões Pré-pago
22 7j5v Intrabancárias Titular diferente: Pontuais no balcão
23 6k6u Interbancárias via SPTR - Pontuais
24 5l7t Interbancárias via STC - Pontuais
25 4m8s Interbancárias/ Pedido de Cancelamento
26 3n9r Interbancárias/Pedido de Devolução de transferência
27 2o0o Venda de Divisas
28 1i2y Emissão de OPE
29 0j3z Despesas Totais incluindo de Expediente, Correspondente e
Comunicação
30 9k4w Devolução por Erro do Ordenante/ Anulação/ Stop Payment
31 8l5v Vendas de Notas Estrangeiras
32 7m6u Declaração de Capacidade Financeira
33 6n7t Declaração de Idoneidade

Anexo B – Tipos de Produtos
Código Descrição OBS

1 Contas de depósito
2 Cartões
3 Transferências
4 Prestação de Serviço
5 Outros serviços
Anexo C – Produtos

1 Depósito à Ordem
2 Cartões de Crédito
3 Cartões de Débito
4 Cartões Pré-pago
5 Operações com Cartões
6 Transferências em Kwanzas
7 Transferência em ME
8 Compra e Venda de Notas Estrangeiras
9 Outros serviços
Anexo D – Medidas

1 AOA
2 USD
3 EUR
4 RAND
5 JPY
6 CNY
7 %
8 N/A
Anexo E – Bases do Serviço

1 Pontual
2 Mensal

3 Trimestral
4 Semestral
5 Anual
6 N/A
Anexo F – Períodos de Cobrança

1 Pontual
2 Mensal
3 Trimestral
4 Semestral
5 Anual
6 Permanente
7 N/A
Anexo 2 – Mensagens de Erro
StatusCode StatusText Error

404 "NotFound" "Utilizador ou senha inválidos"
400 "Bad request" "Parâmetros em falta, mínimo um serviço deve ser informado."
404 "NotFound" "O recurso pedido não foi encontrado."
400 "Bad request" O Campo {nome_campo} é obrigatório
400 "Bad request" Valor de referência {nome_campo} fora do intervalo permitido
400 "Bad request" Data de entrada em vigor inferior a data actual.
400 "Bad request" Já existe uma comissão para este serviço. {nº_serviço}
400 "Bad request" Já existe uma comissão para este serviço. {DataEntradaVigor}
Serviço duplicado no lote actual. ServicoID:{ServicoID}, DataEntradaVigor
400 "Bad request"
: {dataEntradaVigor}
400 "Bad request" "{nome_campo} – tipo de dado ou formato inválido."

Anexo 3 – Próximos passos
DATA REALIZAÇÃO
Nº. ACTIVIDADES RESPONSÁVEL OBJECTIVO
Envio da
1 Entrada em produção BNA e Bancos informação em A anunciar
Comerciais ambiente de posteriormente
produção

Manual de Especificação Técnica Webservice - Comparador de Comissões

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual de Especificação Técnica Webservice - Comparador de Comissões

Enviado por

Direitos autorais:

Formatos disponíveis

ANEXO II

BANCO NACIONAL DE ANGOLA

Manual de Especificação Técnica

Mecanismo de Reporte no âmbito do comparador

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 5 de 36

1.2. Glossário e acrónimos .............................................................................................................. 5

2. INFORMAÇÃO A REPORTAR ................................................................................................... 6

4.2. Submissão de comissão ............................................................................................................ 9

4.3. Submissão de comissão em massa .......................................................................................... 12

4.4. Eliminar Comissão .................................................................................................................. 14

4.5. Actualizar Comissão ............................................................................................................... 15

5. SERVIÇOS DE LISTAGEM E PESQUISA .................................................................................. 17

5.2. Total de comissões ................................................................................................................ 18

5.3. Consultar Bases ..................................................................................................................... 19

5.4. Total base de serviços ............................................................................................................ 20

5.5. Consultar Periodos de Cobranças ............................................................................................ 21

5.6. Total Período de Cobrança ...................................................................................................... 21

5.7. Consultar Produtos ................................................................................................................. 22

5.8. Total de produtos .................................................................................................................. 24

5.9. Consultar Serviços ................................................................................................................. 24

5.10. Total de serviços .................................................................................................................. 25

5.11. Consultar Tipos de produtos .................................................................................................. 26

5.12. Total Tipos de Produtos ........................................................................................................ 27

5.13. Consultar Medidas ................................................................................................................ 28

5.14. Total Medidas ...................................................................................................................... 29

Anexo 1 – Tabelas de Códigos Auxiliares .........................................................................30

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 6 de 36

VERSÃO DATA OBSERVAÇÕES

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 7 de 36

1.1. Âmbito do Documento

1.2. Glossário e acrónimos

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 8 de 36

2.1. Validações implementadas

■ Obrigatoriedade ou não dos campos;

■ Devem usar o ‘ponto’ como separador decimal;

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 9 de 36

Para consumo de alguns serviços descritos nesse documento é necessária uma

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 10 de 36

4.1. Serviço de Autenticação

Estrutura do Objecto JSON

EndPoint Rest Teste:

EndPoint Rest Produção:

Password Password de acesso. O String

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 11 de 36

id Identificação da instituição Integer

nome Nome da instituição String

sigla Sigla da instituição String

Token Código gerado para utilização do serviço String

4.2. Submissão de comissão

Estrutura do Objecto JSON

EndPoint Rest Teste:

EndPoint Rest Produção:

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 12 de 36

* O - Obrigatório; F - Facultativo; C – Condicionado

CONTINUAÇÃO DO INSTRUTIVO N.º 17/2023 Página 13 de 36

NOME DESCRIÇÃO TIPO

comissaoID Código da comissão Integer

servicoID Código do serviço String

baseServicoID Código da base do serviço Integer

periodoCobrancaID Código do período base de cobrança Integer

medidaID Código da medida utilizada para reporte do valor da comissão Integer

nomeProduto Nome do produto String

valorMinimo Valor mínimo da comissão de um determinado serviço Decimal

moedaID Código da moeda Integer