Este item do documento apresenta o AuthSnet, protocolo de autenticação usado para acessar os recursos privados (protected resource) da ServiceNet.

Transcrição

1 API Pagamento v Autenticação Introdução Este item do documento apresenta o AuthSnet, protocolo de autenticação usado para acessar os recursos privados (protected resource) da ServiceNet. A autenticação deve ser aplicada em clientes confiáveis, o IP associado ao grant é avaliado durante a concessão do token. Todas as mensagens trocadas nas etapas abaixo seguem o padrão REST (HTTP + JSON). No response, SEMPRE retornará um JSON, com pelo menos os campos codresposta e mensagem. Exemplos: "codresposta":"n10","mensagem":"sessão Expirada" "codresposta":"000","mensagem":"" Hosts do serviço de autenticação: - Homologação: - Produção: Etapas Previamente deve-se contactar a ServiceNet para obter seu grant e idclient, informe também a lista de IP's que devem ser liberados. A) Nessa etapa a aplicação do cliente solicita o token de acesso (accesstoken). Método: POST URL: /auth/simple/getaccesstoken Header HTTP: Authorization: AuthSnet grant="i1wsr354tgfdb1",

2 B) O servidor de autorização valida a requisição do cliente e em seguida cria uma sessão de acesso aos recursos privados, e finalmente retorna o accesstoken da sessão criada. "codresposta":"000", "mensagem":"", "accesstoken":"04858b4a966f f9", "expiraem":3600 accesstoken: Token da sessão que deverá ser enviado no header Authorization nas requisições da API expiraem: Tempo em segundos que esse token irá expirar 2 - Transações Requisições sempre via POST com o header Authorization. Os campos de valores devem ser enviados sem pontuações. Os últimos dois digitos representam as casas decimais. Por exemplo um valor de 200,50 deve ser enviado Hosts do serviço de pagamento: - Homologação: - Produção: Pagamento Titulo URL: /arrecada/titulo/ Header Authorization: AuthSnet accesstoken="04858b4a966f f9" "cb": " ", "formapagamento": 1, "infocheque": "32132", "vencimento": , "valordesconto": 0, "valornominal": 12900, "valortotal": 12900,

3 cb: Código de barras da conta para pagamento. Enviar apenas números formapagamento: 1 = Dinheiro - 2 = Cheque infochege: Informação do cheque vencimento": Data de vencimento no formato %Y%m%d valordesconto: Valor do desconto valornominal: Valor nominal do boleto valortotal: Valor total do boleto já abatendo o desconto ou acréscimos "idtransbd": , "mensagem": "TITULO AUTENTICADO" "tamblocoscupom": 38, "cupom": " COBAN:67212 LOJA:0021 PDV: /06/2017 BANCO DO BRASIL 15:20: CORRESPONDENTE BANCARIO 0343 COMPROVANTE DE PAGAMENTO DE TITULOS ======================================BANCO SAFRA S.A NR. DOCUMENTO DATA DO PAGAMENTO 16/06/2017VLR DOCUMENTO 5,00VALOR COBRADO 5,00======================================NR.AUTENTICACAO E.B9F.B00.DA B" idtransbd: ID único da transação mensagem: Mensagem auxiliar tamblocoscupom: Tamanho de colunas do cupom cupom: Comprovante da transação 2.2 Pagamento Convenio URL: /arrecada/convenio/ Header Authorization: AuthSnet accesstoken="04858b4a966f f9", "cb": " ", "formapagamento": 1, "infocheque": "32132", "valornominal": 12900,

4 cb: CB da conta para pagamento. Enviar apenas números formapagamento: 1 = DINHEIRO - 2 = CHEQUE infocheque: Informações do cheque valornominal: Valor da conta "idtransbd": , "mensagem": "CONVENIO AUTENTICADO", "tamblocoscupom": 38, "cupom":" COBAN:38034 LOJA:0001 PDV: /06/2017 BANCO DO BRASIL 16:14: CORRESPONDENTE BANCARIO 0020 COMPROVANTE PAGAMENTOS COM COD.BARRA ======================================CONVENIO: DAS - SIMPLES NACIONAL NR. DOCUMENTO NR. CONVENIO DATA DO PAGAMENTO 15/06/2017VLR DO PAGAMENTO 0,00======================================NR.AUTENTICACAO D.DA2.0F4.743" idtransbd: ID único da transação mensagem: Mensagem auxiliar tamblocoscupom: Tamanho de colunas do cupom cupom: Comprovante da transação 2.3 Situação URL: /arrecada/situacao/ Header Authorization: AuthSnet accesstoken="04858b4a966f f9", "cb": " ", "valor": 100, "subtipo": 1, cb: CB da conta para consulta. Enviar apenas números valor: Valor da conta

5 subtipo: Tipo da transação: 1 - Título 2 - Convênio "situacao": 1 situacao: 1 - EFETIVADA, 2 - CANCELADA, 3 - NAO LOCALIZADA, -1 - DESCONHECIDA 2.4 Estorno URL: /arrecada/estorno/ Header Authorization: AuthSnet accesstoken="04858b4a966f f9" "cb": " ", "valor": 20050, "subtipo": 1, cb: CB da conta para consulta. Enviar apenas números valor: Valor da conta subtipo: Tipo da transação: 1 - Título 2 - Convênio "tamblocoscupom": 38, "mensagem": "TITULO ESTORNADO", "cupom": " COBAN: LOJA: 92 PDV: 9200 CORRESPONDENTE BANCARIO COMPROVANTE DE ESTORNO ======================================CEDENTE: CAIXA ECONOMICA FEDERAL ====================================== DATA DO PAGAMENTO: 14/06/2017 VALOR PAGAMENTO..: 60,00 VALOR DOCUMENTO..: 60,00 DESCONTO/ABATIM..: 0,00 VALOR COBRADO...: 60,00 ======================================NR.AUTENTICACAO 3113E4C "

6 mensagem: Mensagem auxiliar tamblocoscupom: Tamanho de colunas do cupom cupom: Comprovante da transação de estorno 2.5 Erros: Em caso de erro na requisição a resposta estará no seguinte padrão: "resource": "", "code": "", "message": "" resource: Nome do recurso code: Código do erro. Reservado para uso futuro message: Mensagem do erro Tabela de erros: "JSON inválido": JSON com a sintaxe inválida "Token ausente": Campo accesstoken faltando no header Authorization "Erro ao decodificar header": Header Authorization inválido "CB inválido": CB enviado errado. Tamanho do CB deve ser 44 caracteres e apenas números "Valor total inválido": O valor deve ser maior que 0 "Falha no upstream": Contate a ServiceNet para verificar o problema "Subtipo inválido": Campo subtipo inválido no request. Verifique os valores válidos "ID Terminal inválido": O ID do terminal deve maior que 0 "Forma de pagamento inválida": Verifique a forma de pagamento "Valor nominal inválido": O valor deve ser maior que 0 "Z": Toda mensagem de erro que inicia com Z é retorno do BB "Vencimento inválido": Verifique se a data está no formato correto "Sessão expirada": Sessão expirada. Obtenha um novo token no serviço de autenticação "Problema na autenticação": Verifique se o accesstoken está correto "Sem terminal configurado": Contate a arrecadadora para verificar as configurações do terminal "Falha ao obter dados de estorno": Contate a ServiceNet para verificar o problema "Conta não localizada": Verifique se o código de barras e valor da conta estão corretos "ESTORNO N AUT": Verifique com a arrecadadora o limite de estornos diários configurado para o terminal "CTA JA AUTORIZAD": A conta já foi estornada "Falha ao abrir terminal": Contate a arrecadadora para verificar as configurações do terminal