Criar recebedor
Cadastra quem vai receber repasses na sua conta — ou reaproveita um cadastro que já existe.
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 conta — status e role descrevem a relação, não a pessoa.
new e fica parado: nada é enviado para análise até o cadastro fechar. É o caminho para quem
coleta os dados aos poucos.Exemplo
id
(rec_); é ele que as demais rotas recebem.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para idempotência
Body
Nome do recebedor.
2E-mail do recebedor.
Documento do recebedor (CPF ou CNPJ, somente dígitos).
11Tipo do recebedor: individual (pessoa física) ou company (pessoa jurídica).
individual, company Renda mensal do recebedor, em centavos.
0 <= x <= 100000000000000Telefone do recebedor (formato E.164, ex.: +5511987654321).
Tipo de empresa do recebedor (pessoa jurídica).
Razão social da empresa.
Data de fundação da empresa.
Faturamento anual da empresa, em centavos.
0 <= x <= 100000000000000Natureza jurídica da empresa (ex.: LTDA, EIRELI, SA).
Data de nascimento do recebedor (pessoa física).
Nome da mãe do recebedor (pessoa física).
Profissão do recebedor (pessoa física).
Dados do representante legal (recebedor pessoa jurídica).
Tipo da chave Pix do recebedor (ex.: cpf, cnpj, email, phone, random).
Chave Pix do recebedor para recebimentos.
Site do recebedor.
Endereço do recebedor.
Dados bancários do recebedor para recebimentos e saques.
Documentos para verificação (KYC) do recebedor.
Response
Recebedor criado
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.
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).