WebService IntegraParceiro

Como funciona?

Através do IntegraParceiro é possível para qualquer parceiro de negócios da Universal Assistance disponibilizar em seu portal ou site a plataforma de vendas de voucher de assistência de viagens para seus clientes. Consultar as tarifas disponibilizadas e efetuar inclusão de voucher de forma rápida e facilitada na mesma base de vendas utilizada por toda a companhia.

Requisitos

Para utilizar este serviço é necessário que a empresa interessada já seja uma parceira de negócios da Universal Assistance e que esteja previamente cadastrada em nossa base de dados. Caso sua empresa não seja uma parceira de negócios da Universal Assistance entre em contato através do endereço de e-mail [email protected]. Também é necessário ter a conta de um usuário e senha para fazer a conexão com o WebService, e para acessar a interface de administração de vendas para consultar os vouchers inseridos via WebService ou para fazer vendas através desta interface. Até a data da escrita deste manual o WebService de testes esta sendo disponibilizado no endereço: https://homologacao.universal-assistance.com/TravelAceService.svc?wsdl

Autenticação

O Objeto Autenticação é um parâmetro necessário em todos os métodos. Consiste das informações da tabela abaixo:

Nome do objeto: Autenticação

Objeto que contém as informações de Login e Senha para utilizar os serviços de integração.

Propriedade Tamanho Tipo Descrição Obrigatório
Login 50 String Login do Emissor, fornecido pela Travelace Sim
Senha - String Senha do Emissor, fornecido pela Travelace. Sim

Erro

Todos os métodos do Webservice retornam o mesmo tipo de objeto de erro. O Objeto ErroDeValidacao consiste dos campos abaixo.

Nome do Objeto: ErroDeValidacao

Retorno compra bem-sucedida.

Parâmetro Tamanho Tipo Descrição Obrigatório
Mensagem - String Mensagem com a descrição do erro. -

Câmbio

Nome do Método: getCambio

Método que retorna o câmbio do dia.

Parâmetro Tamanho Tipo Descrição Obrigatório
CodigoMoeda - String Código da Moeda. Fornecido pelo método “Moedas”. Sim
Autenticação - String Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Propriedade Tamanho Tipo Descrição Obrigatório
Cambio - Double Retorno do método Cambio Sim

Simulação de compra (Cotação)

Para realizar uma simulação é necessário informar os dados da tabela abaixo. O Retorno é o método complexo CotacaoRetorno, que possuí todas as informaçãos de produtos, passageiros, destinos, benefícios e tarifas.

Nome do Método: SimulacaoCompra

Método que realiza a simulação de compra.

Parâmetro Tamanho Tipo Descrição Obrigatório
request - Objeto Objeto CotacaoRequest. Sim
autenticacao - String Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Nome do Objeto: CotacaoRequest

Objeto com as informações primordiais para realizar uma cotação.

Propriedade Tamanho Tipo Descrição Obrigatório
Destinos - Array Array de strings com o(s) código(s) do(s) país(es), fornecido pelo método “Destinos”. Cada destino deve ter o tamanho de 2 caracteres. Sim
TipoViagem - Integer Código do Tipo de Viagem, fornecido pelo método “TiposViagem”. Sim
TipoTarifa - Integer Código do Tipo de Tarifa, fornecido pelo método “TiposTarifa”. Sim
DataSaida - Datetime Data de saída da viagem. Sim
DataRetorno - DateTime Data de retorno da viagem. Sim
ProdutoAvulso - Boolean Flag indicando se a busca deve ser feita para retornar somente produtos avulsos. Não
Passageiros - Array Array do objeto PassageiroRequest. Com as informações básicas para a simulação de compra (Nome e Data de Nascimento). Sim
Cupom - String Cupom de desconto. Não
Classificacoes - Array Array de int com o(s) código(s) da classificação, fornecida pelo método “GetClassificacaoes”. Não
ValorTotalPacote - Double Valor do pacote de viagem (Aéreo, Hotel, Carro, etc) (Será utilizado para o produto Cancelamento total e Full Protection). Não

Nome do Objeto Pai: CotacaoRequest

Objeto: PassageiroRequest

Objeto com as informações básicas para realizar a simulação de uma cotação.

Propriedade Tamanho Tipo Descrição Obrigatório
Nome 70 String Nome completo do passageiro. Sim
DataNascimento - DateTime Data de Nascimento do passageiro. Sim

Retorno

Nome do Objeto: CotacaoRetorno

Objeto com todas as informações de Produtos, Tarifas, Beneficios, Beneficios Opcionais e Destinos.

Propriedade Tamanho Tipo Descrição Obrigatório
DataInicial - Datetime Data de Saída. -
DataFinal - Datetime Data de Retorno. -
TipoViagem - Integer Código do Tipo de Viagem. -
DiasViagem - Integer Quantidade de dias de duração da Viagem. -
ValorDoCambio - Double Valor do câmbio do dia. -
DataCotacao - Datetime Data da Cotação. -
MostrarTarifaAcordo - Boolean Data de Retorno. -
TipoTarifaFolheto - String Tipo da Tarifa do Folheto. Retorno: Acordo ou Folheto. -
Beneficios - List Lista de benefícios (objeto BeneficioCotacao) para a cotação. -
Produtos - List Lista de produtos (objeto ProdutoCotacao) para a cotação. -
DestinosCotacao - List Lista de destinos (objeto DestinoCotacao) da cotação. -
Passageiros - List Lista de passageiros (objeto PassageiroCotacao) da cotação. -

Nome do Objeto Pai: CotacaoRetorno

Objeto: BeneficioCotacao

Dados da descrição dos Beneficios dos produtos.

Propriedade Tamanho Tipo Descrição Obrigatório
IdBeneficio - Integer ID do Beneficio. -
Descricao - String Descrição do Beneficio. -
TipoBeneficio - Integer Código do Tipo do Beneficio. -
Ordem - Integer Ordem em que o beneficio deve ser mostrado em uma lista. -
Imagem - String Nome da imagem. -
DescricaoCompleta - String Descricao adicional. -

Nome do Objeto Pai: CotacaoRetorno

Objeto: ProdutoCotacao

Dados dos produtos.

Propriedade Tamanho Tipo Descrição Obrigatório
IdProduto - Integer Código do Produto. -
IdProdutoDesconto - Integer Código do Produto Desconto. -
IdProdutoAcordo - Integer Código do Produto Acordo. -
Descricao - String Descrição (nome) do Produto. -
Tarifa - Objeto Objeto TarifaCotada com a descrição de todas as tarifas do produto. Retorna nula quando o tipo de viagem é Multiviagem. -
Tarifas - Lista Lista do Objeto TarifaCotada com a descrição de todas as tarifas do produto. Retorna nula quando o tipo de viagem é Viagem Única. -
Beneficios - Lista Lista do Objeto BeneficioProdutoCotado com a descrição dos Beneficios Cotados. -
BeneficiosOpciona is - Lista Lista do Objeto BeneficioOpcionalCotado com a descrição e valores dos Beneficios Opcionais. -
Avulso - Bool Informa se o produto é Avulso. -
IdBeneficioDestaque - Integer Informa o Id do beneficio destaque do produto. -

Nome do Objeto Pai: ProdutoCotacao / BeneficioCustomizadoCotado / BeneficioOpcionalCotado

Objeto: TarifaCotada

O Objeto TarifaCotada contém todos os valores monetários para produtos, beneficios customizados e beneficios opcionais.

Propriedade Tamanho Tipo Descrição Obrigatório
QuantidadePassageiros - Integer Quantidade de Passageiros. -
QuantidadedeDias - Integer Quantidade de Dias. -
Cambio - Double Valor do Cambio. -
Comissao - Double Valor da Comissao. -
Valor - Double Valor da Tarifa, sempre em BRL. -
ValorUnitario - Double Valor Unitário do Produto, sempre em BRL. -
ValorMoeda - Double Valor na Moeda do Produto, ex (USD, EUR, BRL). -
ValorUnitarioMoeda - Double Valor Unitário na Moeda do Produto, ex (USD, EUR, BRL). -
ValorFolheto - Double Valor de Folheto do Produto, sempre em BRL. -
ValorFolhetoMoeda - Double Valor na Moeda do Produto (Folheto). -
Desconto - Double Desconto para o produto (Valor em %). -
TarifaFolheto - Boolean Indica se as tarifas que são mostradas em Valor e ValorMoeda são tarifas de folheto. -
QuantidadeDiasMultiViagem - Integer Quantidade de dias do Período Multiviagem. -
TarifaIdade - List Lista do Objeto TarifaIdade. -

Nome do Objeto Pai: TarifaCotada

Objeto: TarifaIdade

Tarifas do produto.

Propriedade Tamanho Tipo Descrição Obrigatório
De - Integer Idade Inicial da vigência da tarifa idade. -
Até - Integer Idade Final da vigência da tarifa idade. -
Valor - Double Valor da Tarifa para a vigência. -
ValorMoeda - Double Valor Moeda da Tarifa para a vigência. -

Nome do Objeto Pai: ProdutoCotacao

Objeto: BeneficioProdutoCotado

Benefícios do Produto Cotado.

Propriedade Tamanho Tipo Descrição Obrigatório
IdBeneficio - Integer Código do Beneficio. -
Valor - Double Valor do Benefício. -
BeneficioCustomizadoCotado - List Lista do Objeto BeneficioCustomizadoCotado. -
BeneficioDestaque - Integer Informa se é o beneficio destaque. -
IdadeMinima - Integer Idade miníma para o beneficio. -
IdadeMaxima - Integer Idade máxima para o beneficio. -

Nome do Objeto Pai: BeneficioProdutoCotado

Objeto: BeneficioCustomizadoCotado

Dados do Beneficio Customizado.

Propriedade Tamanho Tipo Descrição Obrigatório
IdBeneficioCustomizavel - Integer Código do Benefício Customizável. -
IdBeneficio - Integer Código do Benefício. -
Valor - Double Valor do Benefício Customizável. -
Tarifa - Objeto Objeto TarifaCotada com a descrição de todas as tarifas do benefício customizado. Retorna nula quando o tipo de viagem é Multiviagem. -
Tarifas - List Lista do Objeto TarifaCotada com a descrição de todas as tarifas do benefício customizado. Retorna nula quando o tipo de viagem é Viagem Única. -
IdadeMinima - Integer Idade miníma para o benefício. -
IdadeMaxima - Integer Idade máxima para o benefício. -

Nome do Objeto Pai: ProdutoCotacao

Objeto: BeneficioOpcionalCotado

Benefícios do Produto Cotado.

Propriedade Tamanho Tipo Descrição Obrigatório
IdBeneficioOpcional - Integer Código do Beneficio Opcional. -
FkBeneficio - Integer Código do Benefício. -
Descrição - String Descrição do Benefício Opcional. -
Valor - String Valor do Benefício Opcional. -
Tarifa - Objeto Objeto TarifaCotada com a descrição de todas as tarifas do benefício opcional. Retorna nula quando o tipo de viagem é Multiviagem. -
Tarifas - List Lista do Objeto TarifaCotada com a descrição de todas as tarifas do benefício customizado. Retorna nula quando o tipo de viagem é Viagem Única. -
Imagem - String Descricao adicional. -
DescricaoCompleta - String Descricao adicional. -
IdadeMinima - Integer Idade miníma para o beneficio. -
IdadeMaxima - Integer Idade máxima para o beneficio. -

Nome do Objeto Pai: CotacaoRetorno

Objeto: PassageiroCotacao

Passageiros da Cotação.

Propriedade Tamanho Tipo Descrição Obrigatório
IdPassageiro - Integer ID do Passageiro. -
Nome - String Nome do Passageiro. -
Sobrenome - String Sobrenome do Passageiro. -
DataNascimento - Datetime Data de Nascimento do Passageiro. Formato (dd/MM/yyyy). -
NumeroDocumento - String Número do Documento do Passageiro. -
Sexo - Boolean Sexo do Passageiro. True para Masculino, False para Feminino. -
Desconto - Int Desconto para o passageiro. -

Nome do Objeto Pai: CotacaoRetorno

Objeto: DestinoCotacao

Destinos da Cotação.

Propriedade Tamanho Tipo Descrição Obrigatório
IdDestino - Integer ID do Destino. -
SiglaPais - String Sigla do País. -

Compras

Nome do Método: Compras

Método que realiza o pedido de compra.

Parâmetro Tamanho Tipo Descrição Obrigatório
request - Objeto Objeto CompraRequest. Sim
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Nome do Objeto: CompraRequest

Propriedade Tamanho Tipo Descrição Obrigatório
DadosBasicos - Objeto Objeto DadosBasicos. Contém informações primordiais para emissão de voucher. Sim
DadosTitular - Objeto Objeto DadosTitular. Contém informações do titular responsável pelo voucher. Sim
DadosIntegrantes - Array Coleção do Objeto DadosIntegrantes. Contem as informações básicas de todos os integrantes. Sim
DadosProduto - Objeto Objeto DadosProduto. Contem as informações do produto que será comprado. É Obrigatório somente quando não há compra de Produto Avulso. Não
DadosBeneficios Opcional - Array Coleção do Objeto DadosBeneficioOpcional. Contem as informações do beneficio opcional que será comprado (e seus passageiros). Não
DadosProdutosAvulsos - Array Array do Objeto DadosProdutosAvulsos. Contem as informações do Produto avulso que será comprado (e seus passageiros). É Obrigatório somente quando não há compra de Produto Travelace. Sim

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosBasicos

Dados básicos do pedido de compra.

Propriedade Tamanho Tipo Descrição Obrigatório
Destinos - Array Array de strings com o(s) código(s) do(s) país(es), fornecido pelo método “Destinos”. Cada destino deve ter o tamanho de 2 caracteres. Sim
TipoViagem - Integer Código do Tipo de Viagem, fornecido pelo método “TiposViagem. Sim
TipoTarifa - Integer Código do Tipo de Tarifa, fornecido pelo método “TiposTarifa”. Sim
DataSaida - Datetime Data de saída da viagem. Formato (dd/MM/yyyy). Sim
DataRetorno - Datetime Data de retorno da viagem. Formato (dd/MM/yyyy). Sim
ValorCompra - Double Valor total da compra. Sim
Cambio - Double Valor do Cambio da transação. Não
FormaPagamento - Integer Código da Forma de Pagamento, fornecido pelo método “FormasPagamento”. Sim
CNPJAgencia - String CNPJ da agência responsável pela emissão. Não
CPFEmissor - String CPF do emissor responsável pela emissão. Não
Cupom - String Cupom de desconto. Não
NomeContatoBrasil 70 String Nome para Contato no Brasil. Sim
TelefoneContatoBrasil 11 String Telefone para Contato no Brasil. Sim
CelularContatoBrasil 11 String Telefone Celular para Contato no Brasil. Não
NumeroControle 30 String Informação que aparece na fatura. Não
Identificação 30 String Campo livre para informações relevantes. Não
ValorTotalPacote - Double Valor do pacote de viagem (Aéreo, Hotel, Carro, etc) (Será utilizado para o produto Cancelamento total e Full Protection). Não

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosTitular

Dados do titular da compra.

Propriedade Tamanho Tipo Descrição Obrigatório
Codigo - Integer Código de Identificação do Passageiro Titular. Obrigatoriamente deve ser 1. Sim
Nome 60 String Nome do Titular. Sim
Sobrenome 50 String Sobrenome do Titular. Sim
Sexo 1 String Sexo do Titular. M ou F. Sim
TipoDocumento - String Código do Tipo de documento, fornecido pelo método “TiposDoc”. Sim
Documento 20 String Número do Documento do Titular. Sim
Telefone 11 String Telefone do Titular. Sim
Celular 11 String Telefone celular do Titular. Não
Idade - Integer Idade. Sim
Email 11 String Email do Titular. Sim
DataNascimento - Datetime Data de Nascimento do Titular. Formato (dd/MM/yyyy). Sim
Endereco 80 String Endereço do Titular. Sim
CEP 8 String CEP do Titular. Sim
Numero 15 String Número do endereço do Titular. Sim
Bairro 50 String Bairro do Titular. Sim
Cidade 50 String Cidade do Titular. Sim
UF 2 String Sigla do estado do Titular. Obrigatoriamente 2 caracteres. Sim
Complemento 50 String Complemento para o endereço do Titular. Não

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosIntegrante

Coleção da propriedade/objeto DadosIntegrantes. Com as informações básicas de todos os passageiros da viagem.

Propriedade Tamanho Tipo Descrição Obrigatório
Codigo - Integer Código de Identificação do Passageiro Integrante. Obrigatoriamente incrementar a partir do número 2. Sim
Nome 60 String Nome do Integrante. Sim
Sobrenome 50 String Sobrenome do Integrante. Sim
Sexo 1 String Sexo do Titular. M ou F. Sim
TipoDocumento - String Código do Tipo de documento, fornecido pelo método “TiposDoc”. Sim
Documento 20 String Número do Documento do Integrante. Sim
DataNascimento - Datetime Data de Nascimento do Titular. Formato (dd/MM/yyyy). Sim
Idade - Integer Idade. Sim

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosProduto

Dados do Produto.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoProduto - Integer Código do Produto. Obtido no Simulação Compra. Sim
ValorProduto - Double Valor do Produto. Sim
CodigoPeriodoMultiViagem - Integer Código do Período de Multiviagem. Fornecido pelo método “PeriodosMultiViagem”. É Obrigatório somente quando o tipo de viagem (DadosBasicos - TipoViagem) for Multiviagem. Não
Cambio - Double - Não
CodigoTarifaAcordo - Integer Caso a venda seja do tipo acordo esse campo é obrigatório. Não
Documento 20 String Número do Documento do Integrante. Sim
DataNascimento - Datetime Data de Nascimento do Titular. Formato (dd/MM/yyyy). Sim
Idade - Integer Idade. Sim

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosBeneficiosOpcionais

Coleção de DadosBeneficioOpcional.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoBeneficioOpcional - Integer Código do Beneficio Opcional. Sim
ValorBeneficioOpciona - Double Valor do Beneficio Opcional. Sim
DadosPassageiro - Array Coleção do objeto DadosPassageiroBeneficioOpcional. Sim

Nome do Objeto Pai: DadosBeneficioOpcional

Nome do Objeto: DadosPassageiroBeneficioOpcional

Coleção de códigos de passageiros para o benefício opcional comprado.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoPassageiro - Integer Código do Passageiro. Definido em DadosIntegrantes - Código ou DadosTitular - Código. Sim

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosProdutosAvulsos

Coleção de DadosProdutosAvulsos.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoProduto - Integer Código do Benefício. Sim
CodigoPeriodoMultiViagem - Integer Código do Período de Multiviagem. Fornecido pelo método “PeriodosMultiViagem”. É Obrigatório somente quando o tipo de viagem (DadosBasicos - TipoViagem) for Multiviagem. Não
ValorProduto - Double Valor do Produto. Sim
DadosPassageiroProdutoAvulso - Array Coleção do objeto DadosPassageiroProdutoAvulso. Sim
CodigoTarifaAcordo - Integer Caso a venda seja do tipo acordo esse campo é obrigatório. Não
DadosBeneficiosOpcionais - Array Dados dos passageiros que compraram o beneficio opcional. Não

Nome do Objeto Pai: DadosProdutosAvulsos

Nome do Objeto: DadosPassageiroProdutoAvulso

Coleção de códigos de passageiros para o produto avulso comprado.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoPassageiro - Integer Código do Passageiro. Definido em DadosIntegrantes - Código ou DadosTitular - Código. Sim

Nome do Objeto Pai: CompraRequest

Nome do Objeto: DadosPagamento

Dados do Produto.

Parâmetro Tamanho Tipo Descrição Obrigatório
CodigoOperadora - Integer Código da Bandeira da operadora de cartão de crédito. Fornecido pelo método “Operadoras”. Somente para pagamento com Cartão
NomeTitularCartao 70 String Nome do Titular do Cartão de crédito / Nome do Sacado (Pagamento por boleto). Sim
CPFTitular 14 String CPF do Titular do Cartão de crédito / CPF do Sacado (Pagamento Boleto). Sim
NumeroCartao 20 String Número do Cartão de crédito do Titular. Somente para pagamento com Cartão
CodigoSeguranca 4 String Código de Segurança do Cartão de crédito. Somente para pagamento com Cartão
MesValidade 2 String Mês da Validade do Cartão do crédito. Somente para pagamento com Cartão
AnoValidade 4 String Ano de Validade do Cartão de crédito. Somente para pagamento com Cartão
Parcelas - Integer Quantidade de Parcelas doPagamento. Máximo de 6. Somente para pagamento com Cartão

Retorno

Nome do Objeto: CompraResponse

Retorno compra bem-sucedida.

Propriedade Tamanho Tipo Descrição Obrigatório
UrlVoucher - String URL com o arquivo com os vouchers em PDF. -
CodigoCarrinho - Long Código do Carrinho. -

Cancelar compra

Nome do Método: CancelarCompra

Método que realiza o cancelamento de uma compra.

Parâmetro Tamanho Tipo Descrição Obrigatório
codigoCarrinho - Long Código do Carrinho a ser cancelado. Sim
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Propriedade Tamanho Tipo Descrição Obrigatório
- - String - -

Mensagens

Sucesso
– Carrinho {#número} cancelado com sucesso!
– Voucher já está cancelado.
Erro
– O carrinho não pode ser cancelado porque o emissor não tem autorização.
– Carrinho {#número} não pode ser cancelado!
– Voucher entrou em vigência, não pode ser cancelado.
– Voucher é master do banco de dias e possui outros vouchers atrelados ativos, não pode ser cancelado.
– Voucher não pode ser cancelado, porque esta faturado mas não pago. Cancele o título número {0} no ERP antes de cancelar o voucher.

Imprimir Vouchers

Nome do Método: ImprimirVouchers

Viabiliza diferentes formas de visualização da impressão de voucher.

Parâmetro Tamanho Tipo Descrição Obrigatório
codigoCarrinho - Long Código do Carrinho. Sim
tipoImpressao 1 String Tipo de Impressão.F para folheto, A para Acordo e B para Branco. Sim
idioma - String Idioma do Voucher. Opções: ingles ou portugues (ambos sem acento). Sim
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Propriedade Tamanho Tipo Descrição Obrigatório
- - String Retorna a url formatada de acordo com os parâmetros passados. -

Imprimir por controle

Nome do Método: ImprimirVouchersPorControle

Viabiliza diferentes formas de visualização da impressão de voucher.

Parâmetro Tamanho Tipo Descrição Obrigatório
numeroControle - String Numero do controle enviado na emissão. Sim
tipoImpressao 1 String Tipo de Impressão.F para folheto, A para Acordo e B para Branco. Sim
idioma - String Idioma do Voucher. Opções: ingles ou portugues (ambos sem acento). Sim
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Status do voucher

Nome do Método: GetStatusVoucher

Retorna o status de todos os vouchers associados ao carrinho.

Parâmetro Tamanho Tipo Descrição Obrigatório
codigoCarrinho - Long Código do Carrinho. Sim
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Propriedade Tamanho Tipo Descrição Obrigatório
StatusVoucher - Array Retorna uma coleção com todos os status dos vouchers cadastrados em um determinado carrinho. -

Objeto: StatusVoucher

Status do voucher.

Propriedades Tamanho Tipo Descrição Obrigatório
Tipo - String Tipo Voucher. -
Serie - String Serie do Voucher. -
Voucher - Long Número do Voucher. -
Status - String No Momento o status por der: Ativo ou Cancelado. -

Nome do Método: GetStatusVoucherPorControle

Retorna o status de todos os vouchers associados a um numero de controle.

Parâmetro Tamanho Tipo Descrição Obrigatório
numeroControle - String Numero de controle. Sim
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Propriedade Tamanho Tipo Descrição Obrigatório
StatusVoucher - Array Retorna uma coleção com todos os status dos vouchers cadastrados em um determinado numero de controle. -

Obtendo o valor total da compra

Para calcular o valor total da compra é preciso realizar o cálculo com informações providas no retorno do método SimulaCotacao.
Obtendo o Valor do Produto (viagem única):

O valor do produto em viagem única já vem calculado com o total de passageiros. Assim não é necessário multiplicar o valor unitário pela quantidade de passageiros. 

<a:BeneficiosOpcionais>
      <a:BeneficioOpcionalCotado>
        <a:CoberturaBeneficio>0</a:CoberturaBeneficio>
          <a:Descricao>Prática de Esportes</a:Descricao>
          <a:DescricaoCompleta>Prática de Esportes x</a:DescricaoCompleta>
          <a:FkBeneficio>1253</a:FkBeneficio>
          <a:IdBeneficioOpcional>2289</a:IdBeneficioOpcional>
          <a:IdadeMaxima>70</a:IdadeMaxima>
          <a:IdadeMinima>0</a:IdadeMinima>
          <a:Imagem>icon-sports.jpg</a:Imagem>
          <a:Tarifa>
            <a:AplicaDescontoPadrao>false</a:AplicaDescontoPadrao>
            <a:AplicaPromocao>false</a:AplicaPromocao>
            <a:Cambio>3.2832</a:Cambio>
            <a:Comissao>60.33</a:Comissao>
            <a:Desconto>0</a:Desconto>
            <a:QuantidadeDias>15</a:QuantidadeDias>
            <a:QuantidadeDiasMultiviagem>0</a:QuantidadeDiasMultiviagem>
            <a:QuantidadeFree>0</a:QuantidadeFree>
            <a:QuantidadePassageiros>1</a:QuantidadePassageiros>
            <a:TarifaFolheto>false</a:TarifaFolheto>
            <a:TarifaIdade i:nil="true"/>
            <a:Valor>241.32</a:Valor>
            <a:ValorFolheto>0</a:ValorFolheto>
            <a:ValorFolhetoMoeda>0</a:ValorFolhetoMoeda>
            <a:ValorMoeda>73.5</a:ValorMoeda>
            <a:ValorSemDesconto>0</a:ValorSemDesconto>
            <a:ValorUnitario>241.32</a:ValorUnitario>
            <a:ValorUnitarioMoeda>73.5</a:ValorUnitarioMoeda>
          </a:Tarifa>
          <a:Tarifas/>
          <a:Valor>SIM</a:Valor>
          </a:BeneficioOpcionalCotado>
  </a:BeneficiosOpcionais>

Obtendo o Valor do Benefício Opcional (viagem única):

O valor do benefício opcional – ao contrário do produto – sempre retorna o valor unitário. O valor total benefício deve ser calculado com base no valor em destaque da tabela abaixo, multiplicado pela quantidade de passageiros que estarão inclusos no mesmo. 

  <a:BeneficioOpcionalCotado>
      <a:CoberturaBeneficio>0</a:CoberturaBeneficio>
      <a:Descricao>Prática de Esportes</a:Descricao>
      <a:DescricaoCompleta>Prática de Esportes x</a:DescricaoCompleta>
      <a:FkBeneficio>1253</a:FkBeneficio>
      <a:IdBeneficioOpcional>2290</a:IdBeneficioOpcional>
      <a:IdadeMaxima>70</a:IdadeMaxima>
      <a:IdadeMinima>0</a:IdadeMinima>
      <a:Imagem>icon-sports.jpg</a:Imagem>
      <a:Tarifa>
         <a:AplicaDescontoPadrao>false</a:AplicaDescontoPadrao>
         <a:AplicaPromocao>false</a:AplicaPromocao>
         <a:Cambio>3.2832</a:Cambio>
         <a:Comissao>41.25</a:Comissao>
         <a:Desconto>0</a:Desconto>
         <a:QuantidadeDias>15</a:QuantidadeDias>
         <a:QuantidadeDiasMultiviagem>0</a:QuantidadeDiasMultiviagem>
         <a:QuantidadeFree>0</a:QuantidadeFree>
         <a:QuantidadePassageiros>1</a:QuantidadePassageiros>
         <a:TarifaFolheto>false</a:TarifaFolheto>
         <a:TarifaIdade i:nil="true"/>
         <a:Valor>164.98</a:Valor>
         <a:ValorFolheto>0</a:ValorFolheto>
         <a:ValorFolhetoMoeda>0</a:ValorFolhetoMoeda>
         <a:ValorMoeda>50.25</a:ValorMoeda>
         <a:ValorSemDesconto>0</a:ValorSemDesconto>
         <a:ValorUnitario>164.98</a:ValorUnitario>
         <a:ValorUnitarioMoeda>50.25</a:ValorUnitarioMoeda>
      </a:Tarifa>
      <a:Tarifas/>
      <a:Valor>SIM</a:Valor>
  </a:BeneficioOpcionalCotado>

Obtendo o Valor do Produto Avulso (viagem única):

O valor do produto avulso deve ser baseado no valor unitário multiplicado pela quantidade de passageiros que estarão inclusos. 


<a:BeneficioOpcionalCotado>
      <a:CoberturaBeneficio>0</a:CoberturaBeneficio>
      <a:Descricao>Prática de Esportes</a:Descricao>
      <a:DescricaoCompleta>Prática de Esportes x</a:DescricaoCompleta>
      <a:FkBeneficio>1253</a:FkBeneficio>
      <a:IdBeneficioOpcional>2293</a:IdBeneficioOpcional>
      <a:IdadeMaxima>70</a:IdadeMaxima>
      <a:IdadeMinima>0</a:IdadeMinima>
      <a:Imagem>icon-sports.jpg</a:Imagem>
      <a:Tarifa>
        <a:AplicaDescontoPadrao>false</a:AplicaDescontoPadrao>
        <a:AplicaPromocao>false</a:AplicaPromocao>
        <a:Cambio>3.2832</a:Cambio>
        <a:Comissao>25.24</a:Comissao>
        <a:Desconto>0</a:Desconto>
        <a:QuantidadeDias>15</a:QuantidadeDias>
        <a:QuantidadeDiasMultiviagem>0</a:QuantidadeDiasMultiviagem>
        <a:QuantidadeFree>0</a:QuantidadeFree>
        <a:QuantidadePassageiros>1</a:QuantidadePassageiros>
        <a:TarifaFolheto>false</a:TarifaFolheto>
        <a:TarifaIdade i:nil="true"/>
        <a:Valor>100.96</a:Valor>
        <a:ValorFolheto>0</a:ValorFolheto>
        <a:ValorFolhetoMoeda>0</a:ValorFolhetoMoeda>
        <a:ValorMoeda>30.75</a:ValorMoeda>
        <a:ValorSemDesconto>0</a:ValorSemDesconto>
        <a:ValorUnitario>100.96</a:ValorUnitario>
        <a:ValorUnitarioMoeda>30.75</a:ValorUnitarioMoeda>
      </a:Tarifa>
      <a:Tarifas/>
      <a:Valor>SIM</a:Valor>
</a:BeneficioOpcionalCotado>

Classificações

Nome do Método: getClassificacoes

Método que retorna uma coleção de Classificações.

Parâmetro Tamanho Tipo Descrição Obrigatório
Autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Nome do Objeto: Classificacoes

Coleção de Classificações.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoClassificacao - Integer - Sim
Classificacao - String - Sim

Destinos

Nome do Método: getDestinos

Método que retorna uma coleção de Destinos.

Parâmetro Tamanho Tipo Descrição Obrigatório
nomePais 50 String Nome do País específico na lista de Destinos. Não
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração Sim

Retorno

Nome do Objeto: Destino

Coleção de Destinos.

Propriedade Tamanho Tipo Descrição Obrigatório
IdPais - Integer ID do País. -
IdRegiao - Integer ID da Região -
Pais - String Nome do País -
Regiao - String Nome da Região -
SiglaPais - String Siga do País -
SiglaRegiao - String Siga da Região -

Tipos de Documento

Nome do Método: getTiposDocumento

Método que retorna uma coleção de Tipos de Documento.

Parâmetro Tamanho Tipo Descrição Obrigatório
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração Sim

Retorno

Nome do Objeto: TiposDoc

Coleção de TiposDoc.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoDocumento - Integer Código do Documento. -
Documento - String Descrição do Tipo de Documento. -

Tipos de Viagem

Nome do Método: getTiposViagem

Método que retorna uma coleção de Tipos de Viagem.

Parâmetro Tamanho Tipo Descrição Obrigatório
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Nome do Objeto: getTiposViagem

Coleção de TiposViagem.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoTipoViagem - Integer Código do Tipo de Viagem. -
TipoViagem - String Descrição do Tipo de Viagem. -

Tipos de Tarifa

Nome do Método: getTiposTarifa

Método que retorna uma coleção de Tipos de Tarifa.

Parâmetro Tamanho Tipo Descrição Obrigatório
autenticacao - Objeto Objeto Autenticação. Necessário em todos osmétodos da integração. Sim

Retorno

Nome do Objeto: TiposTarifa

Coleção de TiposTarifa.

Propriedade Tamanho Tipo Descrição Obrigatório
CódigoTarifa - Integer Código do Tipo de Tarifa. -
Tarifa - String Descrição da Tarifa. -

Formas de Pagamento

Nome do Método: GetFormasPagamento

Método que retorna uma coleção de Formas de Pagamento.

Parâmetro Tamanho Tipo Descrição Obrigatório
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim

Retorno

Nome do Objeto: FormaPagamento

Coleção de Formas de Pagamento.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoFormaPagamento - Integer Código da Forma de Pagamento. -
Descricao - String Descrição da Forma de Pagamento. -

Operadoras

Nome do Método: getOperadoras

Método que retorna uma coleção de Operadoras de cartão de crédito.

Parâmetro Tamanho Tipo Descrição Obrigatório
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim
Descricao - String Descrição da Forma de Pagamento. -

Retorno

Nome do Objeto: Operadoras

Coleção de Operadoras.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoOperadora - Integer Código da Operadora de cartão de crédito. -
Operadora - String Nome da Operadora de cartão de crédito. -

Moedas

Nome do Método: getMoedas

Método que retorna uma coleção de Moedas.

Parâmetro Tamanho Tipo Descrição Obrigatório
autenticacao - Objeto Objeto Autenticação. Necessário em todos os métodos da integração. Sim
Descricao - String Descrição da Forma de Pagamento. -

Retorno

Nome do Objeto: Moedas

Coleção de Moedas.

Propriedade Tamanho Tipo Descrição Obrigatório
CodigoMoeda - Integer Código da Moeda. -
NomeMoeda - String Nome da Moeda. -

Testes cartão de crédito

Para realizar compra no cartão de crédito em modo de teste deve-se inserir as seguintes informações nos campos de pagamento cartão:

Bandeira: Mastercard
Número do Cartão de Crédito: 5448280000000007
Validade: 01/2028
Codigo de Segurança: 123

Credenciais de teste

Usuario: tes.te
Senha: tes.te

Changelog

13/01/2017
Método de cancelamento agora cancela as compras de cartão on-line, os cancelamentos serão reembolsados diretamente no cartão de crédito do cliente.
Pagamento via Boleto.

02/09/2015
Inclusão do campo ValorTotalPacote nos método Compra e SimulacaoCompra.
Inclusão dos campos IdadeMinima e IdadeMaxima nos objetos: BeneficioOpcionalCotado,BeneficioCustomizadoCotado e BeneficioProdutoCotado.

26/08/2014
Métodos adicionados:
 1. GetBeneficios
 2. ImprimeVouchersPorControle
 3. GetStatusVoucher
 4. GetStatusPorControle
 5. GetClassificacoes

Métodos adicionados:
 1. Compra
  • Inclusão dos campos: CelularContatoBrasil, CodigoEmissor, CodigoEmpresa, Identificacao, NomeContatoBrasil, NumeroControle, TelefoneContatoBrasil no objeto DadosBasicos
  • Inclusão do campo: Idade nos objetos DadosTitular, DadosIntegrantes, DadosPassageiroProdutoAvulso.
  • Exclusão dos campos: CelularContatoBrasil, CodigoEmissor, CodigoEmpresa, Identificacao, NomeContatoBrasil, NumeroControle, TelefoneContatoBrasil no objeto DadosProdutos.
  • Inclusão do campo: CodigoTarifaAcordo nos objetos DadosProdutos e DadosProdutosAvulsos.

 2. SimulacaoCompra:
  • Inclusão dos campos: DescricaoCompleta e Imagem nos objetos BeneficioCotacao e BeneficioOpcionalCotado.
  • Inclusão dos campos: Avulso e IdBeneficioDestaque no objeto ProdutoCotacao.
  • Inclusão do campo: BeneficioDestaque no objeto BeneficioProdutoCotado.
  • Inclusão do campo: Classificacoes.

Exemplos Requisição

Produto Folheto

Pagamento: Faturado

Produto: Principal

Produto Folheto

Pagamento: Faturado

Produto: Principal + Avulso