TRANSAÇÃO

Endpoints

Buscar transações

GET /transaction

Descrição: Retorna transações com base nos filtros fornecidos. Caso não seja passado nenhum filtro de data, o padrão de busca é retornar dados dos últimos 30 dias utilizando data de transação como referência.

GET /public/transaction?startDate=2024-01-01&endDate=2024-01-31 HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

  • 200 OK: Retorna uma lista de transações.
  • 400 Bad Request: Parâmetros inválidos.
  • 404 Not Found: Nenhuma transação encontrada.

Objeto de Retorno:

Criar transação

POST /transaction

Descrição: Cria uma nova transação. É necessário ter cadastrado previamente a unidade e o colaborador.

POST /public/transaction HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "amount": 1,
  "store_id": 1,
  "employee_id": 1,
  "customer_id": 1,
  "register_date": "text",
  "journey": "text",
  "transaction_id": "text",
  "rating_items": [
    {
      "class_id": 2312,
      "score": 10
    },
    {
      "class": "teste",
      "score": 10
    }
  ],
  "param_{key}": "text",
  "param_{key2}": "text",
  "param_{key3}": "text"
}

Respostas:

  • 201 Created: Transação criada com sucesso.
  • 422 Unprocessable Entity: Erro de validação.

Buscar transação por id

GET /transaction/{id}

Descrição: Retorna uma transação com base no id fornecido.

GET /public/transaction/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

  • 200 OK: Retorna a transação.
  • 400 Bad Request: ID inválido.
  • 404 Not Found: Transação não encontrada.

Estornar transação por id

DELETE /transaction/{id}

Descrição: Estorna uma transação, removendo-a dos relatórios, mas mantendo-a no sistema.

DELETE /public/transaction/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

  • 200 OK: Transação estornada com sucesso.
  • 400 Bad Request: Transação não encontrada.

Anonimizar transação em massa por id externo

DELETE /transaction

Descrição: Anonimiza as transações.

DELETE /public/transaction HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: string
Accept: */*

Respostas:

  • 200 OK: Transação estornada com sucesso.
  • 400 Bad Request: Transação não encontrada.

Usando transactionId para consultas assertivas:

Para a Infraestrutura atual, consultas que somam transações em períodos longos são grande ofensores, pois sobrecarrega nossos servidores e geram lentidão tanto na consulta em questão quanto nas próximas, portanto orienta-se:

  • Consultas que fazem uma varredura quantitativa (count) ou search dentro de um intervalo de tempo, que seja usado como parâmetro de busca o transactionId:
curl --request GET \
--url 'https://api.solucx.com.br/public/transaction?token=1&date_to=2024-04-31&date_from=2024-04-01&transactionId=123' \
-H 'Content-Type: application/json' \
-H 'x-solucx-api-key:x-solucx-api-key'
SoluCX API
Transação V2