Consulta dos próximos status
stable pré pós
Este endpoint possibilita que o cliente do parceiro Bankly consulte todos os possíveis próximos status válidos para o cartão.
Importante
Os status retornados irão variar conforme as permissões concedidas para o token informado na requisição.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente do parceiro Bankly tenha um proxy de cartão emitido.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/nextStatus
--request GET\
--url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/nextStatus' \
--header 'Authorization: Bearer {{Token}}' \
--header 'accept: application/json' \
--header 'api-version: 1.0' \
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
Scope | Descrição |
---|---|
card.read | Concede acesso para consultar os próximos status do cartão. |
Cabeçalhos (Headers)
Nome | Descrição |
---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | 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 |
---|---|---|
proxy | path | Obrigatório. Código identificador do cartão. |
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
}
]
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
Status Code | Código | Mensagem | Descrição |
---|---|---|---|
404 | 002 | 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. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago