Skip to main content
GET
Buscar recebedor por ID
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.
É aqui que se descobre por que um recebedor não foi aprovado. Além do cadastro, a resposta traz três campos sobre a análise:
  • analysisCompletefalse enquanto há rodada em andamento. Enquanto for false, o status e as pendencies ainda podem mudar.
  • pendencies — o que está errado, item a item, com code, severity e a action que resolve. O significado de cada code está em Por que meu recebedor foi recusado?.
  • pendenciesSummary — a contagem { open, blocking, warning }. Se blocking for maior que zero, há algo impedindo a aprovação.
Por padrão você vê só as pendências abertas. Com ?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.
Trate a pendência pelo code, nunca pelo texto. message e action são escritos para quem lê e mudam de redação; code e field são o contrato para automação.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do recebedor

Query Parameters

includeResolved
enum<string>

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.

Available options:
true,
false

Response

Dados do recebedor

id
string

Identificador único do registro.

accountName
string | null

Nome da conta do recebedor.

name
string

Nome do registro.

email
string

E-mail de contato.

phone
string | null

Telefone de contato.

document
string

Documento (CPF ou CNPJ) do titular.

type
string

Tipo do recebedor: individual (pessoa física) ou company (pessoa jurídica).

companyType
string | null

Tipo ou natureza jurídica da empresa.

Razão social da empresa.

companyFoundingDate
string<date-time> | null

Data de fundação da empresa (ISO 8601).

annualRevenue
integer | null

Faturamento anual do recebedor, em centavos.

corporationType
string | null

Tipo societário da empresa.

birthDate
string<date-time> | null

Data de nascimento do recebedor (ISO 8601).

motherName
string | null

Nome da mãe do recebedor.

profession
string | null

Profissão do recebedor.

monthlyIncome
integer | null

Renda mensal do recebedor, em centavos.

Dados do representante legal da empresa.

pixKeyType
string | null

Tipo da chave PIX (ex.: email, cpf, cnpj, phone, random).

pixKey
string | null

Chave PIX do recebedor.

website
string | null

Site do recebedor.

mainAddress
object | null

Endereço principal do recebedor.

defaultBankAccount
object | null

Conta bancária padrão do recebedor.

documents
object[] | null

Documentos enviados para verificação (KYC) do recebedor.

role
string

Papel do recebedor no split (ex.: seller).

status
string

Situação da conta bancária. Valores: active, inactive, pending.

splitValue
number | null

Valor do split do recebedor (percentual ou fixo, conforme splitType).

splitType
string | null

Tipo do valor de split do recebedor (ex.: percentage, fixed).

pixAntecipationDays
integer | null

Prazo de antecipação para PIX, em dias.

bankSlipAntecipationDays
integer | null

Prazo de antecipação para boleto, em dias.

creditCardAntecipationDays
integer | null

Prazo de antecipação para cartão de crédito, em dias.

approvedAt
string<date-time> | null

Data e hora em que o recebedor foi aprovado (ISO 8601).

refusedAt
string<date-time> | null

Data e hora em que o recebedor foi recusado (ISO 8601).

analysisComplete
boolean

Indica se a análise cadastral terminou. false enquanto houver rodada de análise aberta para este recebedor na sua conta.

pendencies
object[]

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.

pendenciesSummary
object

Contagem das pendências abertas: open (total), blocking e warning.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).