Criar novo cliente

POSThttps://api.sandbox.cefispay.com.br/api/v1/customers

RECIPES

Criar um cliente e cobrar no PIXAbrir recipe

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. Cartão de crédito: para cobrar um cliente no cartão, o cadastro dele precisa ter CPF ou CNPJ, telefone, CEP e número do endereço. Esses dados são enviados à adquirente como dados do titular, e a cobrança é recusada se algum deles estiver faltando. Recomendamos cadastrar o cliente com o máximo de informações possível, mesmo que hoje você só cobre por boleto ou Pix.

Parâmetros do body

obrigatórioapplication/json

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

namestringobrigatório
O nome do cliente.
emailstringobrigatório
O email do cliente.
cpfstring
O CPF do cliente, se pessoa física. Obrigatório para cobranças no cartão de crédito.
cnpjstring
O CNPJ do cliente, se pessoa jurídica. Obrigatório para cobranças no cartão de crédito.
phonestring
O telefone celular do cliente, com DDD. Obrigatório para cobranças no cartão de crédito.
cepstring
O CEP do cliente. Obrigatório para cobranças no cartão de crédito.
addressstring
O endereço do cliente.
numberstring
O número do endereço do cliente. Obrigatório para cobranças no cartão de crédito.
complementstring
O complemento do endereço do cliente.
districtstring
O bairro do cliente.
citystring
A cidade do cliente.
statestring
A sigla do estado do cliente.
countrystring
A sigla do país do cliente.
statusinteger
O status do cliente. 1 = Ativo 2 = Inativo
Valores permitidos:12

Respostas

200Cliente criado com sucesso

Corpo da resposta

application/json

idintegerobrigatóriosomente leitura
O id do cliente na NinePay. Obrigatório se os demais dados do usuário não forem informados
namestringobrigatório
O nome do cliente. Obrigatório se o id não for informado
emailstringobrigatório
O email do cliente. Obrigatório se o id não for informado
cpfstringobrigatório
O cpf do cliente. Obrigatório se o id ou o cnpj não forem informados
cnpjstringobrigatório
O cnpj do cliente. Obrigatório se o id ou o cpf não forem informados
phonestring
O telefone celular do cliente, com DDD. Obrigatório para cobranças no cartão de crédito.
cepstring
O CEP do cliente. Obrigatório para cobranças no cartão de crédito.
addressstring
O endereço do cliente
numberstring
O número do endereço do cliente. Obrigatório para cobranças no cartão de crédito.
districtstring
O bairro do cliente
citystring
A cidade do cliente
statestring
O estado do cliente
countrystring
O código do país do cliente, no formato Alpha 2 de acordo com a ISO 3166.

Exemplo

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

401Não autenticado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "AUTHENTICATION_ERROR",
  "message": "Não autenticado.",
  "timestamp": "2026-10-22T12:03:44+00:00",
  "request_id": "f2a7e962-6083-4525-816e-f14d4a602e0a",
  "documentation_url": "https://docs.ninepay.com.br"
}

422Erro na validação dos dados

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "VALIDATION_ERROR",
  "message": "Os dados informados são inválidos.",
  "errors": {
    "email": [
      "O campo email é obrigatório."
    ]
  },
  "timestamp": "2026-10-22T12:03:54+00:00",
  "request_id": "64d62d36-e797-45ed-a9d5-c203bde81032",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Corrija os campos e tente novamente."
}

500Erro inesperado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

RECIPES

Parâmetros do body

Respostas

Credenciais

Resposta