DVARINT1-7488 | PDVSync.Server.Controle - POST ProcessoOnlineCredito - Criar lista

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Objetivo

• Devemos ajustar o request e response para poder receber e retornar uma lista de dados.
• Incluir campo idRetaguardaCredito  no payload de response da API de POST do ProcessoOnlineCredito.

Descrição

• Em um primeiro momento não havíamos levado em consideração que um cliente poderia utilizar mais de um crédito de uma só vez.
• Devemos ajustar o payload de request para que seja possível enviar mais de um solicitação de crédito
  • Novo payload de request

    • {
          "idInquilino": "string",
          [
              {
                  "cpfCnpj": "string",
                  "idRetaguardaCredito": "string",
                  "idRetaguardaLojaConsulta": "string",
                  "idRetaguardaLojaBaixa": "string",
                  "tipo": [
                      "string"
                  ],
                  "valorBaixa": 0,
                  "idRetaguardaUsuario": "string",
                  "dataAtualizacao": "2023-09-14T20:04:25.159Z",
                  "dataCadastro": "2023-09-14T20:04:25.159Z",
                  "id": "string"
              }
          ]
      }

• Novo payload de response

  • {
        "success": true,
        "message": "string",
        "data": [
            {
                "saldo": 0,
                "idRetaguardaCredito": "string",
            }
        ]
    }

Critérios de aceite

• Evidenciar a adição do novos payloads no swagger.
• Retorno de sucesso com relação a utilização do crédito no Protheus e WSH.
• Retorno de erro transparente, retorno com a mensagem de erro da retaguarda ser o mesmo disponibilizado pelo PDVSync, com relação a utilização do crédito no Protheus e WSH.

Observação

• Solicitar para a Beatriz os dados de comunicação com o WSH.
• Caso o WSH ainda não tiver, deixar claro na issue que o WSH ainda não tem a API pronta, e deveremos evidenciar apenas o que tange ao Protheus. E uma nova issue será criada.
• O novo payload esta em anexo.
• Comunicar time do PDV com relação a mudança efetivada em ambiente de homologação.

03. SOLUÇÃO

• Conforme solicitado foi alterado o objeto de consulta de crédito para enviar uma lista.
• Foram alterado os controllers das versões 1 e 2.
• A url da requisição não sofreu alteração.

Detalhes do endpoint

POST

URL: api/pdvsyncserver/retaguarda/v2/processoonlinecredito

Exemplo de body da requisição

{
    "idInquilino": "string",
    "creditos": [
        {
            "cpfCnpj": "string",
            "idRetaguardaCredito": "string",
            "idRetaguardaLojaConsulta": "string",
            "idRetaguardaLojaBaixa": "string",
            "idRetaguardaUsuario": "string",
            "tipo": [
                "string"
            ]
        }
    ]
}

Definição dos campos de requisição

Retornos

• HTTP 200 - ok

{
    "success": true,
    "message": "",
    "data": [
        {
            "saldo": 948.0,
            "idRetaguardaCredito": "01PSH00000005664CR",
            "_expandables": []
        }
    ]
}

• HTTP 400 - Bad Request