Geração de dados de ativação
Este endpoint possibilita a geração de um token contendo os dados de ativação (activationData
) para a formulação do desafio que confirmará a adição do cartão à carteira digital, em caso de uso de Apple Pay e fluxo de verificação in-App.
Fluxo de verificação in-App para Apple Pay
Para adição de cartões na própria Apple Pay, ou seja, diretamente pelo aplicativo da carteira (YellowPath), algumas validações adicionais são realizadas, como o envio de desafios (SMS, in-App etc.).
Após o cliente digitar os dados do cartão na Apple Pay, ele receberá uma notificação de verificação, que oferecerá pelo menos duas opções para confirmar a sua identidade.
No caso da escolha da verificação in-App, o cliente será direcionado para o aplicativo do parceiro, que deverá chamar este endpoint para obter os dados necessários para conclusão do desafio.
Somente após a aprovação, o cartão será adicionado à carteira digital.
Nota
Atualmente, o fluxo de verificação in-App só pode ser utilizado em caso de adição do cartão na Apple Pay.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O programa do cartão esteja configurado com o tipo de desafio In-App.
Requisição
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/wallet/{wallet}/brand/{brand}/activation-data
--request POST 'https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/wallet/{wallet}/brand/{brand}/activation-data' \
--header 'accept: application/json' \
--header 'authorization: Bearer {token}' \
--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.pci.token.create | Concede acesso para a geração de um token. |
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. |
wallet | path | Obrigatório. Carteira digital à qual o cartão deverá ser adicionado, que neste caso deverá ser “ApplePay”. |
brand | path | Obrigatório. Bandeira do cartão. Preencha este campo com “Mastercard”. |
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 que o token foi gerado.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
Nome | Tipo | Descrição | Número máximo de caracteres |
---|---|---|---|
data | string | Token, em formato base64, que deverá ser utilizado na formulação do desafio. | — |
{
"data":"DXlKMlpDSnphVzl1SWpS1JsZGNkVEFa0ZDZEV0MmJYVlZXWGN6VW00ek5Xd3hlakJSUkZsUE4zWlFUWGMzU0SDSWEyOXRaMlJ0Y1c0d2FXWk9SWGxNU0V"
}
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 | Cartão não encontrado. |
409 | 029 | The card is in the process of being created | O cartão está em processo de criação. |
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 2 months ago