Obter Dados Pagamento¶

Web service para obter os dados de um pagamento do documento emitido MF-e pelo sistema VFP-e.

Para acessar o XSD clique aqui.

Exemplo de chamada¶

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

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

xPath	Descrição
ObterDadosPagamento	Grupo com informações do pagamento
ObterDadosPagamento/IdentificadorOperacaoPagamento	Identificador único para uma operação de pagamento informado anteriormente na operação de Enviar Pagamento

Resposta¶

Estrutura do xml de resposta.

Para acessar o XSD clique aqui.

Resposta de Erro¶

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

Resposta de Sucesso¶

<ObterDadosPagamentoResposta>
    <SituacaoOperacao>1</SituacaoOperacao>
    <DadosPagamento>
        <IdentificadorOperacaoPagamento>11111111-2222-3333-4444-555555555555</IdentificadorOperacaoPagamento>
        <CodigoAutorizacao>1234567890</CodigoAutorizacao>
        <Bin>12345678</Bin>
        <DonoCartao>DonoCartao</DonoCartao>
        <DataExpiracao>2018-01-01</DataExpiracao>
        <InstituicaoFinanceira>1</InstituicaoFinanceira>
        <Parcelas>1</Parcelas>
        <CodigoPagamento>67890</CodigoPagamento>
        <ValorPagamento>123,45</ValorPagamento>
        <IDFila>987654</IDFila>
        <Tipo>1</Tipo>
        <UltimosQuatroDigitos>1234</UltimosQuatroDigitos>
    </DadosPagamento>
</ObterDadosPagamentoResposta>

xPath	Descrição
ObterDadosPagamentoResposta	Grupo de resposta da operação de Obter Dados Pagamento
ObterDadosPagamentoResposta/SituacaoOperacao	Situação da operação 0 - Em Processamento 1 - Sucesso 2 - Erro 4 - Sem Resposta do Integrador Fiscal
ObterDadosPagamentoResposta/DadosPagamento	Grupo com os dados do pagamento
ObterDadpsPagamento/DadosPagamento/IdentificadorOperacaoPagamento	Identificador único para uma operação de pagamento informado anteriormente na operação Pagamento
ObterDadpsPagamento/DadosPagamento/CodigoAutorizacao	Código de Autorização do pagamento realizado e retornado pela Adquirente.
ObterDadpsPagamento/DadosPagamento/Bin	Sequencial de 6 Números iniciais do cartão fornecido pela adquirente.
ObterDadpsPagamento/DadosPagamento/DonoCartao	Nome do Titular do cartão fornecido pela adquirente.
ObterDadpsPagamento/DadosPagamento/DataExpiracao	Data de Validade do cartão fornecido pela adquirente.
ObterDadpsPagamento/DadosPagamento/InstituicaoFinanceira	Adquirente que realizou a aprovação do pagamento.
ObterDadpsPagamento/DadosPagamento/Parcelas	Quantidade de Parcelas aprovada no pagamento pela adquirente.
ObterDadpsPagamento/DadosPagamento/CodigoPagamento	Número Sequencial Único do pagamento fornecido pela adquirente.
ObterDadpsPagamento/DadosPagamento/ValorPagamento	Valor do Pagamento fornecido pela adquirente.
ObterDadpsPagamento/DadosPagamento/IDFila	NSU – Número Sequencial Único fornecido pela SEFAZ foi retornado na solicitação do pagamento.
ObterDadpsPagamento/DadosPagamento/Tipo	Tipo da Bandeira do cartão fornecido pela adquirente.
ObterDadpsPagamento/DadosPagamento/UltimosQuatroDigitos	Últimos 4 dígitos do cartão fornecido pelo adquirente.
ObterDadosPagamentoResposta/Erro	Grupo de erro
ObterDadosPagamentoResposta/Erro/Codigo	Código de erro
ObterDadosPagamentoResposta/Erro/Descricao	Descrição do erro