Cancelar subconta

DELETE{apiUrl}/subaccount/{id}

URL base da API

Token de autenticação

Path Params

idstringrequired

Id da subconta

curl --request DELETE \
  --url "{apiUrl}/subaccount/{id}"

Response

Choose an example:

application/json

Campos da resposta

idstring

ID único da subconta (UUID)

corporate_docstring

CNPJ da empresa

corporate_namestring

Razão social da empresa

namestring

Nome fantasia

external_referencestring

Referência externa do integrador

addressobject

Endereço da subconta

address.streetstring

Logradouro

address.numberstring

Número

address.neighborhoodstring

Bairro

address.zip_codestring

CEP

address.citystring

Cidade

address.statestring

Estado (UF)

partner_admobject

Dados do sócio administrador

partner_adm.namestring

Nome completo

partner_adm.docstring

CPF

partner_adm.birthdatestring

Data de nascimento (YYYY-MM-DD)

partner_adm.emailstring

E-mail

partner_adm.phonestring

Telefone

supportobject

Dados de contato de suporte

support.phonestring

Telefone de suporte

support.emailstring

E-mail de suporte

support.sitestring

Site

financial_pixoutobject

Chave Pix de saída financeira

financial_pixout.keystring

Chave Pix

financial_pixout.typestring

Tipo da chave: CNPJ, CPF, EMAIL, PHONE ou EVP

statusstring

Status da subconta — retorna CANCELLED após o cancelamento

msgstring

Mensagem de retorno

credentials.public_leystring

Chave pública (null após cancelamento)

credentials.tokenstring

Token (null após cancelamento)

created_atstring

Data de criação (ISO 8601)

updated_atstring

Data de atualização (ISO 8601)