Web service Com.senior.g5.co.int.varejo.RecebimentosTef
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_int_varejo_RecebimentosTef?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_RecebimentosTef?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_RecebimentosTef?wsdl
Porta
Integrações - Varejo - Recebimentos Tef - Importar Movimentos
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 3
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Importar_3> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <recebimentos> <ideExt>Integer</ideExt> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <tipRec>Integer</tipRec> <tipOpr>String</tipOpr> <datOpr>String</datOpr> <horOpr>String</horOpr> <codRep>Integer</codRep> <codEqu>Integer</codEqu> <numNro>Integer</numNro> <numCoo>Integer</numCoo> <codCpv>String</codCpv> <nsuTef>String</nsuTef> <codCli>Integer</codCli> <codBan>String</codBan> <recCan>Integer</recCan> <numPdv>String</numPdv> <itens> <seqIte>Integer</seqIte> <ideExt>Integer</ideExt> <codBar>String</codBar> <datVct>String</datVct> <vlrBrt>Double</vlrBrt> <vlrMor>Double</vlrMor> <vlrMul>Double</vlrMul> <vlrAcr>Double</vlrAcr> <vlrDsc>Double</vlrDsc> <vlrLiq>Double</vlrLiq> <codOte>Integer</codOte> <codFot>Integer</codFot> <numTel>String</numTel> <prdTef>String</prdTef> <opeTef>String</opeTef> <codCpv>String</codCpv> <nsuTef>String</nsuTef> </itens> <dadosTef> <chvTef>String</chvTef> <vlrChv>String</vlrChv> </dadosTef> <pagamento> <seqPar>Integer</seqPar> <codFpg>Integer</codFpg> <vctPar>String</vctPar> <vlrPar>Double</vlrPar> <catTef>String</catTef> <catExt>String</catExt> <nsuTef>String</nsuTef> <dscNeg>Double</dscNeg> <cheBan>String</cheBan> <cheAge>String</cheAge> <cheCta>String</cheCta> <cheNum>String</cheNum> <codBar>String</codBar> <codSac>String</codSac> <fpgTro>Integer</fpgTro> <vlrTro>Double</vlrTro> <codOpe>Integer</codOpe> </pagamento> </recebimentos> <sistemaIntegracao>String</sistemaIntegracao> </parameters> </ser:Importar_3> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
recebimentos | Opcional | Set | Dados referentes à operação de recebimento (Correspondente Bancário ou Recarga de Celular). |
recebimentos.ideExt | Obrigatório | Integer | Number(015) - Identificador Externo. Identificador utilizado para vincular o registro de recebimento e o retorno do seu processamento. |
recebimentos.codEmp | Obrigatório | Integer | Number(004) - Código da empresa. |
recebimentos.codFil | Obrigatório | Integer | Number(005) - Código da filial. |
recebimentos.tipRec | Obrigatório | Integer | Number(001) - Indicativo do tipo de recebimento do Varejo. Lista: 1=Correspondente Bancário e 2=Recarga de Celular. Referente ao cancelamento, o mesmo é válido somente para correspondente bancário. Não há cancelamento para recarga de celular. |
recebimentos.tipOpr | Obrigatório | String | String(001) - Indicativo do tipo de operação (recebimento ou cancelamento) Lista: C=Cancelamento, R=Recebimento. |
recebimentos.datOpr | Obrigatório | DateTime | Date(DD/MM/YYYY) - Data em que foi efetuada a operação de recebimento/cancelamento. |
recebimentos.horOpr | Opcional | String | Time(HH:MM) - Hora em que foi efetuada a operação de recebimento/cancelamento. |
recebimentos.codRep | Obrigatório | Integer | Number(009) - Código do Representante que efetuou a operação. |
recebimentos.codEqu | Obrigatório | Integer | Number(003) - Código do equipamento fiscal. Campo OPCIONAL se NumPdv for informado. |
recebimentos.numNro | Obrigatório | Integer | Number(009) - Nr.Reinicio Operação na ECF. Campo OPCIONAL se NumPdv for informado. |
recebimentos.numCoo | Obrigatório | Integer | Number(009) - Contador da Ordem de Operação que emitiu o recebimento na ECF. Campo OPCIONAL se NumPdv for informado. |
recebimentos.codCpv | Opcional | String | String(040) - Código do comprovante da operação de recebimento. |
recebimentos.nsuTef | Opcional | String | String(100) - Número sequencial único da transação TEF (Host - Operadora). |
recebimentos.codCli | Opcional | Integer | Number(009) - Código do cliente. |
recebimentos.codBan | Opcional | String | String(003) - Código do banco na Febraban (Obrigatório quando TipRec = 1). |
recebimentos.recCan | Opcional | Integer | Number(009) - Sequência do Recebimento que foi cancelada (obrigatório para operação de cancelamento). |
recebimentos.numPdv | Opcional | String | Number(003) - Número do PDV. |
recebimentos.itens | Opcional | Set | Itens recebidos na operação. |
itens.seqIte | Opcional | Integer | Number(002) - Sequência do Item (Campo descontinuado). |
itens.ideExt | Obrigatório | Integer | Number(015) - Identificador Externo. |
itens.codBar | Opcional | String | String(030) - Código de barras do documento pago pelo cliente (Obrigatório quando TipRec = 1). |
itens.datVct | Opcional | DateTime | Date(DD/MM/YYYY) - Data de vencimento do documento (Obrigatório quando TipRec = 1). |
itens.vlrBrt | Opcional | Double | Number(008,2) - Valor Bruto do documento (Obrigatório quando TipRec = 1). |
itens.vlrMor | Opcional | Double | Number(008,2) - Valor de juros de mora aplicado no documento. |
itens.vlrMul | Opcional | Double | Number(008,2) - Valor de multa aplicado no documento. |
itens.vlrAcr | Opcional | Double | Number(008,2) - Valor de outros acréscimos do documento. |
itens.vlrDsc | Opcional | Double | Number(008,2) - Valor de desconto aplicado no documento. |
itens.vlrLiq | Opcional | Double | Number(008,2) - Valor líquido recebido do cliente ou pago ao cliente (quando cancelamento) - (Obrigatório quando TipRec = 1). |
itens.codOte | Opcional | Integer | Number(004) - Código da operadora de telefonia (Obrigatório quando TipRec = 2). |
itens.codFot | Opcional | Integer | Number(003) - Sequência da filial de operadora de telefonia (Obrigatório quando TipRec = 2). |
itens.numTel | Opcional | String | String(020) - Número do Telefone para o qual foi feita recarga(Obrigatório quando TipRec = 2). |
itens.prdTef | Opcional | String | String(005) - Código do produto retornado pelo Tef (Obrigatório quando TipRec = 1). |
itens.opeTef | Opcional | String | String(020) - Operadora identificada pelo TEF. Observação: quando informado, desconsidera o CodOte e CodFot informados. |
itens.codCpv | Opcional | String | String(040) - Comprovante. |
itens.nsuTef | Opcional | String | String(100) - Número da Transação (TEF). |
recebimentos.dadosTef | Opcional | Set | Dados da operação TEF. |
dadosTef.chvTef | Opcional | String | String(030) - Código da chave do sistema TEF. |
dadosTef.vlrChv | Opcional | String | String(255) - Valor da Chave do sistema TEF. |
recebimentos.pagamento | Opcional | Set | Utilizado para informar como o cliente efetuou o pagamento. |
pagamento.seqPar | Obrigatório | Integer | Number(002) - Número da parcela. |
pagamento.codFpg | Obrigatório | Integer | Number(002) - Código da forma de pagamento. |
pagamento.vctPar | Obrigatório | DateTime | Date(DD/MM/YYYY) - Data de vencimento da parcela. |
pagamento.vlrPar | Obrigatório | Double | Number(006,2) - Valor da parcela. |
pagamento.catTef | Opcional | String | String(100) - Código da autorização da transação no sistema TEF. |
pagamento.catExt | Opcional | String | String(100) - Código de autorização externo. |
pagamento.nsuTef | Opcional | String | String(100) - Número sequencial único da transação no sistema TEF. |
pagamento.dscNeg | Opcional | Double | Number(009,2) - Valor de desconto repasse da adm. de cartão. |
pagamento.cheBan | Opcional | String | String(003) - Código do banco do cheque. |
pagamento.cheAge | Opcional | String | String(007) - Código da agência bancária do cheque. |
pagamento.cheCta | Opcional | String | String(014) - Número da conta corrente do cheque. |
pagamento.cheNum | Opcional | String | String(010) - Número do cheque. |
pagamento.codBar | Opcional | String | String(050) - Código de barras do cheque (CMC7). |
pagamento.codSac | Opcional | String | String(014) - Código do sacado. |
pagamento.fpgTro | Opcional | Integer | Number(002) - Código da forma de pagamento de troco. |
pagamento.vlrTro | Opcional | Double | Number(009,2) - Valor do troco. |
pagamento.codOpe | Opcional | Integer | Number(004) - Código da operadora. |
sistemaIntegracao | Obrigatório | String | String(15) - Identificação do sistema integrado. |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Importar_3Response> <result> <tipoRetorno>Integer</tipoRetorno> <retorno> <ideExt>Integer</ideExt> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <seqRec>Integer</seqRec> <tipRet>Integer</tipRet> <msgRet>String</msgRet> <detalhes> <ideExt>Integer</ideExt> <seqIte>Integer</seqIte> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </detalhes> </retorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:Importar_3Response> </soapenv:Body> </soapenv:Envelope>
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
tipoRetorno | Obrigatório | Integer | Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
retorno | Opcional | Set | Lista dos erros |
retorno.ideExt | Obrigatório | Integer | Number(015) - Identificador Externo. Retorna mesmo valor do registro de recebimento. |
retorno.codEmp | Obrigatório | Integer | Number(004) - Código da empresa |
retorno.codFil | Obrigatório | Integer | Number(005) - Código da filial |
retorno.seqRec | Opcional | Integer | Number(009) - Sequência do Recebimento gerada |
retorno.tipRet | Obrigatório | Integer | Number(001) - Tipo de retorno. Valores: 1 - Processado com sucesso; 2 - Ocorreram Erros. |
retorno.msgRet | Opcional | String | String(250) - Mensagem de Erro |
retorno.detalhes | Opcional | Set | Detalhes dos Erros dos Itens. |
detalhes.ideExt | Obrigatório | Integer | Number(015) - Identificador Externo. Retorna mesmo valor do registro de recebimento. |
detalhes.seqIte | Opcional | Integer | Number(002) - Sequência do Item (Campo descontinuado) |
detalhes.tipRet | Obrigatório | Integer | Number(001) - Tipo de retorno. Valores: 1 - Processado com sucesso; 2 - Ocorreram Erros. |
detalhes.msgRet | Opcional | String | String(250) - Mensagem de Erro |
mensagemRetorno | Obrigatório | String | String(1000) - Mensagem de Retorno de Processamento |