Aprovação de Solicitação e Controle de Estado

Este endpoint permite:

Aprovar ou rejeitar a solicitação de emissão de cartão físico feita pelo cliente;
Bloquear, desbloquear e cancelar cartões existentes.

Pré Requisitos

Para utilizar este endpoint, é necessário que o usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

Requisição (Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/dashboard/cards/status/{cardId}

--request POST 'https://sandbox.hiperbanco.com.br/dashboard/cards/status/{id}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
   "action": "Accept"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	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)

Nome	Tipo	Descrição
`cardId`	`path`	Identificador do cartão / solicitação de cartão

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`action`	`string`	Informe qual ação será feita com o cartão / solicitação de cartão. Possíveis actions para requisição

{
   "action": "Accept"
}

Possíveis ações para cartão

Nome	Descrição
`Accept`	Serve para aceitar o pedido de um cartão físico
`Reject`	Serve para rejeitar o pedido de um cartão físico
`Cancel`	Serve para cancelar um cartão
`Block`	Serve para bloquear um cartão
`Unblock`	Serve para desbloquear um cartão

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações da requisição.

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

{
    "proxy": "5125911000000388559",
    "activateCode": "B1FF53D3EB9A"
}

Status atualizado com sucesso.

📘
Nota
Para a ação de rejeitar, a API retornará apenas o statusCode 200

Erros

Status Code	Código	Mensagem	Descrição
`401`	`PROGRAM_NOT_IN_LOT`	Program does not belong to lot.	O programa não pertence ao lote.
`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!	Requisição válida, porém, não foi aceita devido a alguma regra de negócio contratada.
`406`	`PROGRAM_UNDEFINED`	Program undefined!	Nenhum programa definido para a operação.
`406`	`ACCOUNT_NOT_OWNED_BY_CUSTOMER`	Account does not belong to the customer!	A conta não pertence ao cliente.
`406`	`ACCOUNT_INACTIVE`	The account is inactive!	Conta inativa.
`406`	`DUPLICATE_CARD_NAME`	Card already exists for the given name.	Nome já cadastrado para o CPF informado. 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.	A requisição com os dados enviados já foi realizada e está em processamento.
`422`	`ACCOUNT_ALREADY_HAS_PHYSICAL_CARD`	The account already has an active physical card or it is to be approved.	A conta já possui um cartão físico ativo ou está pendente de aprovação.
`404`	`ONBOARDING_NOT_FOUND`	Onboarding not found searching by number and branch	Onboarding não encontrado.
`404`	`ACCOUNT_NOT_FOUND`	Account not found searching by number and branch	Conta não encontrada.

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.