Emissão de segunda via

Este endpoint permite que o parceiro Hiperbanco ofereça a seus clientes a possibilidade de emitir uma segunda via do cartão físico ou virtual (caso este seja atrelado a um físico) com as mesmas características da primeira via.

Por meio deste endpoint, também é possível realizar a emissão de uma nova via para um cartão que já se encontra cancelado.

Cancelamento

O cancelamento da primeira via (ou via anterior) poderá ser realizado de forma imediata ou tardia. Quando ocorre de forma tardia, o cancelamento se dá no momento da ativação da nova via.

👍
DICA
Para mais informações sobre o cancelamento imediato ou tardio, consulte a tabela Motivos de solicitação de segunda via do cartão.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Cards/second/{proxy}

--request POST 'https://sandbox.hiperbanco.com.br/Cards/second/{proxy}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

Nome	Tipo	Descrição	Especificação
`proxy`	`path`	Obrigatório. Código identificador do cartão.	Insira somente números, sem caracteres especiais.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

Os status code 202 indica que a solicitação foi aceita e o cartão está sendo criado.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

`Nome`	`Tipo`	`Descrição`	`Número máximo de caracteres`
`proxy`	`string`	Código identificador do cartão.	31
`activateCode`	`string`	Código atrelado ao cartão no momento de sua emissão.	—

{ 
  "proxy": "2370021007715002820", 
  "activateCode": "A0DDDC0951D1" 
}

Status Code	Código	Mensagem	Descrição
`400`	`WRONG_PASSWORD_ATTEMPT_LOCKED`	Wrong Password Attempt Locked	Tentativa de senha errada bloqueada.
`400`	`DUPLICATE_CARD_AWAIT_BUILDING`	Duplicate Card Await Building	A segunda via do cartão está em construção.
`400`	`GET_BANKLYTOKEN_ERROR`	Error while getting Bankly's token	Erro ao obter o token do Banco Liquidante.
`406`	`CARD_NOT_OWNED_BY_CUSTOMER`	Card does not belong to this customer!	O cartão informado não pertence a este documento.
`406`	`INVALID_PASSWORD`	Invalid password!	Senha inválida.
`406`	`DELIVERY_ADDRESS_REQUIRED_FOR_PHYSICAL_CARD`	Delivery address must be informed when requesting the physical card	O cartão físico necessita de um endereço para entrega.
`406`	`PROGRAM_DISABLED`	Program disable!	O programa informado na criação do cartão está desabilitado.
`406`	`PROGRAM_UNDEFINED`	Program undefined!	O programa não existe para esta companyKey.
`406`	`ACCOUNT_NOT_OWNED_BY_CUSTOMER`	Account does not belong to the customer!	O número de documento (documentNumber) informado na requisição está incorreto.
`406`	`ACCOUNT_INACTIVE`	The account is inactive!	Conta inativa.
`406`	`DUPLICATE_CARD_NAME`	Card already exists for the given name	Já existe um cartão com o mesmo nome cadastrado. Não é possível ter dois cartões físicos ativos com o mesmo nome para o mesmo CPF.
`409`	`CARD_LIMIT_REACHED_FOR_PROGRAM`	It is not possible to create new cards as it has reached the limit configured for this program	O limite configurável no programa para emissões de cartões por documento foi atingido.
`409`	`CARD_DUPLICATE_NOT_ALLOWED_DURING_CREATION`	No duplicate for card under construction	Não é possível gerar uma segunda via de um cartão em construção.
`409`	`LATE_CANCEL_ERROR`	It is not possible to continue with late card cancellation for a card that were never activated	Não é possível realizar o cancelamento tardio de um cartão que nunca foi ativado.
`409`	`LATE_CANCEL_ERROR`	It is not possible to continue with late card cancellation for this reason!	Não é possível realizar o cancelamento tardio, pois o motivo de emissão de segunda via (status) informado exige um cancelamento (cancellationMode) do tipo imediato (Immediately).
`409`	`ALREADY_DUPLICATED_ERROR`	It is not possible to continue with the card cancellation because a second copy has already been requested!	A emissão de uma nova via deve ser realizada sempre pelo cartão mais recente, mesmo que ainda exista uma outra via ativa.
`409`	`CANCELLATION_ERROR`	It is not possible to continue with card cancellation for a card that is already cancelled.	Esse erro ocorre caso o cartão já esteja cancelado e sejam informados os valores “Later” ou “Immediately” no campo cancellationMode.
`503`	`CLIENT_UNAVAILABLE`	Client is unavailable	O cliente não está disponível.
`404`	`CARD_NOT_FOUND`	Card not found with proxy	Cartão não encontrado com o proxy.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do evento	Descrição
`CARD_WAS_ISSUED`	O cartão foi emitido.
`CARD_STATUS_WAS_MODIFIED`	O status do cartão foi alterado (via anterior).