Rotas API

Registra Venda

Registro de venda do cliente

Este serviço tem a função de registrar as vendas feitas pelo cliente na base de dados do Conciliador, o objetivo é permitir a confrontação dos dados das vendas registradas pelo cliente com os dados das vendas acatadas pelas administradoras de cartão. Essa confrontação se dá no Conciliador, através desta funcionalidade o cliente verifica por exemplo se alguma venda efetuada não foi acatada pela administradora. O quadro abaixo demonstra quais os parâmetros requeridos e exemplifica um caso prático de consulta.

URI de exemplo

POST ws.datapaytecnologia.com :3000 /br-ws/integrador/json/registraVendaClienteBR

Solicitação - Cadastro de Venda

Cabeçalhos
Content-Type: application/x-www-form-urlencoded
Corpo
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": {
                   "nsuLote":31,
                   "nrVendas": "2",
                   "codigoCliente": "593",
                   "totalVendas": "20",
                   "vendas": [
                   {
                   "nsuOrigem": "ABC12345",
                   "nsuAdministradora": "2003801",
                   "nrAutorizacao": "757390",
                   "redeAdquirente": "1",
                   "data": "2017-10-29",
                   "formaCaptura": "TEF",
                   "valor": "10",
                   "nrParcelas": "2",
                   "bandeira": "5",
                   "modalidade": "2"
                   },
                   {
                   "nsuOrigem": "ABC123456",
                   "nsuAdministradora": "2003803",
                   "nrAutorizacao": "757390",
                   "redeAdquirente": "1",
                   "data": "2017-10-29",
                   "formaCaptura": "POS",
                   "valor": "10",
                   "nrParcelas": "2",
                   "bandeira": "5",
                   "modalidade": "2"
                   }
                ]
            }
        }
}

Resposta 200

Cabeçalhos
Content-Type: application/json
Corpo
{
  "codigoRetorno": "MSG_001",
  "detalheRetorno": {
    "VendasInseridas": "0",
    "VendasConciliadas": "99",
    "VendasJaInseridas": "0"
  },
  "codigoRequisicao": 85584324
}

Consulta Venda Cliente

Consulta Venda do Cliente

Este serviço tem a função de obter as vendas feitas pelo cliente na base de dados do Conciliador, o objetivo é disponibilizar os dados das vendas registradas pelo próprio cliente.

URI de exemplo

POST ws.datapaytecnologia.com:3000/br-ws/integrador/json/consultaVendaCliente

Request - Consulta Venda Cliente

Headers
Content-Type: application/x-www-form-urlencoded
Body
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "dataVendaInicial": "2017-10-29",
                 "dataVendaFinal": "2017-10-29"
               }

}

Response 200

Headers
Content-Type: application/json
Body
{
  "codigoRetorno": "MSG_001",
  "detalheRetorno": "Requisicao atendida com sucesso!",
  "codigoRequisicao": 85603839,
  "nrPaginaAtual": 1,
  "nrTotalPagina": 1,
  "vendas": [
    {
      "nsuOrigem": "ABC12345",
      "nsuAdministradora": "2003801",
      "nrAutorizacao": "757390",
      "redeAdquirente": 1,
      "data": "2017-10-29 00:00:00",
      "nrCartao": null,
      "loja": null,
      "codigoLoja": null,
      "formaCaptura": null,
      "codigoEstabelecimento": 0,
      "chaveVenda": 18357860,
      "valor": 10,
      "nrParcelas": 2,
      "bandeira": "5",
      "codigoProduto": null,
      "produto": null,
      "modalidade": "2",
      "banco": 0,
      "agencia": 0,
      "conta": 0
    },
    {
      "nsuOrigem": "ABC123456",
      "nsuAdministradora": "2003803",
      "nrAutorizacao": "757390",
      "redeAdquirente": 0,
      "data": "2017-10-29 00:00:00",
      "nrCartao": null,
      "loja": null,
      "codigoLoja": null,
      "formaCaptura": null,
      "codigoEstabelecimento": 0,
      "chaveVenda": 18357861,
      "valor": 10,
      "nrParcelas": 2,
      "bandeira": "5",
      "codigoProduto": null,
      "produto": null,
      "modalidade": "2",
      "banco": 0,
      "agencia": 0,
      "conta": 0
    }
  ]
}

Consulta Venda Administradora

Consulta Vendas / Recebimentos da Administradora

Este serviço tem a função de obter as vendas registradas pelas operadoras disponíveis na base de dados do Conciliador, o objetivo é disponibilizar os dados das vendas acatadas pelas operadoras com informações precisas de valores de parcelas, datas de credito e demais informações geradas pela administradora.

Example URI

POST ws.datapaytecnologia.com:3000/br-ws/integrador/json/consultaVendaAdm

Request - Consulta Venda Administradora

Headers
Content-Type: application/x-www-form-urlencoded
Body
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "dataVendaInicial": "2017-10-29",
                 "dataVendaFinal": "2017-10-29"
               }

}

Response 200

Headers
Content-Type: application/json
Body
{
                "codigoRetorno": "MSG_001",
                "detalheRetorno": "Requisicao atendida com sucesso!",
                "codigoRequisicao": 85664532,
                "nrPaginaAtual": 1,
                "nrTotalPagina": 3,
                "vendas": [
                       {
                       "nsuOrigem": null,
                       "nsuAdministradora": "184390972",
                       "nrAutorizacao": "084692",
                       "redeAdquirente": 2,
                       "data": "2016-04-25 14:24:52",
                       "nrCartao": "422100******0234",
                       "loja": "LOJA 02 - CENTRO",
                       "codigoLoja": 5618,
                       "formaCaptura": "POS",
                       "codigoEstabelecimento": 57225966,
                       "chaveVenda": 34398973,
                       "valor": 1000,
                       "nrParcelas": 5,
                       "bandeira": "1",
                       "codigoProduto": 1,
                       "produto": "Visa",
                       "modalidade": "2",
                       "banco": 237,
                       "agencia": 5611,
                       "conta": 74772,
                       "parcelas": [
                            {
                            "nsuOrigem": null,
                            "dataCredito": "2017-03-01 00:00:00",
                            "status": 3,
                            "numero": 10,
                            "dataPagamento": "2017-03-01 00:00:00",
                            "dataCancelamento": null,
                            "valorTaxaAdministracao": 2.5,
                            "percTaxaAdministracao": 0.025,
                            "valorTaxaAntecipacao": 0,
                            "percTaxaAntecipacao": 0,
                            "percTaxaAntecipacaoNominal": 0,
                            "valorAjuste": 0,
                            "valorPago": 97.5,
                            "valor": 100,
                            "chaveParcela": 9814246
                            }
                ]
                }

Consulta Recebimentos

Consulta Recebimentos

Este serviço tem a função de obter todas as vendas e parcelas que foram pagas pelas adquirentes.

Example URI

POST ws.datapaytecnologia.com:3000/br-ws/integrador/json/consultaRecebimento

Request - Consulta Recebimento

Headers
Content-Type: application/x-www-form-urlencoded
Body
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "dataInicial":"2020-12-09",
                 "dataFinal":"2020-12-09",
                 "periodo":"pagamento"
               }
}

Response 200

Headers
Content-Type: application/json
Body
{
  "codigoRetorno": "MSG_001",
  "detalheRetorno": "Requisicao atendida com sucesso!",
  "codigoRequisicao": 13550289,
  "nrTotalPagina": 60,
  "nrPaginaAtual": 1,
  "recebimentos": [
    {
      "data_venda": "2020-07-09",
      "datacredito": "2020-12-09",
      "status": 2,
      "Parcela": 5,
      "DataPagamento": "2020-12-09",
      "data_cancelamento": null,
      "valorTaxaAdministracao": 1.07,
      "percTaxaAdministracao": 1.79,
      "valorTaxaAntecipacao": 0,
      "percTaxaAntecipacao": 0,
      "perTaxaAntecipacaoNominal": 0,
      "valorAjuste": 0,
      "valorPago": 58.93,
      "valor": 60,
      "chaveParcela": 13748184905,
      "loja_cnpj": "000.000.80/0001-00",
      "codTefLoja": "",
      "dataReferencia": "2020-12-09",
      "nsu": 376306935,
      "autorizacao": "010131",
      "codigoLoja": 148
    },
    {
      "data_venda": "2020-07-09",
      "datacredito": "2020-12-09",
      "status": 2,
      "Parcela": 5,
      "DataPagamento": "2020-12-09",
      "data_cancelamento": null,
      "valorTaxaAdministracao": 2.29,
      "percTaxaAdministracao": 2.29,
      "valorTaxaAntecipacao": 0,
      "percTaxaAntecipacao": 0,
      "perTaxaAntecipacaoNominal": 0,
      "valorAjuste": 0,
      "valorPago": 97.71,
      "valor": 100,
      "chaveParcela": 13748208405,
      "loja_cnpj": "000.000.80/0001-00",
      "codTefLoja": "",
      "dataReferencia": "2020-12-09",
      "nsu": 626582565,
      "autorizacao": "373859",
      "codigoLoja": 77
    }
  ]
}

Exclusão Venda do Cliente

Exclusão de Venda do Cliente

Este serviço tem a função de excluir registros de vendas feitas pelo cliente na base de dados do Conciliador.

Example URI

POST ws.datapaytecnologia.com:3000/br-ws/integrador/json/excluiVendaCliente

Request - Consulta Exclui venda cliente

Headers
Content-Type: application/x-www-form-urlencoded
Body
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "venda": 
             {
                "nsuOrigem": " ABC123456",
                "data ": "2017-10-29"
                "valor ": "10"
             }

}

Response 200

Headers
Content-Type: application/json
Body
{
  "codigoRetorno": "NGC_022",
  "detalheRetorno": "Não foi encontrada nenhuma venda com o nsuOrigem, data e valor passados",
  "codigoRequisicao": 88970778
}

Consulta Chargeback Cliente

Consulta Chargeback do Cliente

Este serviço tem a função de obter os chargebacks do cliente na base de dados do Conciliador, o objetivo é disponibilizar os dados dos chargebacks.

Example URI

POST ws.datapaytecnologia.com :3000 /br-ws/integrador/json/consultaChargeback

Solicitação - Consulta Estorno Cliente

Cabeçalhos
Content-Type: application/x-www-form-urlencoded
Corpo
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "dataCbackInicial": "2022-11-01",
                 "dataCbackFinal": "2022-12-01"
               }

}

{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "dataVendaInicial": "2022-11-01",
                 "dataVendaFinal": "2022-12-01"
               }

}

{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "codigoRequisicao": "25166685",
                 "nrPagina": "1"
               }

}

Resposta 200

Cabeçalhos
Content-Type: application/json
Corpo
{
  "codigoRetorno": "MSG_001",
  "detalheRetorno": "Requisicao atendida com sucesso!",
  "codigoRequisicao": 25207074,
  "nrTotalPagina": 1,
  "nrPaginaAtual": 1,
  "vendascCback": {
    "chargebacks": [
      {
        "nsuAdministradora": 134168795,
        "nrAutorizacao": "692905",
        "redeAdquirente": 8,
        "dataVenda": "2022-11-16",
        "dataChargeback": "2022-11-26",
        "dataLimiteEnvio": "2022-12-10",
        "nrCartao": "651652XXXXXX7057",
        "codigoLoja": 3,
        "loja": "LOJA 03 -  UNIFAMETRO FORTALEZA - PORTAL / APP",
        "cnpjLoja": 3884793000147,
        "terminal": "RO945140",
        "codigoEstabelecimento": 6,
        "motivoChargeback": "Solicitação do comprovante documentos ",
        "valor": 924.84,
        "nrParcelas": 2,
        "bandeira": 11,
        "codigoProduto": 6,
        "produto": "Elo Crédito",
        "modalidade": 2,
        "TID": null
      }
    ]
  }
}

Consulta Cancelamento Cliente

Consulta Cancelamento do Cliente

Este serviço tem a função de obter os cancelamento do cliente na base de dados do Conciliador, o objetivo é disponibilizar os dados dos chargebacks.

URIs de exemplo

POST ws.datapaytecnologia.com :3000 /br-ws/integrador/json/consultaCancelamento

Solicitação - Consulta Cancelamento

Cabeçalhos
Content-Type: application/x-www-form-urlencoded
Corpo
{
  "versao": "1.1" ,
  "token":  v021380b67d320170ab24 ,
  "loteVenda": 
               {
                 "dataCancelInicial": "2023-03-03",
                 "dataCancelFinal": "2023-03-30"
               }

}

Resposta 200

Cabeçalhos
Content-Type: application/json
Corpo
{
  "codigoRetorno": "MSG_001",
  "detalheRetorno": "Requisicao atendida com sucesso!",
  "codigoRequisicao": 25210326,
  "nrTotalPagina": 3,
  "nrPaginaAtual": 1,
  "VendasCanceladas": {
    "Cancelamentos": [
      {
        "nsuAdministradora": 877369331,
        "nrAutorizacao": "729420",
        "redeAdquirente": 8,
        "dataVenda": "2022-10-27",
        "dataCancelamento": "2023-03-06",
        "nrCartao": "444456XXXXXX0775",
        "codigoLoja": 3,
        "loja": "LOJA 03 -  UNIFAMETRO FORTALEZA - PORTAL / APP",
        "cnpjLoja": 3884793000147,
        "terminal": "RO948438",
        "codigoEstabelecimento": 6,
        "valor": 195.45,
        "nrParcelas": 6,
        "bandeira": 21,
        "codigoProduto": 35,
        "produto": "Visa Crédito",
        "modalidade": "Credito",
        "tipoCancelamento": "Parcial",
        "TID": null,
        "parcelas": {
          "parcela": [
            {
              "dataCredito": "2022-11-28",
              "status": 1,
              "numero": 1,
              "dataPagamento": "2022-11-28",
              "dataCancelamento": "",
              "valorLiqOriginal": null,
              "valorBrutoOriginal": null,
              "dataUltCancParcial": null,
              "valorCancelamento": null,
              "valorTaxaAdministracao": 0.98,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 64.15,
              "valor": 65.13,
              "chaveParcela": 5489131801
            },
            {
              "dataCredito": "2022-12-27",
              "status": 12,
              "numero": 2,
              "dataPagamento": "2022-12-27",
              "dataCancelamento": "",
              "valorLiqOriginal": null,
              "valorBrutoOriginal": null,
              "dataUltCancParcial": null,
              "valorCancelamento": null,
              "valorTaxaAdministracao": 0.98,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 64.18,
              "valor": 65.16,
              "chaveParcela": 5489131802
            },
            {
              "dataCredito": "2023-01-27",
              "status": 12,
              "numero": 3,
              "dataPagamento": "2023-01-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 53.48,
              "valorBrutoOriginal": -106.96,
              "dataUltCancParcial": "2023-01-03",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -128.37,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 42.79,
              "valor": -85.58,
              "chaveParcela": 5489131803
            },
            {
              "dataCredito": "2023-02-27",
              "status": 12,
              "numero": 4,
              "dataPagamento": "2023-02-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 42.79,
              "valorBrutoOriginal": -85.58,
              "dataUltCancParcial": "2023-02-03",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -96.3,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 32.1,
              "valor": -64.2,
              "chaveParcela": 5489131804
            },
            {
              "dataCredito": "2023-03-27",
              "status": 2,
              "numero": 5,
              "dataPagamento": "2023-03-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 32.1,
              "valorBrutoOriginal": -64.2,
              "dataUltCancParcial": "2023-03-06",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -64.23,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 21.41,
              "valor": -42.82,
              "chaveParcela": 5489131805
            },
            {
              "dataCredito": "2023-04-27",
              "status": 1,
              "numero": 6,
              "dataPagamento": "2023-04-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 32.1,
              "valorBrutoOriginal": -64.2,
              "dataUltCancParcial": "2023-03-06",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -64.23,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 21.41,
              "valor": -42.82,
              "chaveParcela": 5489131806
            }
          ]
        }
      },
      {
        "nsuAdministradora": 877369331,
        "nrAutorizacao": "729420",
        "redeAdquirente": 8,
        "dataVenda": "2022-10-27",
        "dataCancelamento": "2023-03-06",
        "nrCartao": "444456XXXXXX0775",
        "codigoLoja": 3,
        "loja": "LOJA 03 -  UNIFAMETRO FORTALEZA - PORTAL / APP",
        "cnpjLoja": 3884793000147,
        "terminal": "RO948438",
        "codigoEstabelecimento": 6,
        "valor": 195.45,
        "nrParcelas": 6,
        "bandeira": 21,
        "codigoProduto": 35,
        "produto": "Visa Crédito",
        "modalidade": "Credito",
        "tipoCancelamento": "Parcial",
        "TID": null,
        "parcelas": {
          "parcela": [
            {
              "dataCredito": "2022-11-28",
              "status": 1,
              "numero": 1,
              "dataPagamento": "2022-11-28",
              "dataCancelamento": "",
              "valorLiqOriginal": null,
              "valorBrutoOriginal": null,
              "dataUltCancParcial": null,
              "valorCancelamento": null,
              "valorTaxaAdministracao": 0.98,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 64.15,
              "valor": 65.13,
              "chaveParcela": 5489144901
            },
            {
              "dataCredito": "2022-12-27",
              "status": 12,
              "numero": 2,
              "dataPagamento": "2022-12-27",
              "dataCancelamento": "",
              "valorLiqOriginal": null,
              "valorBrutoOriginal": null,
              "dataUltCancParcial": null,
              "valorCancelamento": null,
              "valorTaxaAdministracao": 0.98,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 64.18,
              "valor": 65.16,
              "chaveParcela": 5489144902
            },
            {
              "dataCredito": "2023-01-27",
              "status": 12,
              "numero": 3,
              "dataPagamento": "2023-01-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 53.48,
              "valorBrutoOriginal": -106.96,
              "dataUltCancParcial": "2023-01-03",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -128.37,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 42.79,
              "valor": -85.58,
              "chaveParcela": 5489144903
            },
            {
              "dataCredito": "2023-02-27",
              "status": 12,
              "numero": 4,
              "dataPagamento": "2023-02-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 42.79,
              "valorBrutoOriginal": -85.58,
              "dataUltCancParcial": "2023-02-03",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -96.3,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 32.1,
              "valor": -64.2,
              "chaveParcela": 5489144904
            },
            {
              "dataCredito": "2023-03-27",
              "status": 2,
              "numero": 5,
              "dataPagamento": "2023-03-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 32.1,
              "valorBrutoOriginal": -64.2,
              "dataUltCancParcial": "2023-03-06",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -64.23,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 21.41,
              "valor": -42.82,
              "chaveParcela": 5489144905
            },
            {
              "dataCredito": "2023-04-27",
              "status": 1,
              "numero": 6,
              "dataPagamento": "2023-04-27",
              "dataCancelamento": "",
              "valorLiqOriginal": 32.1,
              "valorBrutoOriginal": -64.2,
              "dataUltCancParcial": "2023-03-06",
              "valorCancelamento": 65.15,
              "valorTaxaAdministracao": -64.23,
              "percTaxaAdministracao": 1.5,
              "valorTaxaAntecipacao": 0,
              "percTaxaAntecipacao": 0,
              "percTaxaAntecipacaoNominal": 0,
              "valorAjuste": 0,
              "valorPago": 21.41,
              "valor": -42.82,
              "chaveParcela": 5489144906
            }
          ]
        }
      }
    ]
  }
}