SelectwinSelectwin

Consulta um cliente

GET/v1/customers/{customerId}

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

Parâmetros do caminho

  • customerIdstringobrigatório

    Identificador público (cus_…)

Respostas

200Sucesso
  • idstringobrigatório

    Identificador público (cus_…)

  • cardsobject[]

    Os cartões salvos do cliente (só na leitura individual).

    +16 campos de cards
    • 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).

  • emailstringobrigatóriopode ser nulo

    Endereço de e-mail; null quando não há.

  • _linksobject

    Links para operações relacionadas, por ação (self, create, update, delete, list…).

  • genderstringobrigatóriopode ser nulo

    Gênero (male, female, other); null quando desconhecido.

  • documentobjectobrigatóriopode ser nulo

    Documento do comprador; null quando não há.

    +2 campos de document
    • typestringobrigatóriopode ser nulo

      Tipo do documento; null quando não há.

      Valores:cpfcnpjpassport
    • numberstringobrigatóriopode ser nulo

      Número do documento (dígitos em CPF/CNPJ); null quando não há.

  • lastNamestringobrigatório

    Sobrenome.

  • 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.

  • metadataobjectobrigatóriopode ser nulo

    Os seus metadados chave-valor; null quando não há.

  • addressesobject[]

    Os endereços do cliente (só na leitura individual).

    +23 campos de addresses
    • idstringobrigatório

      Identificador público (addr_/cad_/cadm_/add_…)

    • citystringobrigatóriopode ser nulo

      Cidade.

    • linestringobrigatóriopode ser nulo

      O endereço inteiro numa linha.

    • line1stringobrigatóriopode ser nulo

      Primeira linha: logradouro e número.

    • line2stringobrigatóriopode ser nulo

      Segunda linha: bairro.

    • line3stringobrigatóriopode ser nulo

      Terceira linha: cidade, estado e CEP.

    • statestringobrigatóriopode ser nulo

      Estado (sigla de duas letras).

    • _linksobject

      Links para operações relacionadas, por ação (self, create, update, delete, list…).

    • numberstringobrigatóriopode ser nulo

      Número.

    • streetstringobrigatóriopode ser nulo

      Logradouro.

    • countrystringobrigatóriopode ser nulo

      Código do país (ISO 3166-1).

    • ownerIdstringobrigatório

      Id público do dono.

    • primarybooleanobrigatório

      Se é o endereço principal do dono.

    • districtstringobrigatóriopode ser nulo

      Bairro.

    • latitudestringobrigatóriopode ser nulo

      Latitude, em graus decimais como texto; null quando desconhecida.

    • 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.

    • metadataobjectobrigatóriopode ser nulo

      Os seus metadados chave-valor; null quando não há.

    • postcodestringobrigatório

      CEP, só dígitos.

    • createdAtstringobrigatório

      Quando o recurso foi criado (ISO 8601, UTC).

    • longitudestringobrigatóriopode ser nulo

      Longitude, em graus decimais como texto; null quando desconhecida.

    • ownerTypestringobrigatório

      Quem é dono do endereço: um customer, a própria company, um user ou um vendor.

      Valores:vendorcustomercompanyuser
    • updatedAtstringobrigatório

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • complementstringobrigatóriopode ser nulo

      Complemento (apartamento, sala, bloco…).

  • availablebooleanobrigatório

    Se o cliente está ativo e pode ser cobrado.

  • birthdatestringobrigatóriopode ser nulo

    Data de nascimento (YYYY-MM-DD); null quando desconhecida.

  • createdAtstringobrigatório

    Quando o recurso foi criado (ISO 8601, UTC).

  • firstNamestringobrigatório

    Nome.

  • telephoneobjectobrigatóriopode ser nulo

    Telefone do comprador, em partes; null quando não há.

    +4 campos de telephone
    • linestringobrigatóriopode ser nulo

      O número inteiro com código do país e DDD.

    • numberstringobrigatóriopode ser nulo

      Número local.

    • areaCodestringobrigatóriopode ser nulo

      DDD.

    • countryCodestringobrigatóriopode ser nulo

      Código do país.

  • updatedAtstringobrigatório

    Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

  • delinquentbooleanobrigatório

    Se o cliente tem pagamentos em atraso.

  • transactionsobject[]

    As cobranças mais recentes do cliente (só na leitura individual).

    +14 campos de transactions
    • idstringobrigatório

      Identificador público (tra_/trx_…)

    • feesintegerobrigatório

      Total de taxas, em centavos.

    • amountstringobrigatório

      Valor cobrado, em centavos (como texto).

    • imagesstring[]obrigatório

      URLs das imagens dos itens.

    • methodstringobrigatório

      Meio de pagamento.

    • statusstringobrigatório

      Status da cobrança.

    • currencystringobrigatório

      Moeda (ISO 4217).

    • customIdstringobrigatóriopode ser nulo

      O seu id personalizado da cobrança; null em cobranças antigas.

    • cardBrandstringobrigatóriopode ser nulo

      Bandeira do cartão; null nos outros meios.

    • createdAtstringobrigatório

      Quando o recurso foi criado (ISO 8601, UTC).

    • updatedAtstringobrigatório

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • approvedAtstringobrigatóriopode ser nulo

      Quando a cobrança foi aprovada; null nos demais casos.

    • customerIdstringobrigatóriopode ser nulo

      O comprador.

    • originalAmountstringobrigatório

      Valor antes dos descontos, em centavos (como texto).

  • subscriptionsobject[]

    As assinaturas mais recentes do cliente (só na leitura individual).

    +27 campos de subscriptions
    • idstringobrigatório

      Identificador público (subs_/sub_…)

    • typestringobrigatóriopode ser nulo

      Tipo da assinatura (recurring).

    • itemsobject[]obrigatório

      Os itens.

      +13 campos de items
      • idstringobrigatório

        Identificador público (sit_/item_…)

      • namestringobrigatório

        Nome do item, vindo da variante.

      • imagesum de[]obrigatóriopode ser nulo

        Imagens da variante; null quando não há.

      • enabledbooleanobrigatório

        Se o item é cobrado nos próximos ciclos.

      • currencystringobrigatório

        Moeda (ISO 4217).

      • metadataobjectobrigatóriopode ser nulo

        Os seus metadados chave-valor do item; null quando não há.

      • quantityintegerobrigatório

        Quantidade.

      • createdAtstringobrigatório

        Quando o recurso foi criado (ISO 8601, UTC).

      • unitPriceintegerobrigatório

        Preço unitário congelado da variante, em centavos.

      • updatedAtstringobrigatório

        Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

      • descriptionstringobrigatóriopode ser nulo

        A sua nota sobre o item.

      • pricingSchemastringobrigatório

        Esquema de preço da variante: unit, tiered ou package.

      • externalReferencestringobrigatóriopode ser nulo

        O seu próprio identificador do item; null quando não há.

    • _linksobject

      Links para operações relacionadas, por ação (self, create, update, delete, list…).

    • methodstringobrigatóriopode ser nulo

      Como os ciclos são cobrados: credit, pix ou billet.

    • splitsobject[]obrigatóriopode ser nulo

      Splits de cada cobrança de ciclo; null quando não há.

      +8 campos de splits
      • idstringobrigatório

        Identificador público (ssp_/split_…)

      • typestringobrigatório

        percentage ou flat.

      • valuenumberobrigatório

        O percentual (0–100) ou o valor fixo, conforme type.

      • liablebooleanobrigatório

        Se o recebedor arca com os chargebacks da fatia.

      • createdAtstringobrigatório

        Quando o recurso foi criado (ISO 8601, UTC).

      • recipientstringobrigatóriopode ser nulo

        A conta que recebe a fatia.

      • updatedAtstringobrigatório

        Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

      • chargeProcessingFeebooleanobrigatório

        Se o recebedor paga a taxa de processamento da fatia.

    • statusstringobrigatório

      Status: active, trialing, pending, paused, pastdue, unpaid ou canceled.

      Valores:activetrialingpendingpausedpastdueunpaidcanceled
    • billingobjectobrigatório

      Periodicidade da cobrança e endereço do pagador.

      +7 campos de billing
      • addressobjectobrigatório

        O endereço do pagador (usado no boleto de cada ciclo). Todos os campos null quando não há.

        +13 campos de address
        • citystringobrigatóriopode ser nulo

          Cidade.

        • linestringobrigatóriopode ser nulo

          O endereço inteiro numa linha.

        • line1stringobrigatóriopode ser nulo

          Primeira linha: logradouro e número.

        • line2stringobrigatóriopode ser nulo

          Segunda linha: bairro.

        • line3stringobrigatóriopode ser nulo

          Terceira linha: cidade, estado e CEP.

        • statestringobrigatóriopode ser nulo

          Estado (sigla de duas letras).

        • numberstringobrigatóriopode ser nulo

          Número.

        • streetstringobrigatóriopode ser nulo

          Logradouro.

        • countrystringobrigatóriopode ser nulo

          Código do país (ISO 3166-1).

        • districtstringobrigatóriopode ser nulo

          Bairro.

        • postcodestringobrigatóriopode ser nulo

          CEP, só dígitos.

        • complementstringobrigatóriopode ser nulo

          Complemento (apartamento, sala, bloco…).

        • fingerprintstringobrigatóriopode ser nulo

          Impressão digital do endereço (deduplicação).

      • endDatestringobrigatóriopode ser nulo

        Quando a assinatura termina; null = nunca.

      • exactDayintegerobrigatóriopode ser nulo

        Dia do mês em que é cobrada; null quando não é fixo.

      • autoRenewbooleanobrigatório

        Se a assinatura se renova sozinha no fim de cada período (false depois de um cancelamento no fim do período).

      • frequencystringobrigatóriopode ser nulo

        Unidade do intervalo de cobrança: daily, weekly, monthly ou yearly.

      • freeTrialDaysintegerobrigatóriopode ser nulo

        Duração do período de teste, em dias; null quando não há.

      • frequencyCountintegerobrigatóriopode ser nulo

        Quantas unidades por ciclo.

    • callbackobjectobrigatóriopode ser nulo

      Webhook próprio; null quando não há.

      +2 campos de callback
      • activebooleanobrigatório

        Se o webhook próprio está ativo.

      • webhookUrlstringobrigatório

        URL que recebe os webhooks desta assinatura.

    • currencystringobrigatóriopode ser nulo

      Moeda (ISO 4217).

    • customerobjectobrigatório

      O comprador.

      +15 campos de customer
      • idstringobrigatóriopode ser nulo

        Id do cliente (cus_…).

      • emailstringobrigatóriopode ser nulo

        Endereço de e-mail.

      • genderstringobrigatóriopode ser nulo

        Gênero; null quando desconhecido.

      • documentobjectobrigatóriopode ser nulo

        Documento do comprador; null quando não há.

        +2 campos de document
        • typestringobrigatóriopode ser nulo

          Tipo do documento.

        • numberstringobrigatóriopode ser nulo

          Número do documento.

      • lastNamestringobrigatóriopode ser nulo

        Sobrenome.

      • metadataobjectobrigatóriopode ser nulo

        Os seus metadados chave-valor; null quando não há.

      • availablebooleanobrigatóriopode ser nulo

        Se o cliente está ativo e pode ser cobrado.

      • birthdatestringobrigatóriopode ser nulo

        Data de nascimento (YYYY-MM-DD); null quando desconhecida.

      • createdAtstringobrigatóriopode ser nulo

        Quando o recurso foi criado (ISO 8601, UTC).

      • firstNamestringobrigatóriopode ser nulo

        Nome.

      • telephoneobjectobrigatóriopode ser nulo

        Telefone do comprador, em partes; null quando não há.

        +4 campos de telephone
        • linestringobrigatóriopode ser nulo

          O número inteiro com código do país e DDD.

        • numberstringobrigatóriopode ser nulo

          Número local.

        • areaCodestringobrigatóriopode ser nulo

          DDD.

        • countryCodestringobrigatóriopode ser nulo

          Código do país.

      • updatedAtstringobrigatóriopode ser nulo

        Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

      • delinquentbooleanobrigatóriopode ser nulo

        Se o cliente tem pagamentos em atraso.

      • additionalEmailsstring[]obrigatóriopode ser nulo

        Outros e-mails; null quando não há.

      • externalReferencestringobrigatóriopode ser nulo

        O seu próprio identificador do cliente.

    • discountobjectobrigatóriopode ser nulo

      Desconto aplicado; null quando não há.

      +3 campos de discount
      • typestringobrigatório

        flat ou percentage.

      • valuenumberobrigatório

        O desconto.

      • percentageOfAmountnumberobrigatóriopode ser nulo

        O desconto como percentual do valor.

    • 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.

    • metadataobjectobrigatóriopode ser nulo

      Os seus metadados chave-valor; null quando não há.

    • shippingobjectobrigatóriopode ser nulo

      Retrato do frete, como enviado; null quando não há.

    • spplitedbooleanobrigatório

      Se as cobranças dos ciclos são divididas com outras contas (ver splits). O nome mantém a grafia histórica.

    • createdAtstringobrigatório

      Quando o recurso foi criado (ISO 8601, UTC).

    • discountsany[]obrigatóriopode ser nulo

      Os cupons aplicados; null quando não há.

    • shippablebooleanobrigatório

      Se a assinatura tem itens físicos para enviar.

    • updatedAtstringobrigatório

      Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • canceledAtstringobrigatóriopode ser nulo

      Quando a assinatura foi encerrada; null enquanto está viva.

    • geolocationobjectobrigatóriopode ser nulo

      Sinais de dispositivo e localização do comprador, como enviados; null quando não há.

    • cancellationobjectobrigatóriopode ser nulo

      Por que foi cancelada; null enquanto ninguém pediu o cancelamento.

      +3 campos de cancellation
      • reasonstringobrigatóriopode ser nulo

        O texto livre escrito por quem cancelou.

      • canceledBystringobrigatóriopode ser nulo

        seller (API ou painel), customer (portal) ou platform (régua de cobrança, chargeback, estorno).

        Valores:sellercustomerplatform
      • reasonCodestringobrigatóriopode ser nulo

        O motivo da lista; null nos cancelamentos antigos e nos da própria plataforma.

        Valores:pricenot_usingtechnical_issueswitched_providerother
    • currentCycleobjectobrigatóriopode ser nulo

      O ciclo de cobrança atual; null quando não há.

      +9 campos de currentCycle
      • idstringobrigatório

        Identificador público (scy_/cycle_…)

      • cycleintegerobrigatório

        Número do ciclo (1 = o primeiro).

      • statusstringobrigatório

        Status do ciclo: scheduled, processing, paid, failed ou canceled.

      • dueDatestringobrigatório

        Quando o ciclo é cobrado (ou vence).

      • endDatestringobrigatóriopode ser nulo

        Quando o ciclo termina; null enquanto aberto.

      • billedAtstringobrigatóriopode ser nulo

        Quando o ciclo foi cobrado; null até lá.

      • createdAtstringobrigatório

        Quando o recurso foi criado (ISO 8601, UTC).

      • startDatestringobrigatório

        Quando o ciclo começa.

      • updatedAtstringobrigatório

        Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).

    • pixAutomaticobjectpode ser nulo

      Só na leitura individual; null quando a assinatura não é paga por Pix Automático.

      +8 campos de pixAutomatic
      • statusstringobrigatório

        pending (sendo criado) · awaitingAuthorization (QR code exibido) · active (debitado a cada ciclo) · rejected (o pagador recusou ou revogou) · ended. Depois de rejected/ended os ciclos são cobrados por um QR code cada.

        Valores:pendingawaitingAuthorizationactiverejectedended
      • journeystringobrigatório

        paymentOnApproval: o primeiro ciclo é pago junto com a autorização; onlyRecurrency: só a recorrência é autorizada.

        Valores:paymentOnApprovalonlyRecurrency
      • endReasonstringobrigatóriopode ser nulo

        Por que terminou; null enquanto ativo.

      • qrCodeEmvstringobrigatóriopode ser nulo

        O QR code de autorização (copia e cola) — só enquanto awaitingAuthorization.

      • qrCodeUrlstringobrigatóriopode ser nulo

        URL da imagem do QR code de autorização — só enquanto awaitingAuthorization.

      • approvedAtstringobrigatóriopode ser nulo

        Quando o pagador autorizou; null até lá.

      • valueCentsintegerobrigatório

        O valor fixo debitado a cada ciclo, em centavos.

      • firstChargeDatestringobrigatório

        Data do primeiro débito.

    • renewalTermsobjectobrigatóriopode ser nulo

      O que cada renovação cobra além dos itens, congelado na criação; null = nada congelado (as renovações cobram itens menos cupons).

      +5 campos de renewalTerms
      • shippingbooleanobrigatório

        Se o frete é cobrado em cada renovação.

      • discountMethodstringobrigatóriopode ser nulo

        O meio que concedeu o desconto no checkout; null quando nenhum.

        Valores:creditpixbillet
      • methodDiscountbooleanobrigatório

        Se o desconto do meio de pagamento vale nas renovações cobradas por discountMethod.

      • shippingAmountintegerobrigatório

        O frete cotado no checkout, em centavos (0 = sem frete).

      • discountPercentagenumberobrigatório

        O desconto desse meio, como percentual (ex.: 5 = 5%).

    • externalReferencestringobrigatóriopode ser nulo

      O seu próprio identificador da assinatura; null quando não há.

  • additionalEmailsstring[]obrigatóriopode ser nulo

    Outros e-mails do comprador; null quando não há.

  • externalReferencestringobrigatóriopode ser nulo

    O seu próprio identificador deste cliente; null quando não há.

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

Preferências de cookies

Hoje o site usa só cookies essenciais: nenhuma ferramenta de medição ou de anúncios está ligada, e nada é compartilhado com terceiros. Se isso mudar, você decide aqui antes de qualquer coisa ser carregada.

  • Mantêm o site funcionando: segurança, a sua escolha sobre cookies e preferências como a versão da documentação. Não dependem de consentimento.

    Sempre ativos