Produtos

A API oferece uma interface para cadastro e gerenciamento dos parâmetros dos produtos oferecidos pelo emissor através das processadoras parceiras.

Figura 1. Diagrama geral de funcionamento da API Produtos

Os parâmetros dos serviços são personalizados para atender as necessidades do emissor, oferecendo total controle e autonomia para que o negócio esteja alinhado com o sucesso do cliente.

Os produtos englobam todo e qualquer serviço oferecido aos clientes como criação e gerenciamento de cartões assim como serviços de SMS.

Endpoints

Todos os endpoints da API Produtos utilizam URL base /api/v1/produtos/.

Tipo	Endpoint	Documentação	Descrição
`GET`	`/api/v1/produtos`	Consultar produtos	Visualiza todos os produtos disponíveis cadastrados na base do emissor.
`GET`	`/api/v1/produtos/{idProduto}`	Consultar um produto	Visualiza as informações relacionadas a um produto cadastrado na base do emissor.

Serviços financeiros

Tipo	Endpoint	Documentação	Descrição
`GET`	`/api/v1/produtos/servicos-financeiros`	Listar serviços financeiros	Visualiza os serviços financeiros disponíveis cadastrados na base do emissor.

Casos de uso

Consultando um produto cadastrado

Utilize o endpoint get /api/v1/produtos/{idProduto} para visualizar as informações cadastradas para um produto através do identificador:

Exemplo de request body utilizando o idProduto:

 {  
"idProduto": 2001
 }

Response body retornando todas informações cadastradas para o produto:

{
 {
 "id": 2001,
 "descricao": "PRODUTO PADRAO 2001",
 "isProdutoDigital": "S",
 "encargos": {
   "cobrarMulta": true,
   "multa": 2,
   "regraCalculoMulta": "S",
   "ignorarMultaAnterior": false,
   "ignorarSaldoRolado": false,
   "mora": 1,
   "regraCalculoMora": "S",
   "jurosRotativo": 19.99,
   "realizarEstornoJurosPagamento": true
 },
 "isProdutoBandeirado": "S",
 "limiteExtra": {
   "habilitarClientesNovos": true,
   "valorPadrao": 0,
   "percentualPadrao": 0
 },
 "overlimit": {
   "percentualSobreUso": 15,
   "permitePercentualSobreUso": true,
   "permiteRepetirMesmoCiclo": false,
   "permiteTaxaSobreUso": true,
   "taxaSobreUso": 22.22
 }
}
}

Visualizar serviços financeiros

O endpoint get /api/v1/produtos/servicos-financeiros permite a visualização das informações sobre os serviços financeiros cadastrados na sua base de dados utilizando seu identificador.

Exemplo de request body utilizando o id:

 {  
"id": 2001
 }

Response body retornando todas informações do serviço financeiro:

[
 {
   "id": 2001,
   "descricao": "SAQUE",
   "status": "A",
   "porcentagemDeLimite": 30,
   "tarifaServicoSaque": "N",
   "tarifaCac": "N",
   "taxaJurosSaque": 9,
   "rolarEntradaSaque": 0,
   "parcelamentoMaximoSaque": 1,
   "valorMinimoSaque": 1,
   "valorMaximoSaque": 100000,
   "validarSaldoLimitePadrao": "N",
   "produtosServicoPadrao": [
     {
       "idProduto": 1,
       "status": "A",
       "descricao": "PRODUTO PADRAO 1"
     }
   ]
 }
]