Ir para o conteúdo

Consultar Transação

Recuperar Transação por ID

Este endpoint permite recuperar uma transação utilizando seu id como referência.

Escopo requerido

Valor Descrição
open:sac-transaction-seller:read Permite a utilização das APIs de leitura de transação.

Parâmetros da URL

Campo Tipo Descrição Obrigatório
id string Identificador único da transação. Sim

Chamada

curl -X 'GET' \
  'https://api.magalu.com/seller/v0/transactions/{id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Parâmetros da resposta

Campo Tipo Descrição
created_at String Data de criação.
updated_at String Data de atualização.
id String Chave UUID da transação.
code String Código da transação.
operation Object Operação da transação.
trigger_endpoint String Endpoint de origem.
status String Status da transaction. Pode ser: pending, processing, completed, failed, cancelled.
events List Lista de eventos da transação.
events.event List Evento da transação. Pode ser: info, failure, transition, delay.
events.message String Mensagem da atualização.
events.data String Data do evento da transação.
events.data.ticket_id String Identificador UUID do ticket.
events.status String Status do evento da transação. Pode ser: pending, processing, completed, failed, cancelled.
events.created_at String Data de criação do evento.

Resposta:

{
  "created_at": "2024-11-08T11:49:35.938000",
  "updated_at": "2024-11-08T11:49:35.938000",
  "id": "5d3ca96b-cdab-4770-8f8a-1afc66a24274",
  "code": "5D3CA96B",
  "operation": "create",
  "trigger_endpoint": "channel/v0/tickets",
  "status": "completed",
  "events": [
    {
      "event": "transition",
      "message": "Criação de ticket bem sucedida",
      "data": {
        "ticket_id": "8f6a64a6-0b9e-5c1c-8242-34828585f0dc"
      },
      "status": "completed",
      "created_at": "2024-11-08T11:49:52.489000"
    }
  ]
}

Códigos de retorno

Código Descrição
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Acompanhar o andamento de uma transação

A transação é um fluxo assíncrono e o andamento da mesma, pode ser acompanhado. Consulte a documentação sobre fluxos assíncronos e transações para entender mais sobre o processo.