Skip to main content
POST
Criar Recebedor
Permite cadastrar destinatários (pessoas físicas ou jurídicas) que irão receber valores em splits de pagamento. Essencial para marketplaces e plataformas que precisam dividir pagamentos entre múltiplas partes.
Comportamento Especial: Se já existir um destinatário com o mesmo email para o seu merchant, a API retorna o destinatário existente com status 200 ao invés de criar um novo.

Parâmetros da Requisição

string
required
Identificador único do destinatário no seu sistema
string
required
Email válido para contato
Nome legal ou razão social
string
required
Nome fantasia ou comercial
string
required
Status do destinatárioValores: approved, pending, blocked, reproved
string
required
Tipo de pessoaValores: individual (pessoa física), company (pessoa jurídica)
string
required
Tipo de empresaValores: MEI, ME, EPP, LTDA, EIRELI, SA, AUT, OTHER
string
Nome completo (obrigatório quando type = "individual")
date
Data de nascimento no formato YYYY-MM-DD (obrigatório quando type = "individual")
date
Data de fundação no formato YYYY-MM-DD (obrigatório quando type = "company")

Documento

object
required

Telefone

object
required

Endereço

object
required

Sócios Administradores

array
required
Lista de sócios administradores (mínimo 1)

Dados Bancários (Opcional)

object
Dados bancários para recebimento (se fornecido, todos os sub-campos são obrigatórios)

Metadados

object
Dados adicionais personalizados (formato chave-valor)

Exemplos de Requisição

Resposta

string
UUID único do destinatário
string
Hash único do destinatário
string
Email do destinatário
string
Data/hora de criação (formato: DD/MM/YYYY HH:mm:ss)
string
Data/hora da última atualização

Exemplos de Resposta

201 Created - Novo destinatário
200 OK - Recebedor já existe

Códigos de Status

Próximos Passos

Após criar um destinatário:
  1. Buscar destinatário para validar criação
  2. Atualizar dados se necessário
  3. Usar em split de pagamento para dividir valores