Emissão de cartão virtual

Este endpoint permite que o parceiro Bankly ofereça a seus clientes a possibilidade de adquirir um cartão virtual para ser utilizado em compras online.

Limite de emissão

Por padrão, o Bankly permite a emissão mensal de até cinco cartões virtuais por documento (CPF/CNPJ).
Caso seja necessário ajustar essa quantidade, o parceiro poderá entrar em contato com o time Bankly para definir um novo limite de emissão de cartões.

Pré-requisito

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

• O parceiro defina um programa para seus cartões;
• O cliente do parceiro possua uma conta ativa.

Requisição

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/virtual

--request POST \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/virtual' \ 
--header 'Authorization: Bearer {{Token}}' \ 
--header 'accept: application/json' \ 
--header 'api-version: 1' \ 
--header 'content-type: application/json'
--data '{
       "documentNumber": "47742663023",  
       "cardName": "Nísia Floresta",  
       "alias": "Cartão principal",  
       "bankAgency": "0001",  
       "bankAccount": "15164",  
       "programId": "1234",  
       "password": "1234",  
       "address": {  
             "zipCode": "68060100",  
             "address": "Rua 6 de Março",  
             "number": "2500",  
             "neighborhood": "Alter do Chão",  
             "complement": "",  
             "city": "Santarém",  
             "state": "PA",  
             "country": "BR"  
       } 
}'

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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Opcionalmente, preencha:

{   
       "documentNumber": "47742663023",  
       "cardName": "Nísia Floresta",  
       "alias": "Cartão principal",  
       "bankAgency": "0001",  
       "bankAccount": "15164",  
       "programId": "1234",  
       "password": "1234",  
       "address": {  
         "zipCode": "68060100",  
         "address": "Rua 6 de Março",  
         "number": "2500",  
         "neighborhood": "Alter do Chão",  
         "complement": "",  
         "city": "Santarém",  
         "state": "PA",  
         "country": "BR"  
       } 
} 

Resposta (Response)

Os status 202 indica que a solicitação foi aceita e o cartão está sendo criado.

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

{ 
  "proxy": "2370021007715002820", 
  "activateCode": "A0DDDC0951D1" 
} 

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

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

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

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: