Cria um cliente

POST/v1/customers

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

Corpo da requisição

emailstring (email)obrigatório
Endereço de e-mail do comprador.
genderstring
Gênero: male, female ou other.
Valores:malefemaleother
documentobject
Documento do comprador (CPF, CNPJ ou passaporte). As duas partes são opcionais: pode vir depois, ou com a cobrança.
+2 campos de document
- typestring
  Tipo do documento: cpf, cnpj ou passport.
  Valores:cpfcnpjpassport
- numberstring
  Número do documento: dígitos do CPF ou CNPJ, ou o número do passaporte.
lastNamestringobrigatório
Sobrenome.
metadataobject
Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.
birthdatestring
Data de nascimento, YYYY-MM-DD.
firstNamestringobrigatório
Nome.
telephoneobject
Telefone do comprador, em partes. Cada parte é opcional; line é o número inteiro.
+4 campos de telephone
- linestring
  O número inteiro com código do país e DDD (ex.: 5511987654321). O único telefone que chega ao provedor de pagamento.
- numberstring
  Número local, só dígitos.
- areaCodestring
  DDD (ex.: 11).
- countryCodestring
  Código do país (ex.: 55).
additionalEmailsstring (email)[]
Outros e-mails do comprador (até 20).
externalReferencestring
O seu próprio identificador deste cliente (texto livre, devolvido como veio).

Respostas

201Criado

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

400Requisição inválida (validação)

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

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

409Conflito (idempotência ou estado)

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

AnteriorLista os clientes PróximaConsulta um cliente

curl -X POST "https://api.selectwin.io/v1/customers" \ -H "SelectKey: $SELECTWIN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "email": "buyer@example.com", "gender": "male", "document": { "type": "cpf", "number": "12345678909" }, "lastName": "Silva", "metadata": {}, "birthdate": "1990-05-20", "firstName": "João", "telephone": { "line": "5511987654321", "number": "987654321", "areaCode": "11", "countryCode": "55" }, "additionalEmails": [ "buyer@example.com" ], "externalReference": "string" }'

{ "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" }