Por proxy

stable pré pós

Este endpoint possibilita que o cliente do parceiro Bankly consulte os dados de um cartão pelo seu proxy.

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/{proxy}
     curl --request GET \
     --url https://api-mtls.sandbox.bankly.com.br/cards/{proxy} \
     --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:

ScopeDescrição
card.readConcede acesso para consultar os dados de um cartão pelo seu proxy.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
proxypathObrigatório. Código identificador do cartão.

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á um objeto contendo as informações do cartão.

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

NomeTipoDescrição
createdstringData de criação do cartão, no formato ISO 8601 - UTC.
companyKeystringIdentificador da companhia.
documentNumberstringNúmero do documento do cliente, qual pode ser "CPF" ou "CNPJ".
activateCodestringCódigo de ativação do cartão.
bankAgencystringNúmero da agência do cliente.
bankAccountstringNúmero da conta do cliente.
lastFourDigitsstringÚltimos 04 dígitos do cartão.
proxystringCódigo identificador do cartão.
namestringNome impresso no cartão.
aliasstringApelido impresso no cartão.
cardTypestringTipo do cartão, o qual pode ser "Physical" ou "Virtual".
statusstringSituaçã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 objectsLista 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[].proxystringCódigo identificador do cartão físico.
physicalBinds[].createdstringData de criação do cartão físico, no formato ISO 8601 - UTC.
virtualBindobjectObjeto 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.proxystringCódigo identificador do cartão virtual.
virtualBind.createdstringData de criação do cartão virtual, no formato ISO 8601 - UTC.
allowContactlessbooleanIndica se a função contactless está habilitada.
addressobjectObjeto que contém informações sobre o endereço do titular do cartão.
address.zipCodestringCódigo postal do endereço.
address.addressstringLogradouro (Nome da rua, avenida etc.).
address.numberstringNúmero do prédio ou da casa.
address.neighborhoodstringNome do bairro.
address.complementstringComplemento do endereço.
address.citystringNome da cidade.
address.statestringNome do estado.
address.countrystringNome do país.
historyStatus[]array of objectsLista de objetos contendo o histórico de status do cartão desde sua criação.
historyStatus[].modifiedstringData em que o status foi aplicado, no formato ISO 8601 - UTC.
historyStatus[].valuestringNome 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 objectsLista 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[].statusstringSituação do cartão na carteira, o qual pode ser "Approved" ou "Denied".
wallets[].walletTypestringIdentificador da carteira que o cartão encontra-se vinculado.
wallets[].walletFlowAddstringClassificação do fluxo que o cartão recebeu ao entrar na carteira, a qual pode ser "Undefined", "GreenPatch" ou "YellowPatch".
creditPosobjectObjeto 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.contractNumberstringNúmero do contrato de crédito do cliente.
creditPos.limitnumberLimite de crédito do cliente.
creditPos.limitActivenumberLimite de crédito ativo do cliente.
activatedAtstringData da ativação do cartão, no formato ISO 8601 - UTC.
lastUpdatedAtstringData da última atualização do cartão, no formato ISO 8601 - UTC.
isActivatedbooleanIndica se o cartão está ativo.
isLockedbooleanIndica se o cartão está bloqueado.
isCanceledbooleanIndica se o cartão está cancelado.
isBuildingbooleanIndica se o cartão está em construção.
isFirtualbooleanIndica se o cartão é Firtual.
isPrebooleanIndica se o cartão é pré-pago.
isPosbooleanIndica se o cartão é pós-pago.
isCombobooleanIndica 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 CodeCódigoMensagemDescrição
404002Card Not FoundCartã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.