Atualiza uma sub-conta (taxa da plataforma)
/v1/marketplace/sub-accounts/{companyId}Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
companyIdstringobrigatórioIdentificador público (bus_…)
Corpo da requisição
namestringNome do vendedor — só enquanto o cadastro dele não foi enviado.
platformFeeobjectpode ser nuloA taxa da plataforma;
nulllimpa.+2 campos de
platformFeetypestringobrigatóriopercentage(de cada venda) ouflat(centavos por venda).Valores:percentageflatvaluenumberobrigatórioO percentual (0–100) ou o valor em centavos, conforme
type.
Respostas
200Sucesso
idstringobrigatórioIdentificador público (bus_…)
namestringobrigatórioNome do vendedor.
planIdstringobrigatóriopode ser nuloO plano de taxas atribuído;
nullquando a sub-conta usaplatformFeeou nenhum.statusstringobrigatóriopode ser nuloStatus do cadastro:
pending,analyzing,awaiting-documents,active,disabled…createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
approvedAtstringobrigatóriopode ser nuloQuando o cadastro foi aprovado;
nullquando nunca.platformFeeobjectobrigatóriopode ser nuloA taxa da plataforma sobre as vendas da sub-conta;
nullquando não há (ou quando vale um plano de taxas).+2 campos de
platformFeetypestringobrigatóriopercentageouflat.Valores:percentageflatvaluenumberobrigatórioO percentual (0–100) ou o valor em centavos, conforme
type.
kycSubmittedAtstringobrigatóriopode ser nuloQuando a sub-conta concluiu o cadastro e a análise começou;
nullenquanto ela ainda não enviou.volume30dCentsintegerobrigatóriopode ser nuloVendas aprovadas da sub-conta nos últimos 30 dias, em centavos (só produção);
nullquando não foi possível ler.
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório