Excluir cliente

DELETE /customers/{customerId}/{typeId}

Para utilizar esse método, o access_token deve conter o scope customers.write

Método utilizado para excluir clientes.

Parâmetros da URL:

{customerId}: Id do cliente a ser removido.
{typeId}: Tipo do id. Opções:
- galaxPayId: Id no cel_cash
- myId: Id referente no seu sistema, para salvar no cel_cash.

URL da Requisição

https://api.sandbox.cel.cash/v2/customers/ /

URL da Requisição

https://api.sandbox.cel.cash/v2/customers/1/myId

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Cliente removido com sucesso.

209

O cliente foi removido, porém, não foi encontrado nenhuma cobrança avulsa/assinatura para cancelar.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Cliente não encontrado.