Sign in

v1

latestOpenAPI 3.1.02026-07-2440101174.2 KB
Consulta de cartões

Por documento (CPF ou CNPJ)

<div class="bkly-ref-description"> <p>Consulte os dados de um cartão por meio do número de documento (CPF ou CNPJ) do seu titular.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: card.read</span> </div>
get/cards/document/{documentNumber}

Path parameters

documentNumberstring required

Número do documento de CPF ou CNPJ (informe somente números). Tamanho máximo de 14 caracteres.

Headers

api-versionstring required

Versão da API. Atualmente estamos na versão 1.0.

Authorizationstring required

<em>Token</em> de autorização do tipo Bearer.

Response

Lista com os cartões pertecentes ao documento.

createdstring date-time

Data de criação do cartão.

companyKeystring

Chave que identifica o parceiro dentro do Bankly.

documentNumberstring

<b>Obsoleto</b>. Utilize o campo <code>holder.document.value</code>.

activateCodestring

Código de ativação do cartão.

trackingCodestring

Código de rastreio do cartão. Campo retornado <b>apenas</b> para cartões físicos.

bankAgencystring

Número da agência do cliente.

bankAccountstring

Número da conta do cliente.

lastFourDigitsstring

Quatro últimos dígitos do cartão.

proxystring

Código identificador do cartão.

namestring

Nome impresso no cartão.

aliasstring

Apelido definido pelo proprietário para o cartão.

cardType'Physical' | 'Virtual'
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.

allowContactlessboolean

Indica se é permitido pagamento por aproximação.

activatedAtstring date-time

Data da ativação do cartão.

lastUpdatedAtstring date-time

Data da última atualização do cartão.

isActivatedboolean

Indica se o cartão está ativo.

isLockedboolean

Indica se o cartão está bloqueado.

isCanceledboolean

Indica se o cartão está cancelado.

isBuildingboolean

Indica se o cartão está em construção.

isFirtualboolean

Indica se o cartão é Firtual.

isPreboolean

Indica se o cartão é pré-pago.

isPosboolean

Indica se o cartão é pós-pago.

isComboboolean

Indica se o cartão é combo.