Por código de ativação

Este endpoint possibilita que o cliente do parceiro Bankly consulte seus cartões por meio do seu código de ativação.

Pré-requisito

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

O cliente do parceiro Bankly tenha um proxy de cartão emitido.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards/activateCode/{activationCode}

     curl --request GET \
     --url https://api-mtls.sandbox.bankly.com.br/cards/activateCode/{activationCode} \
     --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.read`	Concede acesso para consultar os dados de uma lista de cartões pelo seu código de ativação.

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	Especificação
`activationCode`	`path`	Obrigatório. Código de ativação do cartão.	Tamanho: 12 caracteres.

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 trará uma lista de cartões e suas informações.

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

Nome	Tipo	Descrição
`created`	`string`	Data de criação do cartão, no formato ISO 8601 - UTC.
`companyKey`	`boolean`	Identificador da companhia.
`documentNumber`	`string`	Número do documento do cliente, qual pode ser "CPF" ou "CNPJ".
`activateCode`	`string`	Código de ativação do cartão.
`bankAgency`	`string`	Número da agência do cliente.
`bankAccount`	`string`	Número da conta do cliente.
`lastFourDigits`	`string`	Últimos 04 dígitos do cartão.
`proxy`	`string`	Código identificador do cartão.
`name`	`string`	Nome impresso no cartão.
`alias`	`string`	Apelido impresso no cartão.
`cardType`	`string`	Tipo do cartão, o qual pode ser "Physical" ou "Virtual".
`status`	`string`	Situação do cartão. Exemplos: “Active”, “Building”, “Sleeping”, “Inactive”, dentre outros. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`physicalBinds[]`	`array of objects`	Lista de objetos contendo informações sobre os cartões físicos vinculados ao cartão virtual consultado. Essa lista somente será retornada caso o tipo de cartão (`cardType`) seja "Virtual".
`physicalBinds[].proxy`	`string`	Código identificador do cartão físico.
`physicalBinds[].created`	`string`	Data de criação do cartão físico, no formato ISO 8601 - UTC.
`virtualBind`	`object`	Objeto que contém informações sobre o cartão virtual vinculado ao cartão físico consultado. Esse objeto somente será retornado caso o tipo de cartão (`cardType`) seja "Physical".
`virtualBind.proxy`	`string`	Código identificador do cartão virtual.
`virtualBind.created`	`string`	Data de criação do cartão virtual, no formato ISO 8601 - UTC.
`allowContactless`	`boolean`	Indica se a função contactless está habilitada.
`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 do estado.
`address.country`	`string`	Nome do país.
`historyStatus[]`	`array of objects`	Lista de objetos contendo o histórico de status do cartão desde sua criação.
`historyStatus[].modified`	`string`	Data em que o status foi aplicado, no formato ISO 8601 - UTC.
`historyStatus[].value`	`string`	Nome do status aplicado. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`wallets[]`	`array of objects`	Lista de objetos contendo a identificação das carteiras digitais que o cartão encontra-se vinculado. Essa lista somente será retornada se o cartão estiver inserido em uma carteira digital.
`wallets[].status`	`string`	Situação do cartão na carteira, o qual pode ser "Approved" ou "Denied".
`wallets[].walletType`	`string`	Identificador da carteira que o cartão encontra-se vinculado.
`wallets[].walletFlowAdd`	`string`	Classificação do fluxo que o cartão recebeu ao entrar na carteira, a qual pode ser "Undefined", "GreenPatch" ou "YellowPatch".
`creditPos`	`object`	Objeto que contém informações sobre o limite de crédito do cartão pós-pago. Esse objeto somente será retornado se o cartão consultado for pós-pago.
`creditPos.contractNumber`	`string`	Número do contrato de crédito do cliente.
`creditPos.limit`	`number`	Limite de crédito do cliente.
`creditPos.limitActive`	`number`	Limite de crédito ativo do cliente.
`activatedAt`	`string`	Data da ativação do cartão, no formato ISO 8601 - UTC.
`lastUpdatedAt`	`string`	Data da última atualização do cartão, no formato ISO 8601 - UTC.
`isActivated`	`boolean`	Indica se o cartão está ativo.
`isLocked`	`boolean`	Indica se o cartão está bloqueado.
`isCanceled`	`boolean`	Indica se o cartão está cancelado.
`isBuilding`	`boolean`	Indica se o cartão está em construção.
`isFirtual`	`boolean`	Indica se o cartão é Firtual.
`isPre`	`boolean`	Indica se o cartão é pré-pago.
`isPos`	`boolean`	Indica se o cartão é pós-pago.
`isCombo`	`boolean`	Indica se o cartão é combo.

Exemplo - Cartão físico

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Physical",
    "status": "InTransitLocked",
    "virtualBind": {
      "proxy": "22999903520114195",
      "created": "2020-07-20T22:55:12"
    },
    "allowContactless": true,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "Building"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "InTransitLocked"
      }
    ],
    "creditPos": {
      "contractNumber": "54684325763",
      "limit": 3000,
      "limitActive": 1000
    },
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": true,
    "isLocked": false,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": false,
    "isPos": true,
    "isCombo": false
  }
]

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Physical",
    "status": "InTransitLocked",
    "virtualBind": {
      "proxy": "22999903520114195",
      "created": "2020-07-20T22:55:12"
    },
    "allowContactless": true,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "Building"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "InTransitLocked"
      }
    ],
    "wallets": [
      {
        "status": "Approved",
        "walletType": "GooglePay",
        "walletFlowAdd": "YellowPatch"
      }
    ],
    "creditPos": {
      "contractNumber": "54684325763",
      "limit": 3000,
      "limitActive": 1000
    },
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": false,
    "isLocked": true,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": false,
    "isPos": true,
    "isCombo": false
  }
]

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Physical",
    "status": "InTransitLocked",
    "virtualBind": {
      "proxy": "22999903520114195",
      "created": "2020-07-20T22:55:12"
    },
    "allowContactless": true,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "Building"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "InTransitLocked"
      }
    ],
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": false,
    "isLocked": true,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": true,
    "isPos": false,
    "isCombo": false
  }
]

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Physical",
    "status": "InTransitLocked",
    "virtualBind": {
      "proxy": "22999903520114195",
      "created": "2020-07-20T22:55:12"
    },
    "allowContactless": true,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "Building"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "InTransitLocked"
      }
    ],
    "wallets": [
      {
        "status": "Approved",
        "walletType": "GooglePay",
        "walletFlowAdd": "YellowPatch"
      }
    ],
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": false,
    "isLocked": true,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": true,
    "isPos": false,
    "isCombo": false
  }
]

Exemplo - Cartão virtual

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Virtual",
    "status": "Active",
    "physicalBinds": [
      {
        "proxy": "2300199994444111999",
        "created": "2020-07-20T22:54:03"
      }
    ],
    "allowContactless": false,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "WithoutMovementLocked"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "Active"
      }
    ],
    "creditPos": {
      "contractNumber": "54684325763",
      "limit": 3000,
      "limitActive": 1000
    },
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": true,
    "isLocked": false,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": false,
    "isPos": true,
    "isCombo": false
  }
]

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Virtual",
    "status": "Active",
    "physicalBinds": [
      {
        "proxy": "2300199994444111999",
        "created": "2020-07-20T22:54:03"
      }
    ],
    "allowContactless": false,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "WithoutMovementLocked"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "Active"
      }
    ],
    "wallets": [
      {
        "status": "Approved",
        "walletType": "GooglePay",
        "walletFlowAdd": "YellowPatch"
      }
    ],
    "creditPos": {
      "contractNumber": "54684325763",
      "limit": 3000,
      "limitActive": 1000
    },
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": true,
    "isLocked": false,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": false,
    "isPos": true,
    "isCombo": false
  }
]

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Virtual",
    "status": "Active",
    "physicalBinds": [
      {
        "proxy": "2300199994444111999",
        "created": "2020-07-20T22:54:03"
      }
    ],
    "allowContactless": false,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "WithoutMovementLocked"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "Active"
      }
    ],
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": true,
    "isLocked": true,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": true,
    "isPos": false,
    "isCombo": false
  }
]

[
  {
    "created": "2020-07-20T22:53:12",
    "companyKey": "Acesso",
    "documentNumber": "00000000000",
    "activateCode": "A9991B2E491D",
    "bankAgency": "0001",
    "bankAccount": "0001",
    "lastFourDigits": "4321",
    "proxy": "22999903520114195",
    "name": "Jose da Silva",
    "alias": "Meu Cartão",
    "cardType": "Virtual",
    "status": "Active",
    "physicalBinds": [
      {
        "proxy": "2300199994444111999",
        "created": "2020-07-20T22:54:03"
      }
    ],
    "allowContactless": false,
    "address": {
      "zipCode": "05402100",
      "address": "Avenida Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "Em frente a Wizard",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    },
    "historyStatus": [
      {
        "modified": "2020-07-20T22:53:12",
        "value": "Building"
      },
      {
        "modified": "2020-07-20T22:55:12",
        "value": "InTransitLocked"
      }
    ],
    "wallets": [
      {
        "status": "Approved",
        "walletType": "GooglePay",
        "walletFlowAdd": "YellowPatch"
      }
    ],
    "activatedAt": null,
    "lastUpdatedAt": "2020-07-20T22:55:12",
    "isActivated": true,
    "isLocked": true,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": true,
    "isPre": true,
    "isPos": false,
    "isCombo": false
  }
]

👍

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

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.

Pré-requisito

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

👍

👍Dica

Erros

Eventos

👍
Dica