Web service Com.senior.g5.co.int.varejo.cartaopresente
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_cartaopresente?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_cartaopresente?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_cartaopresente?wsdl
Portas
- IncluirCredito
- Gerar
- CancelarOperacao
- Consumir
- Pagar
- Consultar
- GravarCartaoPresente
- ConsumirCartaoPresente
- ConsultarCartaoPresente
Integrações - Varejo - Cartão Presente - Incluir Crédito Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:IncluirCredito>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<sigInt>String</sigInt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<croEcf>Integer</croEcf>
<numCoo>Integer</numCoo>
<codEqu>Integer</codEqu>
<numCpr>String</numCpr>
<vlrOpr>Double</vlrOpr>
<datVal>String</datVal>
<codRep>Integer</codRep>
<datOpr>String</datOpr>
<horOpr>String</horOpr>
</parameters>
</ser:IncluirCredito>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| croEcf | Integer | (Obrigatório) - Number(006) - Número Contador de Reinício |
| numCoo | Integer | (Obrigatório) - Number(009) - Contador da Ordem de Operação |
| codEqu | Integer | (Obrigatório) - Number(003) - Código do Equipamento Fiscal |
| numCpr | String | (Obrigatório) - String(020) - Número do Cartão Presente |
| vlrOpr | Double | (Obrigatório) - Number(9,2) - Valor do crédito |
| datVal | DateTime | (Opcional) - Date - Data de validade do crédito |
| codRep | Integer | (Obrigatório) - Number(009) - Código do Vendedor (Repesentante) |
| datOpr | DateTime | (Obrigatório) - Date - Data da operação |
| horOpr | String | (Obrigatório) - String(005) - Hora da Operação |
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:IncluirCreditoResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:IncluirCreditoResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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 | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
Integrações - Varejo - Cartão Presente - Gerar Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Gerar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<sigInt>String</sigInt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<croEcf>Integer</croEcf>
<numCoo>Integer</numCoo>
<codEqu>Integer</codEqu>
<numCpr>String</numCpr>
</parameters>
</ser:Gerar>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| croEcf | Integer | (Obrigatório) - Number(006) - Número Contador de Reinício |
| numCoo | Integer | (Obrigatório) - Number(009) - Contador da Ordem de Operação |
| codEqu | Integer | (Obrigatório) - Number(003) - Código do Equipamento Fiscal |
| numCpr | String | (Obrigatório) - String(020) - Número do Cartão Presente |
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:GerarResponse>
<result>
<numCpr>String</numCpr>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:GerarResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| numCpr | String | (Obrigatório) - String(020) - Número do Cartão Presente |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
Integrações - Varejo - Cartão Presente - Cancelar Operação Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:CancelarOperacao>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<sigInt>String</sigInt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<croEcf>Integer</croEcf>
<numCoo>Integer</numCoo>
<codEqu>Integer</codEqu>
<numCpr>String</numCpr>
</parameters>
</ser:CancelarOperacao>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| croEcf | Integer | (Obrigatório) - Number(006) - Número Contador de Reinício |
| numCoo | Integer | (Obrigatório) - Number(009) - Contador da Ordem de Operação |
| codEqu | Integer | (Obrigatório) - Number(003) - Código do Equipamento Fiscal |
| numCpr | String | (Obrigatório) - String(020) - Número do Cartão Presente |
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:CancelarOperacaoResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:CancelarOperacaoResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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 | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
Integrações - Varejo - Cartão Presente - Consumir Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Consumir>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<sigInt>String</sigInt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<croEcf>Integer</croEcf>
<numCoo>Integer</numCoo>
<codEqu>Integer</codEqu>
<numCpr>String</numCpr>
<vlrOpr>Double</vlrOpr>
</parameters>
</ser:Consumir>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| croEcf | Integer | (Obrigatório) - Number(006) - Número Contador de Reinício |
| numCoo | Integer | (Obrigatório) - Number(009) - Contador da Ordem de Operação |
| codEqu | Integer | (Obrigatório) - Number(003) - Código do Equipamento Fiscal |
| numCpr | String | (Obrigatório) - String(020) - Número do Cartão Presente |
| vlrOpr | Double | (Obrigatório) - Number(9,2) - Valor a ser consumido |
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:ConsumirResponse>
<result>
<salCpr>Double</salCpr>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsumirResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| salCpr | Double | (Obrigatório) - Number(9,2) - Saldo do Cartão Presente |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
Integrações - Varejo - Cartão Presente - Pagar Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Pagar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<cartaoPresente>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<croEcf>Integer</croEcf>
<numCoo>Integer</numCoo>
<codEqu>Integer</codEqu>
<numCpr>String</numCpr>
<vlrOpr>Double</vlrOpr>
<codCli>Integer</codCli>
<codRep>Integer</codRep>
<datEmi>String</datEmi>
<parcelas>
<numPar>Integer</numPar>
<codFpg>Integer</codFpg>
<vctPar>String</vctPar>
<vlrPar>Double</vlrPar>
<catExt>String</catExt>
<catTef>String</catTef>
<nsuTef>String</nsuTef>
<vlrRps>Double</vlrRps>
<cheBan>String</cheBan>
<cheAge>String</cheAge>
<cheCta>String</cheCta>
<cheNum>String</cheNum>
<codBar>String</codBar>
<codSac>String</codSac>
<fpgTro>Integer</fpgTro>
<vlrTro>Double</vlrTro>
<empCre>Integer</empCre>
<filCre>Integer</filCre>
<tptCre>String</tptCre>
<titCre>String</titCre>
<vlrCre>Double</vlrCre>
<codCnv>Integer</codCnv>
<depCnv>Integer</depCnv>
<codOpe>Integer</codOpe>
<indPag>String</indPag>
</parcelas>
</cartaoPresente>
<sigInt>String</sigInt>
</parameters>
</ser:Pagar>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| cartaoPresente | Set | Somente será aceito 1 registro por requisição. |
| cartaoPresente.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| cartaoPresente.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
| cartaoPresente.croEcf | Integer | (Obrigatório) - Number(006) - Contador de reinício de operação do ECF. |
| cartaoPresente.numCoo | Integer | (Obrigatório) - Number(009) - Contador da Ordem de Operação que emitiu o relacionamento na ECF |
| cartaoPresente.codEqu | Integer | (Obrigatório) - Number(003) - Código do Equipamento Fiscal |
| cartaoPresente.numCpr | String | (Obrigatório) - String(020) - Número do cartão presente. |
| cartaoPresente.vlrOpr | Double | (Obrigatório) - Number(011,2) - Valor a pagar do cartão presente. |
| cartaoPresente.codCli | Integer | (Obrigatório) - Number(004) - Código do Cliente. |
| cartaoPresente.codRep | Integer | (Obrigatório) - Number(004) - Código do representante. |
| cartaoPresente.datEmi | DateTime | (Obrigatório) - Date - Data de emissão do cupom fiscal. |
| cartaoPresente.parcelas | Set | |
| cartaoPresente.parcelas.numPar | Integer | (Obrigatório) - Number(003) - Número da parcela |
| cartaoPresente.parcelas.codFpg | Integer | (Obrigatório) - Number(002) - Código da forma de pagamento. Cada parcela possui uma única forma de pagamento, ou seja, quando houver mais de uma forma de pagamento, deve-se gerar uma parcela para cada forma de pagamento |
| cartaoPresente.parcelas.vctPar | String | (Obrigatório) - Date - Data de vencimento da parcela. Quando existir uma data de repasse ou de compensação, a data de repasse ou compensação deve ser informada neste campo |
| cartaoPresente.parcelas.vlrPar | Double | (Obrigatório) - Number(013,2) - Valor da parcela |
| cartaoPresente.parcelas.catExt | String | (Opcional) - String(100) - Código de autorização externo. Utilizado quando a operação for realizada com cartão manual ou sistema externo que necessite de um código de autorização para recebimento |
| cartaoPresente.parcelas.catTef | String | (Opcional) - String(100) - Código da autorização da transação (TEF - Sitef) |
| cartaoPresente.parcelas.nsuTef | String | (Opcional) - String(100) - Número sequencial único da transação TEF (host - operadora) |
| cartaoPresente.parcelas.vlrRps | Double | (Opcional) - Number(013,2) - Valor de desconto do repasse da administradora do cartão. |
| cartaoPresente.parcelas.cheBan | String | (Opcional) - String(003) - Código do banco |
| cartaoPresente.parcelas.cheAge | String | (Opcional) - String(007) - Código da agência bancária |
| cartaoPresente.parcelas.cheCta | String | (Opcional) - String(014) - Número da conta corrente |
| cartaoPresente.parcelas.cheNum | String | (Opcional) - String(010) - Número do cheque |
| cartaoPresente.parcelas.codBar | String | (Opcional) - String(050) - Código de barras do cheque (CMC7) |
| cartaoPresente.parcelas.codSac | String | (Opcional) - Number(014) - Código do sacado. Informar quando o proprietário do cheque estiver cadastrado |
| cartaoPresente.parcelas.fpgTro | Integer | (Opcional) - Number(002) - Código da forma de pagamento do troco |
| cartaoPresente.parcelas.vlrTro | Double | (Opcional) - Number(013,2) - Valor do troco. Condição: Obrigatório caso a forma de pagamento do troco for informada |
| cartaoPresente.parcelas.empCre | Integer | (Opcional) - Number(004) - Código da empresa do título de crédito a ser utilizado em trocas de mercadoria |
| cartaoPresente.parcelas.filCre | Integer | (Opcional) - Number(005) - Código da filial do título de crédito a ser utilizado em trocas de mercadoria |
| cartaoPresente.parcelas.tptCre | String | (Opcional) - String(003) - Código do tipo de título de crédito a ser utilizado em trocas de mercadoria |
| cartaoPresente.parcelas.titCre | String | (Opcional) - String(015) - Número do título de crédito a ser utilizado em trocas de mercadoria |
| cartaoPresente.parcelas.vlrCre | Double | (Opcional) - Number(013,2) - Valor a ser utilizado do título de crédito em trocas de mercadoria |
| cartaoPresente.parcelas.codCnv | Integer | (Opcional) - Number(004) - Código do convênio. Condição: obrigatório quando a forma de pagamento for do tipo "14 - Convênio". |
| cartaoPresente.parcelas.depCnv | Integer | (Opcional) - Number(004) - Código do dependente do convênio. |
| cartaoPresente.parcelas.codOpe | Integer | (Opcional) - Number(004) - Código da Operadora da Parcela. Observação: Quando a forma de pagamento indicar cartão automático, esta informação é obrigatória. |
| parcelas.indPag | String | String(001) - Indicativo da forma de pagamento (Valores: 0 - Pagamento à Vista; 1 - Pagamento à Prazo) |
| sigInt | String | (Opcional) - String(15) - Sigla do Sistema de Integração |
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:PagarResponse>
<result>
<mensagemRetorno>String</mensagemRetorno>
<resultado>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<croEcf>Integer</croEcf>
<numCoo>Integer</numCoo>
<codEqu>Integer</codEqu>
<numCpr>String</numCpr>
<resultado>String</resultado>
<parcela>
<numPar>Integer</numPar>
<tptTit>String</tptTit>
<numTit>String</numTit>
</parcela>
</resultado>
<tipoRetorno>String</tipoRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:PagarResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| mensagemRetorno | String | (Obrigatório) - String(250) - Mensagem de retorno da importação |
| resultado | Set | Grupo de retorno dos cupons fiscais |
| resultado.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| resultado.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
| resultado.croEcf | Integer | (Obrigatório) - Number(006) - Contador de reinício de operação do ECF. |
| resultado.numCoo | Integer | (Obrigatório) - Number(009) - Contador da Ordem de Operação que emitiu o relacionamento na ECF. |
| resultado.codEqu | Integer | (Obrigatório) - Number(003) - Código do equipamento fiscal |
| resultado.numCpr | String | (Obrigatório) - String(020) - Número do cartão presente. |
| resultado.resultado | String | (Obrigatório) - String(250) - Mensagem de retorno da importação. Caso o cupom seja integrado, será retorno "OK". Do contrário, será retornado motivo pelo qual o cupom não integrado |
| resultado.parcela | Set | |
| resultado.parcela.numPar | Integer | (Opcional) - Number(003) - Número da parcela gerada |
| resultado.parcela.tptTit | String | (Opcional) - String(003) - Código do tipo de título gerado |
| resultado.parcela.numTit | String | (Opcional) - String(015) - Número do título gerado |
| tipoRetorno | String | (Obrigatório) - Number(001) - Indicativo do tipo de retorno da solicitação - Lista: 1 = Processado com sucesso, 2 = Processado com erro |
Integrações - Varejo - Cartão Presente - Consultar Saldo Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Consultar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<numCpr>String</numCpr>
<sigInt>String</sigInt>
</parameters>
</ser:Consultar>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| numCpr | String | (Obrigatório) - String(020) - Numero do Cartão Presente |
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
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:ConsultarResponse>
<result>
<datVal>String</datVal>
<salCpr>Double</salCpr>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| datVal | DateTime | (Obrigatório) - String(10) - Data de validade do saldo do Cartão Presente |
| salCpr | Double | (Obrigatório) - Number(9,2) - Saldo do Cartão Presente |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
(Deprecado) Integrações - Varejo - Cadastros - Gravar Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:GravarCartaoPresente>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<dadosGravar>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<vlrCar>String</vlrCar>
<vlrInc>String</vlrInc>
<datEmi>String</datEmi>
<datVal>String</datVal>
</dadosGravar>
<tipoProcessamento>Integer</tipoProcessamento>
</parameters>
</ser:GravarCartaoPresente>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| dadosGravar | Set | |
| dadosGravar.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| dadosGravar.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| dadosGravar.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| dadosGravar.vlrCar | String | (Opcional) - Number(15,2) - Valor do Cartão Presente |
| dadosGravar.vlrInc | String | (Obrigatório) - Number(15,2) - Valor do Incremento do Cartão Presente |
| dadosGravar.datEmi | String | (Obrigatório) - Date - Data de Emissão do Cartão Presente |
| dadosGravar.datVal | String | (Obrigatório) - Date - Data de Validade do Cartão Presente |
| tipoProcessamento | Integer | (Obrigatório) - Number(001) - Tipo de Processamento - Lista: 1 = Inclusão, 2 = Alteração |
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:GravarCartaoPresenteResponse>
<result>
<retornosGravar>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<retorno>String</retorno>
</retornosGravar>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:GravarCartaoPresenteResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| retornosGravar | Set | |
| retornosGravar.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosGravar.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosGravar.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| retornosGravar.retorno | String | (Obrigatório) - String(020) - Retorno do processamento |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
(Deprecado) Integrações - Varejo - Cadastros - Consumir Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ConsumirCartaoPresente>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<dadosComsumo>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<datRes>String</datRes>
<vlrUti>String</vlrUti>
</dadosComsumo>
<tipoProcessamento>Integer</tipoProcessamento>
</parameters>
</ser:ConsumirCartaoPresente>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| dadosComsumo | Set | |
| dadosComsumo.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| dadosComsumo.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| dadosComsumo.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| dadosComsumo.datRes | String | (Obrigatório) - Date - Data do Último Resgate efetuado no Cartão Presente |
| dadosComsumo.vlrUti | String | (Obrigatório) - Number(15,2) - Valor Utilizado do Cartão Presente |
| tipoProcessamento | Integer | (Obrigatório) - Number(001) - Tipo de Processamento - Lista: 1 = Consumo |
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:ConsumirCartaoPresenteResponse>
<result>
<retornosConsumo>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<retorno>String</retorno>
</retornosConsumo>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsumirCartaoPresenteResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| retornosConsumo | Set | |
| retornosConsumo.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosConsumo.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosConsumo.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| retornosConsumo.retorno | String | (Obrigatório) - String(100) - Retorno do processamento |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
(Deprecado) Integrações - Varejo - Cadastros - Consultar Cartão Presente
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ConsultarCartaoPresente>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<tipoProcessamento>Integer</tipoProcessamento>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
</parameters>
</ser:ConsultarCartaoPresente>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| tipoProcessamento | Integer | (Obrigatório) - Number(001) - Tipo de Processamento - Lista: 1 = Consulta, 2 = Busca |
| codEmp | Integer | (Opcional) - Number(004) - Código da Empresa |
| codFil | Integer | (Opcional) - Number(005) - Código da Filial |
| carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
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:ConsultarCartaoPresenteResponse>
<result>
<retornosConsulta>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<vlrSal>String</vlrSal>
<datVal>String</datVal>
</retornosConsulta>
<retornosBusca>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<vlrCar>String</vlrCar>
<vlrSal>String</vlrSal>
<datVal>String</datVal>
</retornosBusca>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarCartaoPresenteResponse>
</soapenv:Body>
</soapenv:Envelope>
| Nome | Tipo | Descrição |
|---|---|---|
| erroExecucao | 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" |
| retornosConsulta | Set | |
| retornosConsulta.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosConsulta.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosConsulta.vlrSal | String | (Obrigatório) - Number(15,2) - Valor de Saldo do Cartão Presente |
| retornosConsulta.datVal | String | (Obrigatório) - Date - Data de Validade do Cartão Presente |
| retornosBusca | Set | |
| retornosBusca.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosBusca.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosBusca.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| retornosBusca.vlrCar | String | (Obrigatório) - Number(15,2) - Valor do Cartão Presente |
| retornosBusca.vlrSal | String | (Obrigatório) - Number(15,2) - Valor de Saldo do Cartão Presente |
| retornosBusca.datVal | String | (Obrigatório) - Date - Data do Último Resgate efetuado no Cartão Presente |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
English
Español
English
Español


