Pular para o conteúdo principal

Deletar Cliente


Esta rota realiza um soft delete no cliente, ou seja:
o registro não é removido permanentemente, apenas tem seu status atualizado para indicar que não está mais ativo no sistema.

Isso garante integridade histórica, permitindo manter faturas, logs e relações intactas.


Autenticação

Esta rota exige autenticação via API Key.

cURL da chamada
curl -X DELETE https://api.onnixpay.com/api/sdk/customers/{{clientId}} \
-H "X-API-Key: ox_your_key" \

Parâmetros de URL

ParâmetroTipoObrigatórioDescrição
idstring
✔️
ID do cliente que será marcado como deletado
Sucesso 404
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "OCD001",
"message": "O ID fornecido não corresponde a nenhum cliente."
}
}
Sucesso 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "OCD001",
"message": "O identificador está em formato incorreto."
}
}
Sucesso 409
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "OCD001",
"message": "O cliente não pode ser marcado como deletado devido a regras internas (ex.: está vinculado a uma cobrança em aberto)."
}
}