Consulta de premiação

Este endpoint permite consultar os detalhes de uma premiação utilizando o seu identificador único (uniqueId).

Pré-requisito

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

O parceiro Bankly possua o identificador único da premiação (uniqueId) que deseja consultar. O uniqueId pode ser obtido por meio da equipe de logística, no momento em que os lotes de cartões físicos e virtuais são gerados no Bankly.

Requisição (Request)

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/incentives/{uniqueId}'

--request GET 
--url 'https://api-mtls.sandbox.bankly.com.br/incentives/{uniqueId}' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {Token}' \ 
--header 'Content-Type: application/json' \

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
`incentive.read`	Concede acesso para consultar uma premiação de incentivo.

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 o seguinte campo:

Nome	Tipo	Descrição
`uniqueId`	`path`	Obrigatório. Identificador único da premiaçã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á um objeto contendo os dados da premiação.

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

Nome	Tipo	Descrição	Número máximo de caracteres
`uniqueId`	`string`	Identificador único da premiação.	—
`product`	`object`	Objeto que contém informações sobre o produto (campanha) da premiação.	—
`product.name`	`string`	Nome do produto (campanha).	—
`holder`	`object`	Objeto que contém informações sobre o premiado.	—
`holder.name`	`string`	Nome do premiado.	—
`holder.type`	`string`	Tipo do premiado, que pode ser "Customer" ou "Business”.	—
`holder.document`	`object`	Objeto que contém informações sobre o documento do premiado.	—
`holder.document.value`	`string`	Número do documento, que será sempre exibido de forma parcial para proteger a informação sensível. Apenas uma parte do número será visível, enquanto o restante será ocultado por caracteres como asteriscos (*).	—
`holder.document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".	—
`account`	`object`	Objeto que contém informações sobre a conta do premiado.	—
`account.branch`	`string`	Número da agência.	—
`account.number`	`string`	Número da conta.	—
`account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.	—
`account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.	—
`account.bank.code`	`string`	Código do banco.	—
`account.bank.name`	`string`	Nome do banco.	—
`card`	`object`	Objeto que contém informações sobre o cartão do premiado.	—
`card.proxy`	`string`	Código identificador do cartão.	—
`card.lastFourDigits`	`string`	Quatro últimos dígitos do cartão.	—

{
    "uniqueId": "9999999999999999999",
    "product": {
        "name": "Campanha de Natal"
    },
    "holder": {
        "name": "Nísia Floresta",
        "type": "Customer",
        "document": {
            "value": "***426630**",
            "type": "Cpf"
        }
    },
    "account": {
        "branch": "0001",
        "number": "15164",
        "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
        }
    },
    "card": {
        "proxy": "0000000000000000000",
        "lastFourDigits": "0000"
    }
}

👍
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	Not Found.	O identificador único 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.