Skip to main content
POST
Criar recebedor
POST /recipients 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á. Cria o recebedor e o vincula à sua conta. A resposta traz o cadastro e o estado do vínculo com a sua contastatus e role descrevem a relação, não a pessoa.
Criar não é o mesmo que poder receber. O recebedor nasce em new e só vira destino válido de split quando chega a active. Entre uma coisa e outra há documentos a enviar e, em muitos casos, prova de vida. Ver Ciclo de aprovação.
Quem identifica o recebedor é o documento, não o e-mail. Se o CPF ou CNPJ já existe na plataforma, a chamada vincula o cadastro existente à sua conta em vez de duplicá-lo — o mesmo recebedor pode receber de várias contas.
Repetir a chamada para quem já está vinculado devolve o vínculo como está. Não há erro nem vínculo novo: se aquele recebedor já foi aprovado na sua conta, a resposta vem com status: "active". Uma integração que assuma new no 201 erra exatamente no reenvio.
O e-mail é que gera conflito. Responde 409 quando o e-mail informado já pertence a outro documento — a mensagem não revela qual, de propósito. Também responde 409 quando o e-mail é de uma conta de usuário da plataforma. A saída é usar um e-mail do próprio recebedor, não o do lojista.
Cadastro incompleto é aceito. Sem endereço principal ou sem conta bancária, o recebedor nasce em new e fica parado: nada é enviado para análise até o cadastro fechar. É o caminho para quem coleta os dados aos poucos.

Exemplo

Resposta 201
O exemplo está abreviado — o playground ao lado mostra o corpo inteiro, com endereço, conta bancária, sócios e as configurações de antecipação. O identificador do recebedor é o id (rec_); é ele que as demais rotas recebem.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para idempotência

Body

application/json
name
string
required

Nome do recebedor.

Minimum string length: 2
email
string<email>
required

E-mail do recebedor.

document
string
required

Documento do recebedor (CPF ou CNPJ, somente dígitos).

Minimum string length: 11
type
enum<string>
required

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

Available options:
individual,
company
monthlyIncome
integer | null
required

Renda mensal do recebedor, em centavos.

Required range: 0 <= x <= 100000000000000
phone
string | null

Telefone do recebedor (formato E.164, ex.: +5511987654321).

companyType
string | null

Tipo de empresa do recebedor (pessoa jurídica).

Razão social da empresa.

companyFoundingDate
string | null

Data de fundação da empresa.

annualRevenue
integer

Faturamento anual da empresa, em centavos.

Required range: 0 <= x <= 100000000000000
corporationType
string | null

Natureza jurídica da empresa (ex.: LTDA, EIRELI, SA).

birthDate
string | null

Data de nascimento do recebedor (pessoa física).

motherName
string | null

Nome da mãe do recebedor (pessoa física).

profession
string | null

Profissão do recebedor (pessoa física).

Dados do representante legal (recebedor pessoa jurídica).

pixKeyType
string | null

Tipo da chave Pix do recebedor (ex.: cpf, cnpj, email, phone, random).

pixKey
string | null

Chave Pix do recebedor para recebimentos.

website
string | null

Site do recebedor.

address
object

Endereço do recebedor.

bankAccount
object

Dados bancários do recebedor para recebimentos e saques.

files
object

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

Response

Recebedor criado

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