Desativar conta

POST

/vintem/v1/contas/{id}/desativar

curl --request POST \
  --url http://localhost:8080/vintem/v1/contas/example/desativar \
  --header 'Authorization: Bearer <token>'

Novas cobranças passam a ser recusadas; as existentes continuam valendo.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

/^[a-z0-9][a-z0-9-]{0,62}$/

Responses

200

Conta desativada.

Media typeapplication/json

object

id

required

string

nome

required

string

psp

required

string

chave

required

Chave Pix do recebedor (telefone, e-mail, CPF/CNPJ ou EVP).

string

<= 77 characters

ambiente

required

string

Allowed values: homologacao producao

ativa

required

boolean

certificado

Dados públicos do certificado do mTLS, conferido no cadastro (RN-62). O certificado e a chave privada nunca saem do Vintém. Ausente se a conta não tiver certificado.

object

sujeito

required

string

impressaoDigital

required

SHA-256 do certificado (DER), em hexadecimal minúsculo.

string

/^[0-9a-f]{64}$/

validade

required

Fim da validade (NotAfter), em UTC.

string format: date-time

Example

{
  "ambiente": "homologacao",
  "certificado": {
    "sujeito": "CN=loja.example.com,O=Loja"
  }
}

default

Qualquer outro erro, sempre como Problema. Os mais comuns: 502 quando o banco recusa ou falha (PSPIndisponivel) e 500 para erro interno.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

correlationId

string

violacoes

Array<object>

object

razao

string

propriedade

string

valor

string

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}