Obter Pagamento¶

Web service para obter o pagamento enviado de um documento emitido MF-e pelo sistema VFP-e.

Para acessar o XSD clique aqui.

Exemplo de chamada¶

# POST
http://localhost:6679/api/mfe/obterpagamento/

<ObterPagamento versao="1.0">
    <IdentificadorOperacaoPagamento>11111111-2222-3333-4444-555555555555</IdentificadorOperacaoPagamento>
</ObterPagamento>

xPath	Descrição
ObterPagamento	Grupo com informações para obtenção do Pagamento VFP-e
ObterPagamento/IdentificadorOperacaoPagamento	Identificador único para uma operação de pagamento

Resposta¶

Estrutura do xml de resposta.

Para acessar o XSD clique aqui.

Resposta de Erro¶

<ObterPagamentoResposta>
    <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: &lt;ObterPagamento versao="1"&gt;0118&lt;/Modelo&gt;&lt;/ObterPagamento&gt;. Correção: Informe uma estrutura de um XML válido.</Descricao>
    </Erro>
</ObterPagamentoResposta>

Resposta de Sucesso¶

<ObterPagamentoResposta>
    <SituacaoOperacao>1</SituacaoOperacao>
    <IdPagamento>123456</IdPagamento>
</ObterPagamentoResposta>

Resposta de Sucesso Offline¶

<ObterPagamentoResposta>
    <SituacaoOperacao>3</SituacaoOperacao>
    <IdPagamento>123456</IdPagamento>
</ObterPagamentoResposta>

xPath	Descrição
ObterPagamentoResposta	Grupo de resposta da operação de Obter Pagamento
ObterPagamentoResposta/SituacaoOperacao	Situação da operação 0 - Em Processamento 1 - Sucesso 2 - Erro 3 - Em Processamento Offline
ObterPagamentoResposta/IdPagamento	Identificação do pagamento gerado pelo IntegradorFiscal da Sefaz CE
ObterPagamentoResposta/Erro	Grupo de erro
ObterPagamentoResposta/Erro/Codigo	Código de erro
ObterPagamentoResposta/Erro/Descricao	Descrição do erro