Consulta de rastreio

Utilize esta API para consultar o status de envio e entrega de um cartão físico após sua emissão.

Essa consulta permite obter informações atualizadas sobre o estágio do processo logístico do cartão.


Quando utilizar

A consulta de rastreio deve ser utilizada para:

  • Obter o status atual de entrega do cartão
  • Apresentar o progresso de envio ao portador
  • Complementar o uso de webhooks no acompanhamento do rastreio

Resposta da consulta

CampoTipoDescrição
cardIdintIdentificador do cartão
deliveryStatusstringStatus atual do processo de entrega
deliveryTrackingobjectInformações detalhadas do rastreio
expectedDeliveryDatedateData estimada de entrega
postingDeliveryDatedateData de envio do cartão
collectionDeliveryDatedateData de coleta pelo operador logístico

Campos adicionais

CampoTipoDescrição
embossingStartbooleanIndica se o processo de fabricação foi iniciado
embossingFinishbooleanIndica se o processo de fabricação foi finalizado
embosserNamestringNome da embossadora responsável
embossingCounterintQuantidade de vezes que o cartão foi reemitido
addressobjectEndereço de entrega do cartão

Status de entrega

O campo deliveryStatus indica em qual etapa o cartão se encontra no processo logístico.

StatusDescrição
SOLICITADOCartão criado e aguardando fabricação
EMBOSSING GERADOCartão produzido com sucesso
COLETADOProcesso logístico iniciado
POSTADOCartão despachado para entrega
ENTREGA EM ANDAMENTOEntrega em progresso
ENTREGUECartão entregue ao destinatário
DEVOLVIDOEntrega recusada
EXTRAVIADOCartão extraviado durante o transporte
DESTRUIDOCartão danificado

Considerações importantes

  • Essa API deve ser utilizada como fonte de verdade para o rastreio do cartão
  • O rastreio é aplicável apenas para cartões físicos
  • Recomenda-se utilizar essa API em conjunto com webhooks para atualização de status
  • Nem todos os campos estarão disponíveis em todos os estágios do processo