Skip to main content
GET
Buscar o recebedor da conta
GET /recipients/owner Faz parte do recurso Recebedores — os estados do vínculo, o ciclo de aprovação e o catálogo de pendências estão lá. Devolve o recebedor de role: "owner" — o cadastro que representa você no dinheiro. É para onde vai a parte que não foi dividida com ninguém.
Você também é um recebedor. Numa transação sem split, o valor inteiro vai para este cadastro; numa com split, vai o que sobra depois dos outros. Por isso ele passa pela mesma análise dos demais — e é dele que depende a sua conta poder receber.
Se este recebedor não está active, a sua conta não vende. É a checagem que explica um checkout que responde “temporariamente indisponível” sem que nada tenha sido arquivado: o sellable do link cai quando o dono da conta perde a aptidão. Comece a investigar por aqui.
Sem parâmetro de caminho. A rota resolve o recebedor pela chave de API — não há id a informar. Responde 404 quando a conta ainda não tem recebedor próprio, o que acontece antes de o onboarding terminar.
?includeResolved=true traz o histórico. Por padrão só vêm as pendências abertas; com o parâmetro, vêm também as já resolvidas — útil para auditar o que a análise pediu ao longo do tempo.

Exemplo

Resposta 200
O exemplo está abreviado — o playground ao lado mostra o corpo inteiro.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

includeResolved
enum<string>

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 da conta

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.

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).