Veja a seguir como emitir cada tipo de cartão por meio de dados criptografados.

Cartão físico

Este endpoint possibilita que o cliente do parceiro Bankly emita um cartão físico por meio de comunicação criptografada.

📘

Nota

Para aumentar o nível de segurança da informação, o uso desse serviço é exclusivo para clientes homologados com o time de segurança do Bankly.

Pré-requisito

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

• O parceiro defina um programa para seus cartões;
• Durante o desenvolvimento do projeto, o parceiro solicite autorização ao time de segurança do Bankly para realizar o processo de homologação técnica;
• Após homologação e alinhamento prévio com o time de cartões e segurança do Bankly, o parceiro Bankly adquira o certificado de criptografia;
• O cliente do parceiro possua uma conta ativa.

Requisição

Requisição HTTP

 POST 'https://api-mtls.sandbox.bankly.com.br/cards-pci/physical' \

--request POST \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards-pci/physical' \
--header 'Authorization: Bearer {{Token}}' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'x-bkly-license: f64197e4-80b3-4820-bfae-1419049b15b5'\ 
--header 'content-type: application/json' \
--data '{  
      "Name": "Nísia Floresta",
      "alias": "Cartão principal", 
      "password": "pxrmwJ9FixeygLUSsGRxXbeHEabeHdzdhOwdQ0nEdNhyrnRfj7Vo7...", 
      "program": {
            "id": 95
      },
      "holder": {
            "document": {
                  "value": "76447798095",
                  "type": "CPF"
            },
            "account": {
                  "branch": "0001",
                  "number": "15164"
            }
      },
      "address": { 
            "zipCode": "68060100", 
            "address": "Rua 6 de Março", 
            "number": "2500", 
            "neighborhood": "Alter do Chão", 
            "complement": "", 
            "city": "Santarém", 
            "state": "PA", 
            "country": "BR" 
      },
      "metadata":{
            "updatedAt": "2022-12-30T01:11:07.4019873Z",
            "versao": "1.0"
      },
      "paymentDay": 1
}'

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:

Caso o cliente não tenha informado o endereço de entrega no momento do cadastro, preencha:

{  
      "Name": "Nísia Floresta",
      "alias": "Cartão principal", 
      "password": "pxrmwJ9FixeygLUSsGRxXbeHEabeHdzdhOwdQ0nEdNhyrnRfj7Vo7...", 
      "program": {
            "id": 95
      },
      "holder": {
            "document": {
                  "value": "76447798095",
                  "type": "CPF"
            },
            "account": {
                  "branch": "0001",
                  "number": "15164"
            }
      },
      "address": { 
            "zipCode": "68060100", 
            "address": "Rua 6 de Março", 
            "number": "2500", 
            "neighborhood": "Alter do Chão", 
            "complement": "", 
            "city": "Santarém", 
            "state": "PA", 
            "country": "BR" 
      },
      "metadata":{
            "updatedAt": "2022-12-30T01:11:07.4019873Z",
            "versao": "1.0"
      },
      "paymentDay": 1
}

Resposta (Response)

O status code 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 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:

Cartão virtual

Este endpoint possibilita que o cliente do parceiro Bankly emita um cartão virtual por meio de comunicação criptografada.

📘

Nota

Para aumentar o nível de segurança da informação, o uso desse serviço é exclusivo para clientes homologados com o time de segurança do Bankly.

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;
• Durante o desenvolvimento do projeto, o parceiro solicite autorização ao time de segurança do Bankly para realizar o processo de homologação técnica;
• Após homologação e alinhamento prévio com o time de cartões e segurança do Bankly, o parceiro Bankly adquira o certificado de criptografia;
• O cliente do parceiro possua uma conta ativa.

Requisição

Requisição HTTP

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

--request POST \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards-pci/virtual' \
--header 'Authorization: Bearer {{Token}}' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'x-bkly-license: f64197e4-80b3-4820-bfae-1419049b15b5'\ 
--header 'content-type: application/json' \
--data '{  
      "name": "Nísia Floresta",
      "alias": "Cartão principal", 
      "password": "pxrmwJ9FixeygLUSsGRxXbeHEabeHdzdhOwdQ0nEdNhyrnRfj7Vo743RvEMiWe/zO3", 
      "program": {
            "id": 95
      },
      "holder": {
            "document": {
                  "value": "76447798095",
                  "type": "CPF"
            },
            "account": {
                  "branch": "0001",
                  "number": "15164"
            }
      },
      "address": { 
            "zipCode": "68060100", 
            "address": "Rua 6 de Março", 
            "number": "2500", 
            "neighborhood": "Alter do Chão", 
            "complement": "", 
            "city": "Santarém", 
            "state": "PA", 
            "country": "BR" 
      },
      "metadata":{
            "updatedAt": "2022-12-30T01:11:07.4019873Z",
            "versao": "1.0"
      },
      "paymentDay": 1
}'

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:

{  
      "name": "Nísia Floresta",
      "alias": "Cartão principal", 
      "password": "pxrmwJ9FixeygLUSsGRxXbeHEabeHdzdhOwdQ0nEdNhyrnRfj7Vo743RvEMiWe/zO3", 
      "program": {
            "id": 95
      },
      "holder": {
            "document": {
                  "value": "76447798095",
                  "type": "CPF"
            },
            "account": {
                  "branch": "0001",
                  "number": "15164"
            }
      },
      "address": { 
            "zipCode": "68060100", 
            "address": "Rua 6 de Março", 
            "number": "2500", 
            "neighborhood": "Alter do Chão", 
            "complement": "", 
            "city": "Santarém", 
            "state": "PA", 
            "country": "BR" 
      },
      "metadata":{
            "updatedAt": "2022-12-30T01:11:07.4019873Z",
            "versao": "1.0"
      },
      "paymentDay": 1
}

Resposta (Response)

O status code 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 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:

Segunda via

Este endpoint permite que o parceiro Bankly ofereça a seus clientes a possibilidade de emitir uma segunda via do cartão físico, com as mesmas características da primeira via, por meio de comunicação criptografada.

Pré-requisito

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

• Durante o desenvolvimento do projeto, o parceiro solicite autorização ao time de segurança do Bankly para realizar o processo de homologação técnica;
• Após homologação e alinhamento prévio com o time de cartões e segurança do Bankly, o parceiro Bankly adquira o certificado de criptografia;
• O cliente do parceiro possua uma conta ativa.

Requisição

Requisição HTTP

POST 'https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/duplicate'

--url 'https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/duplicate' \\
--header 'Authorization: Bearer {{Token}}' \\
--header 'accept: application/json' \\
--header 'api-version: 1.0' \\
--header 'content-type: application/json'
--data '{   
	"description": "Lorem ipsum",
	"status": "CardWasStolen",
	"holder": {
		"document": {
			"value": "47742663023",
			"type": "CPF"
			}
	},
	"password": "asjkdkas19821ksnd....",
	"resetPassword": false,
	"address": {
		"zipCode": "68060100",
		"address": "Rua 6 de Março",
		"number": "2500",
		"neighborhood": "Alter do Chão",
		"complement": "",
		"city": "Santarém",
		"state": "PA",
		"country": "BR"
	},
	"metadata": {
		"updatedAt": "2022-12-30T01:11:07.4019873Z",
		"versao": "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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição, envie os seguintes campos:

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

📘

Nota

Para que o parceiro possa utilizar o campo resetPassword, é necessário que seja feita uma avaliação pelo time de segurança do Bankly e que o usuário tenha acesso à senha, seja pelo kit enviado, seja pelo endpoint de consulta de senhas.

Caso o cliente não possua um endereço cadastrado, preencha obrigatoriamente:

Entretanto, caso o cliente já possua um endereço cadastrado, o preenchimento do campo address é opcional.

❗

Atenção

Para evitar problemas na entrega devido à desatualização do endereço cadastrado, recomendamos que o campo address seja preenchido mesmo que o cliente já tenha informado um endereço previamente.

{   
      "description": "Lorem ipsum",
      "status": "CardWasStolen",
      "holder": {
      "document": {
            "value": "47742663023",
            "type": "CPF"
            }
      },
      "password": "asjkdkas19821ksnd....",
      "resetPassword": false,
      "address": {
            "zipCode": "68060100",
            "address": "Rua 6 de Março",
            "number": "2500",
            "neighborhood": "Alter do Chão",
            "complement": "",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
      },
      "metadata": {
            "updatedAt": "2022-12-30T01:11:07.4019873Z",
            "versao": "1.0"
      }
}

Motivos de solicitação de segunda via do cartão (status)

Após realizar a requisição, o status do cartão antigo será atualizado de acordo com o motivo informado no campo status descrito acima. Os valores correspondentes podem ser visualizados na tabela abaixo:

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: