Consulta dos próximos status

Este endpoint possibilita que o cliente do parceiro Hiperbanco consulte todos os possíveis próximos status válidos para o cartão.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O cliente do parceiro Hiperbanco tenha um proxy de cartão emitido.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/Cards/nextStatus/{proxy}

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

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)

No path desta requisição envie os seguintes campos:

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)

O status code 200 indicará que a solicitação foi aceita com sucesso e trará uma lista dos status futuros do cartão, se houver.

📘
Nota
Em caso de cartão com o status " CANCELED", será retornado o status code 204 junto com uma lista vazia []. Isso ocorre porque não há mais estados futuros para um cartão cancelado.

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

Nome	Tipo	Descrição
`value`	`string`	Próximo status do cartão. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`isDefinitive`	`boolean`	Indica se o status é reversível (`true`) ou irreversível (`false`).

[
    {
        "value": "ExpiredCanceled",
        "isDefinitive": true
    },
    {
        "value": "LostOrTheftCanceled",
        "isDefinitive": true
    },
    {
        "value": "CanceledByCustomer",
        "isDefinitive": true
    },
    {
        "value": "CanceledByEmitter",
        "isDefinitive": true
    },
    {
        "value": "UseFraudLocked",
        "isDefinitive": false
    },
    {
        "value": "TemporarilyUserLocked",
        "isDefinitive": false
    },
    {
        "value": "RegisterFraudLocked",
        "isDefinitive": false
    },
    {
        "value": "DeathCanceled",
        "isDefinitive": true
    },
    {
        "value": "UpdateRegisterLocked",
        "isDefinitive": false
    },
    {
        "value": "WithoutMovementLocked",
        "isDefinitive": false
    },
    {
        "value": "WrongPasswordAttemptLocked",
        "isDefinitive": false
    },
    {
        "value": "UseFraudCanceled",
        "isDefinitive": true
    },
    {
        "value": "RegisterFraudCanceled",
        "isDefinitive": true
    },
    {
        "value": "StrayedCanceled",
        "isDefinitive": true
    }
]

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`404`	`CARD_NOT_FOUND`	`Card not found!`	O cartão informado não foi encontrado.

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

Eventos

Este endpoint não possui eventos relacionados a ele.