Por conta
stable pré pós
Este endpoint possibilita que o cliente do parceiro Bankly consulte os cartões vinculados à sua conta.
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 (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/cards/account/{account}
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/account/{account}?agency={agency}&documentNumber={documentNumber}' \
--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 vinculados à uma conta. |
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 |
---|---|---|---|
account | path | Obrigatório. Número da conta do cliente. | — |
agency | query | Número de agência. | Tamanho: 4 dígitos. |
documentNumber | query | Número do documento do cliente, que pode ser "CPF" ou "CNPJ". | Informe somente os números. Tamanho máximo de 14 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, que pode ser "CPF" ou "CNPJ". |
activateCode | string | Código de ativação do cartão. |
trackingCode | string | Código de rastreio do cartão. Campo retornado apenas para cartões físicos. |
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, que pode ser "Physical" ou "Virtual". |
status | string | Status 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 é permitido pagamento por aproximaçã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 imóvel. |
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 | Status 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. Atualmente, apenas será retornado "GooglePay". |
wallets[].walletFlowAdd | string | Classificação do fluxo que o cartão recebeu ao entrar na carteira, que 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. |
functionalities[] | array of objects | Lista de objetos contendo informações sobre as modalidades do cartão. |
functionalities[].type | string | Tipo de modalidade associada ao cartão, que pode ser “Debit", "Pos" ou "Pre". |
functionalities[].program | object | Objeto que contém informações sobre o programa ao qual a modalidade está vinculada. |
functionalities[].program.id | number | Identificador único do programa. |
functionalities[].program.bin | string | O BIN, ou Bank Identification Number, são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu. |
functionalities[].program.type | string | Tipo do programa que define a modalidade do cartão. |
functionalities[].program.brand | string | Bandeira do cartão. |
functionalities[].status | string | Status da modalidade, que pode ser “Enabled" (ativado), "Disabled" (desativado), "Blocked" (bloqueado) e “BlockedByContract" (bloqueado por contrato). |
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": "47742663023",
"activateCode": "A9991B2E491D",
"trackingCode": "4717AEWATCTQ",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Physical",
"status": "InTransitLocked",
"virtualBind": {
"proxy": "22999903520114195",
"created": "2020-07-20T22:55:12"
},
"allowContactless": true,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"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
},
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"trackingCode": "4717AEWATCTQ",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Physical",
"status": "InTransitLocked",
"virtualBind": {
"proxy": "22999903520114195",
"created": "2020-07-20T22:55:12"
},
"allowContactless": true,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"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
},
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"trackingCode": "4717AEWATCTQ",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Physical",
"status": "InTransitLocked",
"virtualBind": {
"proxy": "22999903520114195",
"created": "2020-07-20T22:55:12"
},
"allowContactless": true,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"country": "Brasil"
},
"historyStatus": [
{
"modified": "2020-07-20T22:53:12",
"value": "Building"
},
{
"modified": "2020-07-20T22:55:12",
"value": "InTransitLocked"
}
],
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"trackingCode": "4717AEWATCTQ",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Physical",
"status": "InTransitLocked",
"virtualBind": {
"proxy": "22999903520114195",
"created": "2020-07-20T22:55:12"
},
"allowContactless": true,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"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"
}
],
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"trackingCode": "4717AEWATCTQ",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Physical",
"status": "InTransitLocked",
"virtualBind": {
"proxy": "22999903520114195",
"created": "2020-07-20T22:55:12"
},
"allowContactless": true,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"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"
}
],
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Virtual",
"status": "Active",
"physicalBinds": [
{
"proxy": "2300199994444111999",
"created": "2020-07-20T22:54:03"
}
],
"allowContactless": false,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"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
},
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Virtual",
"status": "Active",
"physicalBinds": [
{
"proxy": "2300199994444111999",
"created": "2020-07-20T22:54:03"
}
],
"allowContactless": false,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"country": "Brasil"
},
"historyStatus": [
{
"modified": "2020-07-20T22:53:12",
"value": "WithoutMovementLocked"
},
{
"modified": "2020-07-20T22:55:12",
"value": "Active"
}
],
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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": "47742663023",
"activateCode": "A9991B2E491D",
"bankAgency": "0001",
"bankAccount": "0001",
"lastFourDigits": "4321",
"proxy": "22999903520114195",
"name": "Nísia Floresta",
"alias": "Meu Cartão",
"cardType": "Virtual",
"status": "Active",
"physicalBinds": [
{
"proxy": "2300199994444111999",
"created": "2020-07-20T22:54:03"
}
],
"allowContactless": false,
"address": {
"zipCode": "05402100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém ",
"state": "PA",
"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"
}
],
"functionalities": [
{
"type": "Pre",
"program": {
"id": 53,
"bin": "234028",
"type": "PhysicalPre",
"brand": "Mastercard"
},
"status": "Enabled"
}
],
"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.
Updated 19 days ago