Obter detalhes do cliente

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

Retorna os detalhes de um cliente específico, com base no ID fornecido. Nota: É necessário fornecer o ID do cliente para obter os detalhes.

Respostas

200Detalhes do cliente retornados com sucesso

Corpo da resposta

application/json

idstring
O ID do cliente.
namestring
O nome do cliente.
emailstring
O email do cliente.
cc_emailsstring
Os emails CC do cliente.
cpfstring
O CPF do cliente se pessoa física.
cnpjstring
O CNPJ do cliente se pessoa jurídica.
phonestring
O telefone do cliente.
cepstring
O CEP do cliente.
addressstring
O endereço do cliente.
numberstring
O número do endereço do cliente.
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.
state_enrollmentstring
A inscrição estadual do cliente.
city_enrollmentstring
A inscrição municipal do cliente.
tax_regimestring
O regime tributário do cliente.
special_tax_regimestring
O regime tributário especial do cliente.
icms_taxpayerstring
O contribuinte do ICMS do cliente.
created_atstringdate-time
A data e hora em que o cliente foi criado.
updated_atstringdate-time
A data e hora em que o cliente foi atualizado.
receipt_configobject
A configuração do recibo do cliente.

Exemplo

{
  "id": "string",
  "name": "string",
  "email": "string",
  "cc_emails": "string",
  "cpf": "string",
  "cnpj": "string",
  "phone": "string",
  "cep": "string",
  "address": "string",
  "number": "string",
  "complement": "string",
  "district": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "state_enrollment": "string",
  "city_enrollment": "string",
  "tax_regime": "string",
  "special_tax_regime": "string",
  "icms_taxpayer": "string",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "receipt_config": {}
}

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

Respostas

Credenciais

Resposta