Buscar recebedor por ID
Retorna um recebedor com o estado da análise e as pendências que impedem a aprovação.
GET /recipients/:id
Faz parte do recurso Recebedores — os papéis, o ciclo de aprovação e o
catálogo de pendências estão lá.
Retorna 404 se o recebedor não estiver vinculado à sua company, mesmo que ele exista na
plataforma para outra conta.
analysisComplete—falseenquanto há rodada em andamento. Enquanto forfalse, ostatuse aspendenciesainda podem mudar.pendencies— o que está errado, item a item, comcode,severitye aactionque resolve. O significado de cadacodeestá em Por que meu recebedor foi recusado?.pendenciesSummary— a contagem{ open, blocking, warning }. Seblockingfor maior que zero, há algo impedindo a aprovação.
?includeResolved=true, a resposta inclui
também o histórico já resolvido (itens com status: "resolved") — útil para auditar o que o
recebedor já corrigiu, e ruído para quem só quer saber o que falta.Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do recebedor
Query Parameters
Por padrão, pendencies traz só as pendências abertas. Com true, inclui também o histórico resolvido (status: resolved).
Com true, a resposta traz também as pendências já resolvidas — o histórico. Omitido, só as abertas.
true, false Response
Dados do recebedor
Identificador único do registro.
Nome da conta do recebedor.
Nome do registro.
E-mail de contato.
Telefone de contato.
Documento (CPF ou CNPJ) do titular.
Tipo do recebedor: individual (pessoa física) ou company (pessoa jurídica).
Tipo ou natureza jurídica da empresa.
Razão social da empresa.
Data de fundação da empresa (ISO 8601).
Faturamento anual do recebedor, em centavos.
Tipo societário da empresa.
Data de nascimento do recebedor (ISO 8601).
Nome da mãe do recebedor.
Profissão do recebedor.
Renda mensal do recebedor, em centavos.
Dados do representante legal da empresa.
Tipo da chave PIX (ex.: email, cpf, cnpj, phone, random).
Chave PIX do recebedor.
Site do recebedor.
Endereço principal do recebedor.
Conta bancária padrão do recebedor.
Documentos enviados para verificação (KYC) do recebedor.
Papel do recebedor no split (ex.: seller).
Situação da conta bancária. Valores: active, inactive, pending.
Valor do split do recebedor (percentual ou fixo, conforme splitType).
Tipo do valor de split do recebedor (ex.: percentage, fixed).
Prazo de antecipação para PIX, em dias.
Prazo de antecipação para boleto, em dias.
Prazo de antecipação para cartão de crédito, em dias.
Data e hora em que o recebedor foi aprovado (ISO 8601).
Data e hora em que o recebedor foi recusado (ISO 8601).
Indica se a análise cadastral terminou. false enquanto houver rodada de análise aberta para este recebedor na sua conta.
Pendências apontadas pela análise. Cada item traz code (estável, para automação), field, severity (blocking ou warning), status (open ou resolved), message e action (texto traduzido) e as datas do grupo.
Contagem das pendências abertas: open (total), blocking e warning.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).