Simulação de cenários

Esta página descreve como simular a atualização do status de rastreamento de cartões pós-pagos para testar o fluxo de atualizações de entrega. Essas simulações são úteis para homologação e testes de integração.

Informação

Essas requisições simulam atualizações de status de rastreamento e retornam o status HTTP com os dados atualizados do rastreamento.

1 - Simulação de atualização de status de rastreamento

Simula a atualização do status de rastreamento de um cartão pós-pago, permitindo transicionar entre diferentes estados do processo de entrega. A atualização cria um novo evento no histórico de rastreamento.

ENDPOINT

/mock/wallet/WALLET_KEY/card/CARD_KEY/tracking

MÉTODO

PATCH

Path Parameters

Campo	Tipo	Descrição	Caracteres
wallet_key *	string	Chave única da carteira no formato UUID v4	36
card_key *	string	Chave única do cartão no formato UUID v4	36

Request Body

{
  "status": "posted",
  "place": "São Paulo - SP",
  "description": "Postado - logística iniciada",
  "reason": "Processamento concluído"
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
status *	string	Novo status do rastreamento	Enumeradores status
place *	string	Local onde ocorreu o evento	100
description *	string	Descrição do evento de rastreamento	255
reason	string	Motivo adicional do evento (opcional)	100

Enumeradores status

Enumerador	Descrição
pending	Pendente - aguardando processamento inicial
posted	Postado - logística iniciada
prepared	Preparado - cartão preparado para transferência
in_transfer	Em transferência - cartão em trânsito
in_delivery_unit	Na unidade de entrega - cartão chegou à unidade de distribuição
on_route	Em rota - cartão saiu para entrega
attempt_failed	Tentativa falhou - tentativa de entrega não foi bem-sucedida
awaiting_withdrawal	Aguardando retirada - cartão disponível para retirada
returning	Retornando - cartão em processo de devolução
delivered	Entregue - cartão foi entregue com sucesso
returned	Devolvido - cartão foi devolvido
canceled	Cancelado - rastreamento foi cancelado
failed	Falhou - falha no processo de entrega
resend	Reenvio - cartão será reenviado
redispatch_error	Erro no redespacho - erro ao redespachar o cartão
waiting_for_address_update	Aguardando atualização de endereço - aguardando confirmação de endereço

Response

STATUS

204

Response Body

{}

Comportamento

• A simulação atualiza o status do rastreamento e cria um novo evento no histórico
• As transições de status seguem uma ordem específica e validações são aplicadas:
  • Não é possível retroceder para status anteriores (exceto status especiais)
  • Não é possível alterar status a partir de status finais (delivered, returned, canceled, failed)
  • Não é possível transicionar de waiting_for_address_update para outro status que não seja pending
  • Não é possível transicionar para waiting_for_address_update a partir de status finais
  • Status especiais (attempt_failed, resend, redispatch_error) podem ser utilizados em qualquer momento após o status inicial
• O campo reason é opcional e, quando fornecido, é concatenado à descrição do evento