Lista as suas sub-contas
/v1/marketplace/sub-accountsAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros de consulta
limitintegerTamanho da página (itens por página).
offsetintegerPosição do primeiro item (a partir de 0).
sortstringExpressão de ordenação, ex.: "-createdAt"
statusstringSó sub-contas com este status (
pending,analyzing,awaiting-documents,active…).qstringSub-contas cujo nome contém este texto (sem diferenciar maiúsculas).
planIdum deSó sub-contas neste plano de taxas, ou
nonepara as sem plano.
Respostas
200Sucesso
dataobject[]obrigatórioOs itens desta página.
+9 campos de
dataidstringobrigató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.
pageobjectobrigatórioCursores de paginação da lista.
+3 campos de
pagetotalintegerobrigatórioNúmero total de páginas.
offsetobjectobrigatórioO
offsetpara pedir a primeira, a anterior, a próxima e a última página.+4 campos de
offsetlastintegerobrigatórioPosição da última página.
nextintegerobrigatórioPosição da próxima página (fica nesta quando ela é a última).
previntegerobrigatórioPosição da página anterior (0 na primeira).
firstintegerobrigatórioPosição da primeira página.
currentintegerobrigatórioNúmero da página atual (a primeira é 1).
limitintegerobrigatórioTamanho da página, como pedido.
totalintegerobrigatórioNúmero total de itens que atendem aos filtros.
offsetintegerobrigatórioPosição do primeiro item desta página, como pedido.
hasMorebooleanobrigatóriotruequando há mais itens depois desta página.
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
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório