Rastreio de cartões

O endpoint de consulta de rastreio dá visibilidade de cada etapa desde a fabricação até a operação logística do processo de entrega de um cartão físico.

O processo de rastreio é iniciado alguns minutos após a solicitação de um novo cartão. Como este tempo é variável, pois depende dos parceiros e de validações internas de segurança, recomendamos que a consulta inicie-se após, no mínimo, 20 minutos.

Endpoint

Para consumo deste endpoint de consulta, será necessário informar o proxy (código do cartão utilizado para localizá-lo no processo de entrega) no path da requisição.

--request GET 'https://api-mtls.sandbox.bankly.com.br/cards/{{proxy}}/tracking' \ 
	     --header 'accept: application/json' \ 
	     --header 'api-version: 1' \
	     --header 'Authorization: Bearer {{token}}'

Retorno

O sucesso retornará o status code 200 com informações de rastreio do cartão.

{
  "createdDate": "2020-07-20T22:53:12",
  "externalTracking": {
    "code": "A2327692D592",
    "partner": "CORREIOS"
  },
  "function": "Pre",
  "name": "Peter Parker",
  "alias": "Meu Cartão-Aranha",
  "address": [
    {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    }
  ],
  "status": [
    {
      "createdDate": "2020-07-20T22:55:12",
      "type": "InProgress",
      "reason": "In route to delivery"
    },
    {
      "createdDate": "2020-07-20T22:53:12",
      "type": "Created",
      "reason": "Created"
    }
  ],
  "finalized": [
    {
      "createdDate": "2020-07-20T22:53:12",
      "recipientName": "Mary Parker",
      "recipientKinship": "Mãe",
      "documentNumber": "1234567",
      "attempts": 1
    }
  ]
}

A seguir destacamos alguns campos:

• estimatedDeliveryDate: data de entrega estimada;
• address: informações sobre o endereço onde será entregue o cartão;
• status: histórico dos status desde a criação do cartão até a entrega ao destinatário, do mais recente para o mais antigo;
• function: função do cartão, a qual pode ser “Pre”, “Pos” ou “Debit”;
• finalized: uma vez entregue o cartão, o campo finalized é preenchido com informações de quando o cartão foi recebido e por quem;
  • recipientKinship: o campo mostra o relacionamento do portador do cartão com a pessoa que o recebeu. Exemplo: porteiro, mãe, portador etc.
• externalTracking : ao receber um status com o motivo Sended to correios, o código de rastreamento utilizado pelos Correios é adicionado dentro do campo.

Status

O campo status traz o histórico dos status desde a criação do cartão. Ele é formado pela seguinte estrutura:

• type: o tipo do status, que pode ser:
  • Created: primeiro registro;
  • Building: o cartão está sendo confeccionado;
  • InProgress: o cartão está sendo transferido de local;
  • Delivered: o cartão foi entregue. Este é um status final, portanto, não são necessárias novas consultas;
  • Cancelled: dentre outros motivos, este status é exibido quando o cartão foi extraviado ou quando entrou em processo de custódia, porém o prazo para tomar uma ação a respeito expirou.
  • NotDelivered: status relacionado a cartão não entregue, seja por endereço incorreto, seja por ter sido recusado, ou então porque o número máximo de tentativa de entregas foi excedido;
  • Custody: situação em que o cartão está de volta com o Bankly e será necessário atualizar o endereço de entrega.
• createdDate: data e hora em que este status passou entrar em vigor.
• reason: informações sobre o status do rastreio. Veja a seguir os valores possíveis de preenchimento deste campo, separados por tipo de status:

Evento

Caso o parceiro deseje receber atualizações referentes ao rastreio de cartões, é possível configurar o webhook e receber o seguinte evento do contexto "Card":

• TRACKING_STATUS_CHANGED

Erros