Lista os cartões

GET/v1/cards

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Ordem pela data de criação.
Valores:ascendingdescending
holderidstring
Só os cartões deste cliente.
idstring
Só este cartão.

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+16 campos de data
- idstringobrigatório
  Identificador público (card_…)
- brandstringobrigatório
  Bandeira do cartão (ex.: visa, mastercard).
- validbooleanobrigatório
  Se o cartão passou na validação.
- _linksobject
  Links para operações relacionadas, por ação (self, create, update, delete, list…).
- activebooleanobrigatório
  Se o cartão pode ser cobrado.
- primarybooleanobrigatório
  Se é o cartão principal do cliente.
- merchantobject
  A conta dona do recurso (o vendedor de registro).
  +3 campos de merchant
  - namestringobrigatóriopode ser nulo
    Nome fantasia da conta dona do recurso.
  - merchantIdstringobrigatóriopode ser nulo
    Id público da conta dona do recurso (bus_…).
  - isSubAccountbooleanobrigatório
    true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
- verifiedbooleanobrigatório
  Se o cartão foi verificado com o emissor.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- associatedbooleanobrigatóriopode ser nulo
  Se o cartão está vinculado ao cliente para cobrança. null = pendente: o cartão entrou por uma tela do comprador e ainda não tem cobrança aprovada.
- holderNamestringobrigatóriopode ser nulo
  Nome impresso no cartão.
- lastDigitsstringobrigatório
  Quatro últimos dígitos do cartão.
- firstDigitsstringobrigatório
  Seis primeiros dígitos do cartão (BIN).
- expirationYearstringobrigatório
  Ano de validade (YYYY).
- expirationMonthstringobrigatório
  Mês de validade (MM).
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorExclui um endereço PróximaCria um cartão

{ "data": [ { "id": "card_0a1b2c3d4e5f60718293", "brand": "string", "valid": true, "_links": {}, "active": true, "primary": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "verified": true, "createdAt": "string", "updatedAt": "string", "associated": true, "holderName": "JOAO SILVA", "lastDigits": "string", "firstDigits": "string", "expirationYear": "string", "expirationMonth": "string" } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "_links": {}, "offset": 0, "hasMore": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true } }