Geração de token
stable
Este endpoint possibilita a geração de um token com os dados criptografados do cartão para a sua posterior adição junto a uma carteira digital.
Importante
Atualmente, o cartão do cliente do parceiro Bankly somente poderá ser adicionado à Google Pay.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente do parceiro Bankly possua conta e cartão ativos.
Requisição
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/wallet/{wallet}/brand/{brand}
--request POST \
--url https://api-mtls.sandbox.bankly.com.br/cards-pci/proxy/wallet/{wallet}/brand/{brand}\
--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.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 ao qual o cartão deverá ser adicionado. Preencha este campo com “GooglePay”. |
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 |
---|---|---|
data | string | Token gerado com os dados criptografados do cartão. |
lastFourDigits | string | Quatro últimos dígitos do cartão. |
phoneNumber | string | Número de telefone do titular do cartão. |
address | object | Objeto que contém informações sobre o endereço do titular do cartão. |
address.zipcode | string | Código postal do endereço. |
address.address | string | Logradouro (Nome da rua, avenida etc.). |
address.number | string | Número do prédio ou da casa. |
address.neighborhood | string | Nome do bairro. |
address.complement | string | Complemento do endereço. |
address.city | string | Nome da cidade. |
address.state | string | Nome da estado. |
address.country | string | Nome do país. |
{
"data": "mkzjfhcnnhat84y583hguim49801mkzjfhcnnhat84y583hguim49801mkzjfhcnnhat84y583hguim49801mkzjfhcnnhat84y583hguim49801mkzjfhcnnhat84y583hguim49801mkzjfhcnnhat84y583hguim49801",
"lastFourDigits": "1234",
"phoneNumber": "23415162342",
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém",
"state": "PA",
"country": "Brasil"
}
}
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 | Descrição |
---|---|---|
409 | 029 | O cartão está em processo de criação. |
Válido lembrar que a API também poderá retornar erros comuns entre todos os endpoints.
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 |
---|---|
CARD_WAS_ADDED_TO_WALLET | O cartão foi adicionado na carteira digital. |
CARD_WAS_REMOVED_FROM_WALLET | O cartão foi removido na carteira digital. |
Updated about 1 month ago