Lista os clientes

GET/v1/customers

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

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
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).
idstring
Só este cliente.
emailstring (email)
Só o cliente com este e-mail.
namestring
Clientes cujo nome contém este texto.
telephonelinestring
Só o cliente com esta linha de telefone (número inteiro, só dígitos).
documentstring
Só o cliente com este documento (dígitos do CPF/CNPJ).
externalreferencestring
Só o cliente com esta referência externa sua.

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+17 campos de data
- idstringobrigatório
  Identificador público (cus_…)
- 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á.
- 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.
- 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á.
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

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

AnteriorCartões de teste PróximaCria um cliente

{ "data": [ { "id": "cus_0a1b2c3d4e5f60718293", "email": "buyer@example.com", "_links": {}, "gender": "string", "document": { "type": "cpf", "number": "12345678909" }, "lastName": "Silva", "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "metadata": {}, "available": true, "birthdate": "1990-05-20", "createdAt": "string", "firstName": "João", "telephone": { "line": "5511987654321", "number": "987654321", "areaCode": "11", "countryCode": "55" }, "updatedAt": "string", "delinquent": true, "additionalEmails": [ "string" ], "externalReference": "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 } }