Faturas Retorno

Endpoint para reportarmos o retorno de um pagamento.

Este método é responsável para enviar ao ERP os dados do processamento do pagamento. Este retorno pode ser POSITIVO ou NEGATIVO e deverá ser tratado na API do ERP.

Ou seja, conceitualmente após o fim da transação iremos redirecionar uma requisição com o retorno da transação, tendo sido finalizada com sucesso ou não.

O endpoint deverá ser um POST /api/financeiro/retorno e terá o seguinte objeto na requsição:

//RESPONSÁVEL: SAURUS
{
    "faturas":[
        {
            "numeroFatura":"10", //CAMPO STRING >> Identificação do fatura (Único)
            "historico":"Pedido de Venda 15",
            "valorFatura":100,
            "pagamentoParcial": true, //Aceita receber parte do Valor
            "pessoa: {
                "cpfCnpj":"xxx",
                "codigo" : 10 , //Codigo do cliente
                "nome": "NOME DO CLIENTE" //FORMATAVEL
            }
        }],  
    "valorTotal":1000,
    "resultadoTransacao":
    {
        "IdTransacao": "832A4F83B1",
        "NSU": "112076329100",
        "CodAut": "ba9505e991",
        "CodControle": "4CDCE90DEF854D9090AA4498CE61D7F5",
        "DRetorno": "2024-01-01 00:00:00",
        "NumCartao": "589916******2018",
        "Bandeira": "MASTERCARD",
        "Rede": "Maestro",
        "Adquirente": "SAFRAPAY_API",
        "ValorPagamento": "22.0",
        "ModPagamento": 4,
        "QtdeParcelas": 1,
        "DTransacao": "2024-01-01 01:00:00",,
        "Status": 1,
        "MsgRetorno": "Transação Aprovada",
        "ArqRetorno": "" //ARQUIVO RETORNO (RAW) DA ADQUIRENTE,
    }
}

O retorno esperado pela API do ERP será 200 - OK com o objeto:

//RESPONSÁVEL: ERP
{
    "id":"1010101" //ID DO PROTOCOLO DE PROCESSAMENTO CONFIRMADO O RECEBIMENTO
}

Este protocolo esperado se deve pela necessidade de realizarmos a sincronização das transações em serviços de background para cobrirmos possíveis falhas de internet ou retentativas.

**Usualmente será enviado após a transação, mas poderá ser feito em background

Last updated