Criar novo cliente

O cliente é uma figura essencial no fluxo de pagamentos, pois representa quem de fato irá realizar um pagamento. Ao criar um cliente na NinePay, um ID único será retornado. Recomendamos vincular este ID aos dados do usuário em seu sistema para evitar a criação de múltiplas contas na NinePay para o mesmo cliente.

application/json

Request Body required

Descreve os dados a serem incluídos no corpo da requisição.

name string required

O nome do cliente.

email string required

O email do cliente.

cpf string

O CPF do cliente se pessoa física.

cnpj string

O email do cliente se pessoal jurídica.

phone string

O telefone do cliente.

cep string

O CEP do cliente.

address string

O endereço do cliente.

number string

O número do endereço do cliente.

complement string

O complemento do endereço do cliente.

district string

O bairro do cliente.

city string

A cidade do cliente.

state string

A sigla do estado do cliente.

country string

A sigla do país do cliente.

status CustomerStatus

Possible values: [1, 2]

O status do cliente. 1 = Ativo 2 = Inativo

Responses

• 200
• 401
• 422
• 500

---

Cliente criado com sucesso

application/json

Schema

Example (from schema)

---

Schema

id integer required

O id do cliente na NinePay. Obrigatório se os demais dados do usuário não forem informados

name string required

O nome do cliente. Obrigatório se o id não for informado

email string required

O email do cliente. Obrigatório se o id não for informado

cpf string required

O cpf do cliente. Obrigatório se o id ou o cnpj não forem informados

cnpj string required

O cnpj do cliente. Obrigatório se o id ou o cpf não forem informados

phone string

O telefone do cliente

cep string

O CEP do cliente

address string

O endereço do cliente

number string

O endereço do cliente

district string

O bairro do cliente

city string

A cidade do cliente

state string

O estado do cliente

country string

O código do país do cliente, no formato Alpha 2 de acordo com a ISO 3166.

{
  "id": 42,
  "name": "Jhon Doe",
  "email": "jhon@doe.com",
  "cpf": "833.828.600-15",
  "cnpj": "95.135.209/0001-79",
  "phone": "(11) 11111-1111",
  "cep": "01423-910",
  "address": "Rua José Maria Lisboa",
  "number": 42,
  "district": "Jardim Paulista",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR"
}

Não autorizado

application/json

Schema

Example (from schema)

Example

---

Schema

message string required

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

Erro na validação de dados

application/json

Schema

Example (from schema)

Example

---

Schema

message string required
errors object
property name* string

{
  "message": "string",
  "errors": {}
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": "The name field is required."
  }
}

Houve um erro inesperado

application/json

Schema

Example (from schema)

Example

---

Schema

message string required

{
  "message": "string"
}

{
  "message": "An unexpected error occurred"
}

Loading...