Enviar Pagamento¶
Web service para realizar o envio do pagamento para um documento emitido MF-e pelo sistema VFP-e.
Para acessar o XSD clique aqui
.
Exemplo de chamada¶
# POST
http://localhost:6679/api/mfe/enviarpagamento/
<EnviarPagamento versao="1.0">
<IdentificadorOperacaoPagamento>11111111-2222-3333-4444-555555555555</IdentificadorOperacaoPagamento>
<IdentificadorVenda>66666666-7777-8888-9999-000000000000</IdentificadorVenda>
<ChaveRequisicao>1234567890</ChaveRequisicao>
<Estabelecimento>0987654321</Estabelecimento>
<SerialPOS>1111111111</SerialPOS>
<IcmsBase>10.00</IcmsBase>
<ValorTotalVenda>123.45</ValorTotalVenda>
<HabMultiplosPgtos>true</HabMultiplosPgtos>
<HabCtrlAntiFraude>false</HabCtrlAntiFraude>
<CodigoMoeda>BRL</CodigoMoeda>
<EmitirCupomNfce>false</EmitirCupomNfce>
<OrigemPagamento>1</OrigemPagamento>
</EnviarPagamento>
xPath | Descrição |
---|---|
EnviarPagamento | Grupo com informações do Pagamento VFP-e |
EnviarPagamento/IdentificadorOperacaoPagamento | Identificador único para uma operação de pagamento |
EnviarPagamento/IdentificadorVenda | Identificador único de uma venda |
EnviarPagamento/ChaveRequisicao | Chave Guid que poderá ser gerada pela PDV/AC, esta chave deve identificar de forma única o CNPJ + Adquirente que irá processar o pagamento. |
EnviarPagamento/Estabelecimento | Código do Estabelecimento / MerchantID fornecido pela Adquirente contratada pelo Contribuinte. |
EnviarPagamento/SerialPOS | Número Serial do POS que será utilizado para o envio do Valor de cobrança para o equipamento POS, deverá existir no PDV/AC um cadastro de POS para que seja selecionada na venda um determinado POS, ou para todos os POS, em casos de AC/PDV que não utilizam TEF pode ser vinculado a esse cadastro a CHAVEREQUISICAO |
EnviarPagamento/IcmsBase | Deverá ser informado o valor da Base de Cálculo do ICMS, incluindo Base Isenta, Tributável e etc., em casos de serviços que não possuam base de ICMS não somar nesta TAG, vendas de produtos de recarga de celular, pagamento de contas, cartão vale presente que não estejam dentro de uma operação de venda com ICMS não deverá ser enviada essa informação a SEFAZ. |
EnviarPagamento/ValorTotalVenda | Deverá ser informado o valor da venda que será cobrado, este valor poderá ser somado a valores de serviços, gorjeta, recarga de celular, e etc. |
EnviarPagamento/HabMultiplosPgtos | Este recurso será usado para definir se haverá múltiplos pagamentos no processo de pagamento, muito comum quando é pago em múltiplos cartões e divisão de conta em restaurante. |
EnviarPagamento/HabCtrlAntiFraude | Este processo será usado para validação de possíveis fraudes no pagamento, verificando uma base histórica. |
EnviarPagamento/CodigoMoeda | Informa a Moeda que será pago a venda. Utilizar tabela ISO 4217. Real = BRL |
EnviarPagamento/EmitirCupomNfce | Permitirá que o NFC-e seja emitido diretamente por equipamentos POS ou MPOS. |
EnviarPagamento/OrigemPagamento | Esta informação servirá para que as informações apresentadas no equipamento de pagamento possa ser consultada em lista, permitindo assim uma maior flexibilidade no processo de pagamento e um maior controle ao cliente e aos contribuintes. |
Resposta¶
Estrutura do xml de resposta.
Para acessar o XSD clique aqui
.
Resposta de Erro¶
<EnviarPagamentoResposta>
<SituacaoOperacao>2</SituacaoOperacao>
<Erro>
<Codigo>10999</Codigo>
<Descricao>Erro inesperado - 'AGENTE'. Código: 30006. Descrição: O conteúdo não corresponde a uma estrutura de XML. Conteúdo: <EnviarPagamento versao="1">0118</Modelo></EnviarPagamento>. Correção: Informe uma estrutura de um XML válido.</Descricao>
</Erro>
</EnviarPagamentoResposta>
Resposta de Sucesso¶
<EnviarPagamentoResposta>
<SituacaoOperacao>1</SituacaoOperacao>
</EnviarPagamentoResposta>
xPath | Descrição |
---|---|
EnviarPagamentoResposta | Grupo de resposta da operação de Enviar Pagamento |
EnviarPagamentoResposta/SituacaoOperacao | Situação da operação
|
EnviarPagamentoResposta/Erro | Grupo de erro |
EnviarPagamentoResposta/Erro/Codigo | Código de erro |
EnviarPagamentoResposta/Erro/Descricao | Descrição do erro |