---
title: "Por código de ativação"
method: GET
path: "/cards/activateCode/{activationCode}"
tags: ["Consulta de cartões"]
---

# Por código de ativação

`GET /cards/activateCode/{activationCode}`

<div class="bkly-ref-description">
  <p>Consulte os dados de um cartão por meio do seu código de ativação.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> 
  <span class="bkly-ref-scope-tag">scope: card.read</span>
</div>

## Path parameters

- `activationCode` string, required

## Headers

- `api-version` string, required — Versão da API. Atualmente estamos na versão 1.0.
- `Authorization` string, required — <em>Token</em> de autorização do tipo Bearer.

## Response `200`

Lista com os cartões com o código de ativação informado.

- CardResponse[]
  - `created` string, date-time — Data de criação do cartão.
  - `companyKey` string — Chave que identifica o parceiro dentro do Bankly.
  - `holder` object — Objeto que contém informações sobre o titular do cartão.
    - `name` string — Nome do titular do cartão.
    - `document` object — Objeto que contém informações sobre o documento do titular do cartão.
      - `value` string — Número do documento do cliente.
      - `type` string — Tipo do documento (CPF ou CNPJ).
  - `documentNumber` string — <b>Obsoleto</b>. Utilize o campo <code>holder.document.value</code>.
  - `activateCode` string — Código de ativação do cartão.
  - `trackingCode` string — Código de rastreio do cartão. Campo retornado <b>apenas</b> para cartões físicos.
  - `bankAgency` string — Número da agência do cliente.
  - `bankAccount` string — Número da conta do cliente.
  - `lastFourDigits` string — Quatro últimos dígitos do cartão.
  - `proxy` string — Código identificador do cartão.
  - `name` string — Nome impresso no cartão.
  - `alias` string — Apelido definido pelo proprietário para o cartão.
  - `cardType` 'Physical' | 'Virtual'
  - `physicalBinds` object[] — 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 (<code>cardType</code>) seja "Virtual".
    - `proxy` string — Código identificador do cartão físico.
    - `created` string, date-time — Data de criação do cartão.
  - `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 (<code>cardType<code>) seja "Physical".
    - `proxy` string — Código identificador do cartão virtual.
    - `created` string, date-time — Data de criação do cartão.
  - `status` 'Active' | 'TemporarilyUserLocked' | 'CanceledByCustomer' | 'CanceledByEmitter' | 'DeathCanceled' | 'LostOrTheftCanceled' | 'CardDamagedCanceled' | 'CardBrokenCanceled' | 'CardWithDefectCanceled' | 'RobbedCanceled' — Para compreender o que representa cada <i>status</i>, consulte a documentação [Possíveis status do cartão](/docs/tabela-possiveis-status-cartao).
  - `additionalCards` object[] — Lista de objetos contendo os cartões adicionais do cliente.
    - `proxy` string — Código identificador do cartão.
    - `created` string — Data de criação do cartão.
    - `holder` object — Informações sobre o portador do cartão adicional.
      - `name` string — Nome do portador do cartão adicional.
      - `document` object — Documento do portador do cartão adicional.
        - `value` string — Número do documento do cliente.
        - `type` string — Tipo do documento (CPF ou CNPJ).
  - `allowContactless` boolean — Indica se é permitido pagamento por aproximação.
  - `address` AddressResponse — Objeto que contém informações sobre o endereço do cliente.
    - `zipCode` string — Código postal de endereço.
    - `address` string — Logradouro (nome da rua, avenida etc.).
    - `number` string — Número do imóvel.
    - `complement` string — Complemento do endereço.
    - `neighborhood` string — Nome do bairro.
    - `city` string — Nome da cidade.
    - `state` string — Nome do estado. Formato ISO 3166-2:BR.
    - `country` string — Nome do país. Formato ISO 3166-2:BR.
  - `historyStatus` object[] — Lista de objetos contendo o histórico de <i>status</i> do cartão desde sua criação.
    - `modified` string, date-time — Data em que o <i>status</i> foi aplicado.
    - `value` 'Active' | 'TemporarilyUserLocked' | 'CanceledByCustomer' | 'CanceledByEmitter' | 'DeathCanceled' | 'LostOrTheftCanceled' | 'CardDamagedCanceled' | 'CardBrokenCanceled' | 'CardWithDefectCanceled' | 'RobbedCanceled' — Para compreender o que representa cada <i>status</i>, consulte a documentação [Possíveis status do cartão](/docs/tabela-possiveis-status-cartao).
  - `wallets` object[] — Lista de objetos que contém a identificação das carteiras digitais às quais o cartão se encontra vinculado. Essa lista **somente** será retornada se o cartão estiver inserido em uma carteira digital.
    - `status` 'Approved' | 'Denied'
    - `walletType` 'GooglePay' | 'ApplePay' — Carteira digital à qual o cartão deverá ser adicionado.
    - `walletFlowAdd` 'Undefined' | 'GreenPatch' | '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.
    - `contractNumber` string — Número do contrato de crédito do cliente.
    - `limit` number — Limite de crédito do cliente.
    - `limitActive` number — Limite de crédito ativo do cliente.
  - `functionalities` object[] — Lista de objetos que contém informações sobre as modalidades do cartão.
    - `type` string — Tipo de modalidade associada ao cartão, que pode ser “Debit", "Pos" ou "Pre".
    - `program` ProgramFunctionalities — Objeto que contém informações sobre o programa ao qual a modalidade está vinculada.
      - `id` number — Identificador único do programa.
      - `bin` string — O BIN, ou <i>Bank Identification Number</i>, são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu.
      - `type` string — Tipo do programa que define a modalidade do cartão.
      - `brand` string — Bandeira do cartão.
    - `status` string — <i>Status</i> da modalidade, que pode ser "Enabled" (ativado), Disabled" (desativado), "Blocked" (bloqueado) e “BlockedByContract" (bloqueado por contrato).
  - `activatedAt` string, date-time — Data da ativação do cartão.
  - `lastUpdatedAt` string, date-time — Data da última atualização do cartão.
  - `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.

## Other responses

- `404` — unresolved $ref

---

[API](https://skmtc.net/bankly/apis/autentica-o.md) · [All operations](https://skmtc.net/bankly/apis/autentica-o/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bankly/autentica-o/revisions/e20afa10cd0e/schema)
