CTeEnviarVincPgto

Sintaxe

Move (CTeEnviarVincPgto({&vParams})) to {bRetorno}

Onde:

• {vParams} é uma variável do tipo tCTeEnviarVincPgto, onde cada campo contém um parâmetro a ser passado ou um retorno que será recebido;
  • sSiglaWS: é a sigla do Web Service para o qual será enviada a solicitação.
  • iTpAmb: indica o ambiente onde a consulta será feita, sendo 1-Produção e 2-Homologação.
  • sVersao: é a versão do arquivo XML a ser enviado. Caso não seja informado será atribuído “4.00”.
  • sArquivoDestino é o nome com o caminho completo onde será salvo o XML quando vinculado com sucesso.
  • sNomeCertificado: é a string que representa o certificado digital que será usado na transmissão dos dados. Se não for informado, uma tela será exibida para o usuário escolher um dos certificados instalados. Você pode obter esta string e armazená-la em um campo de sua base de dados com a função CTePegaNomeCertificado.
  • sChaveCTe: é a chave do CT-e para o qual deseja vincular o pagamento.
  • iNroVincPgto: é o número sequencial do evento (de 1 a 99) e deve ser controlado pelo desenvolvedor.
  • snProtAutorizacao: é o protocolo de autorização do CT-e.
  • iInPag: é o numerador único de cada ocorrência de pagamento.
  • sIdTransacao: é o identificador específico da transação financeira, de acordo com a transação de pagamento.
  • iTpMeioPgto: é o código do meio de pagamento utilizado.
  • sCNPJReceb: é o o CNPJ completo do recebedor do pagamento (fornecedor, plataforma, ou outra entidade).
  • sCNPJBasePSP: é o CNPJ base da instituição financeira ou de pagamento utilizada pelo recebedor do pagamento.
  • sDhEvento: é a data e hora do evento Formato = AAAA-MM-DDTHH:MM:SS TZD. Se não informado será atribuído pelos sistema.
  • sProxy: é usado para informar ’http://proxyserver:port’ quando existir uso de proxy no ambiente. Verificar com o cliente qual é o endereço do servidor proxy e a porta https, a porta padrão do https é 443 e, sendo assim, teríamos algo do tipo ’http://192.168.15.1:443’.
  • sUsuario: é usado para informar o usuário para autenticação no proxy, se necessário.
  • sSenha: é usado informar a senha de autenticação no proxy, se necessário.
  • sLicenca: é usado para informar a chave da licença da CTeLibrary.DLL. Esta função pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento. Entre em contato conosco para obter a chave de licença.
  • bExibeErro: indica se a função deve exibir os erros que ocorrerem (True) ou não (False).
  • sRetMsgDados: neste campo a função retorna a mensagem XML completa que foi enviada para o WS.
  • sRetMsgRetWS: neste campo a função retorna a mensagem XML completa que foi devolvida pelo WS.
  • iRetCodRetorno: neste campo a função retorna o código que representa o resultado do envio, onde 0 (zero) indicando que foi executado com sucesso.
  • sRetMsgResultado: neste campo a função retorna o resultado literal da execução.
  • sRetnProtocolo: neste campo a função retorna o número do protocolo da vinculação do pagamento.
  • sRetdProtocolo: neste campo a função retorna a data e hora de do evento.
  • bRetSalvou: neste campo a função retorna se o XML retornado pelo Web service foi salvo com sucesso.
• {bRetorno} é o retorno da chamada da função. True indica que que o Web service foi consumido com sucesso. Deve ser consulte o campo iRetCdRetorno para identificar resultado do processo.

Observação

• A função está disponível a partir da versão 2026/01.