Consultar subconta

🚧 Atenção

O token gerado no momento de criar a subconta não será mais retornado nas consultas, caso necessário, gere um novo token em "Novo token"

GET{apiUrl}/subaccount/{id}

URL base da API

Token de autenticação

Path Params

idstringrequired

Id da subconta

curl --request GET \
  --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_transferstring

Modelo de repasse financeiro

negotiationobject

Configurações de negociação e tarifas

negotiation.days_transfer_storeinteger

Dias para repasse de crédito

negotiation.days_transfer_pix_storeinteger

Dias para repasse de Pix

negotiation.days_transfer_boleto_storeinteger

Dias para repasse de boleto

negotiation.retention_days_release_onlineinteger

Dias de retenção online

negotiation.retention_daily_onlineinteger

Retenção diária online

negotiation.boleto.mdrnumber

MDR do boleto

negotiation.boleto.mdr_typestring

Tipo de MDR: FIXED ou VARIABLE

negotiation.boleto.fee_transactioninteger

Taxa fixa por transação de boleto

negotiation.pix_online.mdrnumber

MDR do Pix online

negotiation.pix_online.mdr_typestring

Tipo de MDR: FIXED ou VARIABLE

negotiation.pix_online.fee_transactioninteger

Taxa fixa por transação de Pix

negotiation.credit.fee_transactioninteger

Taxa fixa por transação de crédito

negotiation.credit.installmentsarray

Configuração por número de parcelas

negotiation.credit.installments[].installmentinteger

Número da parcela

negotiation.credit.installments[].mdrnumber

MDR da parcela

negotiation.credit.installments[].feesinteger

Juros

negotiation.credit.installments[].effective_ratenumber

Taxa efetiva

negotiation.credit.installments[].interest_rate_ournumber

Taxa de juros própria

negotiation.mdr_signaturenumber

MDR de assinatura recorrente

negotiation.withdraw.feenumber

Taxa de saque

negotiation.withdraw.limit_transferinteger

Limite de transferência

negotiation.fee_cashbackinteger

Taxa de cashback

platform.fee_details.fee_withdraw.valuenumber

Valor da taxa de saque da plataforma

platform.fee_details.fee_withdraw.typestring

Tipo da taxa (fixed)

financial_pixoutobject

Chave Pix para saída financeira

financial_pixout.keystring

Chave Pix

financial_pixout.typestring

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

statusstring

Status da subconta: approved, pending, rejected, blocked ou cancelled

msgstring

Mensagem de retorno

credentials.public_leystring

Chave pública da subconta

credentials.tokenstring

Token mascarado (gerado no cadastro)

created_atstring

Data de criação (ISO 8601)

updated_atstring

Data de atualização (ISO 8601)