Ativaçao de token - assíncrono

Este endpoint permite que o parceiro informe os dados necessários para a ativação de um token previamente gerado, viabilizando a conclusão do processo de tokenização na carteira digital.

Fluxo de autenticação do portador

A inclusão de um cartão em carteiras digitais pode ocorrer por diferentes fluxos, de acordo com o ponto de início da experiência do usuário:

Push provisioning: o processo é iniciado a partir do aplicativo do emissor do cartão.
Manual provisioning: o processo é iniciado a partir do aplicativo da carteira digital.

No fluxo de manual provisioning, é necessária a autenticação do portador do cartão, que pode ser realizada por diferentes métodos, sendo os mais comuns:

SMS, por meio do envio de um código de verificação;
In-App, com autenticação diretamente no aplicativo do emissor.

📘
Nota
Este endpoint é utilizado exclusivamente no fluxo de manual provisioning com autenticação In-App, no contexto das carteiras digitais Google Pay e Apple Pay.

Pré-requisitos

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

O token de acesso utilizado na requisição possua o devido scope.
O token já tenha sido previamente gerado no fluxo de tokenização, resultando na criação do respectivo Token Unique Reference (TUR).

🚧
Importante
Para mais informações sobre o processo de tokenização relacionado à carteira digital, consulte o Time de Operações do Bankly.

Requisição (Request)

Requisição HTTP

PATH https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/wallet/{wallet}/brand/{brand}/complete-token

--request PATCH \
--url https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/wallet/{wallet}/brand/{brand}/complete-token
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'api-version: 1.0' \
--data '{
	"tur": "DSHRMC1BR000000090c80229edc94c53b8237f02db3dhh3f"
}'

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 PCI.

Cabeçalhos (Headers)

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

Nome	Descrição
`accept`	Obrigatório. Formato da resposta esperado pelo cliente. Deve ser informado como `application/json`.
`content-type`	Obrigatório. Formato do payload enviado na requisição. Deve ser informado como `application/json`.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.
`api-version`	Versão da API. Atualmente estamos na versão 1.0.

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.
`wallet`	`path`	Obrigatório. Carteira digital para a qual o cartão será adicionado. Importante: Atualmente, *Google Pay* e *Apple Pay* são suportados.	—
`brand`	`path`	Obrigatório. Bandeira do cartão. Importante: Atualmente, apenas *Mastercard* é suportado	—

Corpo da requisição (Body)

No body desta requisição, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`tur`	`string`	Obrigatório. Token Unique Reference, fornecido pela carteira no processo App2App.	—

{
   "tur": "DSHRMC1BR000000090c80229edc94c53b8237f02db3dhh3f"
}

Resposta (Response)

O status code 202 indica que a requisição foi validada com sucesso e que o fluxo desta operação foi aceita para o processamento assíncrono.

Erros

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

Status Code	Código	Mensagem	Descrição
400	INVALID_PARAMETER	O conteúdo da requisição não está de acordo com o esperado.	Token Unique Reference (TUR) precisa ser informado
401	UNAUTHORIZED	Solicitação não autorizada	Token inválido/expirado ou ausência do devido scope
404	NOT_FOUND	Recurso não encontrado	Proxy, wallet ou brand inexistente
409	CONFLICT	A sintaxe da requisição é válida, mas há conflito com alguma regra de negócio	Estado do token não permite ativação

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros.

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
`COMPLETE_TOKEN_WAS_PROCESSED`	A solicitação de inclusão do cartão na carteira digital foi processada.