SopagueDocs
v3

Desativar Cliente

POST/v2/payment-customers/{customerId}/deactivate

Inativa o cliente. Não permite novas contratações, mas preserva todo o histórico relacional e faturas.

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT Bearer autenticado
Idempotency-Key<guid_ou_string>SimChave de idempotência

Parâmetros

Exemplo de requisição
curl --request POST \
  --url 'https://api.sopague.com.br/gateway/v2/payment-customers/{customerId}/deactivate' \
  --header 'Authorization: Bearer {token}'

Resposta (200 OK)

Exemplo de resposta
{
  "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "status": "INACTIVE"
}

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Ver validações observadas em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "Idempotency-Key": [
      "The key field is required."
    ]
  },
  "traceId": "00-be0233f6f328caad5f070ef4e346a06b-e3e477bf57400247-00"
}

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.