Criar Recebedor

curl --request POST \
  --url https://zeus-sandbox.autorizou.dev/api/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_reference": "<string>",
  "email": "<string>",
  "legal_name": "<string>",
  "trade_name": "<string>",
  "status": "<string>",
  "type": "<string>",
  "company_type": "<string>",
  "name": "<string>",
  "birthday": "<string>",
  "founding_date": "<string>",
  "document": {
    "document.type": "<string>",
    "document.value": "<string>"
  },
  "phone": {
    "phone.type": "<string>",
    "phone.ddi": "<string>",
    "phone.ddd": "<string>",
    "phone.number": "<string>"
  },
  "address": {
    "address.type": "<string>",
    "address.line_1": "<string>",
    "address.number": "<string>",
    "address.line_2": "<string>",
    "address.neighborhood": "<string>",
    "address.city": "<string>",
    "address.state": "<string>",
    "address.postal_code": "<string>",
    "address.country": "<string>"
  },
  "managing_partners": [
    {
      "managing_partners[].name": "<string>",
      "managing_partners[].email": "<string>",
      "managing_partners[].document": "<string>",
      "managing_partners[].birthday": "<string>",
      "managing_partners[].nationality": "<string>",
      "managing_partners[].type": "<string>",
      "managing_partners[].role_description": "<string>",
      "managing_partners[].phone": {
        "managing_partners[].phone.type": "<string>",
        "managing_partners[].phone.ddd": "<string>",
        "managing_partners[].phone.number": "<string>"
      }
    }
  ],
  "bank_account": {
    "bank_account.bank_ispb": "<string>",
    "bank_account.holder_name": "<string>",
    "bank_account.branch_number": "<string>",
    "bank_account.branch_check_digit": "<string>",
    "bank_account.account_number": "<string>",
    "bank_account.account_check_digit": "<string>",
    "bank_account.pix_key": "<string>",
    "bank_account.pix_key_type": "<string>",
    "bank_account.status": "<string>",
    "bank_account.receiver_type": "<string>"
  },
  "metadata": {}
}
'

{
  "message": "Os dados fornecidos são inválidos",
  "errors": {
    "document.value": ["CPF inválido"],
    "email": ["O campo email é obrigatório"],
    "managing_partners": ["É necessário pelo menos um sócio administrador"]
  }
}

POST

api

recipients

Criar Recebedor

curl --request POST \
  --url https://zeus-sandbox.autorizou.dev/api/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_reference": "<string>",
  "email": "<string>",
  "legal_name": "<string>",
  "trade_name": "<string>",
  "status": "<string>",
  "type": "<string>",
  "company_type": "<string>",
  "name": "<string>",
  "birthday": "<string>",
  "founding_date": "<string>",
  "document": {
    "document.type": "<string>",
    "document.value": "<string>"
  },
  "phone": {
    "phone.type": "<string>",
    "phone.ddi": "<string>",
    "phone.ddd": "<string>",
    "phone.number": "<string>"
  },
  "address": {
    "address.type": "<string>",
    "address.line_1": "<string>",
    "address.number": "<string>",
    "address.line_2": "<string>",
    "address.neighborhood": "<string>",
    "address.city": "<string>",
    "address.state": "<string>",
    "address.postal_code": "<string>",
    "address.country": "<string>"
  },
  "managing_partners": [
    {
      "managing_partners[].name": "<string>",
      "managing_partners[].email": "<string>",
      "managing_partners[].document": "<string>",
      "managing_partners[].birthday": "<string>",
      "managing_partners[].nationality": "<string>",
      "managing_partners[].type": "<string>",
      "managing_partners[].role_description": "<string>",
      "managing_partners[].phone": {
        "managing_partners[].phone.type": "<string>",
        "managing_partners[].phone.ddd": "<string>",
        "managing_partners[].phone.number": "<string>"
      }
    }
  ],
  "bank_account": {
    "bank_account.bank_ispb": "<string>",
    "bank_account.holder_name": "<string>",
    "bank_account.branch_number": "<string>",
    "bank_account.branch_check_digit": "<string>",
    "bank_account.account_number": "<string>",
    "bank_account.account_check_digit": "<string>",
    "bank_account.pix_key": "<string>",
    "bank_account.pix_key_type": "<string>",
    "bank_account.status": "<string>",
    "bank_account.receiver_type": "<string>"
  },
  "metadata": {}
}
'

{
  "message": "Os dados fornecidos são inválidos",
  "errors": {
    "document.value": ["CPF inválido"],
    "email": ["O campo email é obrigatório"],
    "managing_partners": ["É necessário pelo menos um sócio administrador"]
  }
}

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

external_reference

string

required

Identificador único do destinatário no seu sistema

string

required

Email válido para contato

legal_name

string

required

Nome legal ou razão social

trade_name

string

required

Nome fantasia ou comercial

status

string

required

Status do destinatárioValores: approved, pending, blocked, reproved

type

string

required

Tipo de pessoaValores: individual (pessoa física), company (pessoa jurídica)

company_type

string

required

Tipo de empresaValores: MEI, ME, EPP, LTDA, EIRELI, SA, AUT, OTHER

name

string

Nome completo (obrigatório quando type = "individual")

birthday

date

Data de nascimento no formato YYYY-MM-DD (obrigatório quando type = "individual")

founding_date

date

Data de fundação no formato YYYY-MM-DD (obrigatório quando type = "company")

Documento

document

object

required

Show Dados do documento

document.type

string

required

Tipo do documentoValores: cpf, cnpj

document.value

string

required

Número do documento (apenas dígitos, sem formatação)

Telefone

phone

object

required

Show Dados do telefone

phone.type

string

required

Tipo do telefoneValores: residential, mobile, commercial, public

phone.ddi

string

required

Código DDI do país (ex: "55" para Brasil)

phone.ddd

string

required

Código de área DDD (ex: "11")

phone.number

string

required

Número do telefone (apenas dígitos)

Endereço

address

object

required

Show Dados do endereço

address.type

string

required

Tipo de endereçoValores: billing (cobrança), shipping (entrega)

address.line_1

string

required

Logradouro (rua/avenida)

address.number

string

required

Número do endereço

address.line_2

string

Complemento (opcional)

address.neighborhood

string

required

Bairro

address.city

string

required

Cidade

address.state

string

required

Estado (sigla de 2 caracteres, ex: "SP")

address.postal_code

string

required

CEP (apenas números, 8 dígitos)

address.country

string

required

País (código ISO alpha-2, ex: "BR")

Sócios Administradores

managing_partners

array

required

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

Show Dados de cada sócio

managing_partners[].name

string

required

Nome completo do sócio

managing_partners[].email

string

required

Email do sócio

managing_partners[].document

string

required

CPF do sócio (11 dígitos)

managing_partners[].birthday

date

required

Data de nascimento (YYYY-MM-DD)

managing_partners[].nationality

string

required

Nacionalidade

managing_partners[].type

string

required

Tipo de sócio (2 caracteres, ex: "AD")

managing_partners[].role_description

string

required

Descrição do cargo/função

managing_partners[].phone

object

required

Show Telefone do sócio

managing_partners[].phone.type

string

required

Tipo do telefone

managing_partners[].phone.ddd

string

required

DDD (2 dígitos)

managing_partners[].phone.number

string

required

Número do telefone (até 9 dígitos)

Dados Bancários (Opcional)

bank_account

object

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

Show Dados da conta bancária

bank_account.bank_ispb

string

required

Código ISPB do banco (8 dígitos)

bank_account.holder_name

string

required

Nome do titular da conta

bank_account.branch_number

string

required

Número da agência (sem dígito)

bank_account.branch_check_digit

string

Dígito verificador da agência (quando aplicável)

bank_account.account_number

string

required

Número da conta (sem dígito)

bank_account.account_check_digit

string

required

Dígito verificador da conta

bank_account.pix_key

string

Chave PIX (opcional)

bank_account.pix_key_type

string

Tipo da chave PIX (obrigatório se pix_key fornecido)Valores: cpf, cnpj, phone, email, random

bank_account.status

string

required

Status da conta bancáriaValores: approved, pending, reproved

bank_account.receiver_type

string

required

Tipo de contaValores: checking (corrente), saving (poupança)

Metadados

metadata

object

Dados adicionais personalizados (formato chave-valor)

Exemplos de Requisição

curl -X POST https://zeus-sandbox.autorizou.dev/api/v1/recipients \
  -H "Authorization: Bearer 4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "external_reference": "seller_001",
    "email": "maria.vendedora@exemplo.com.br",
    "legal_name": "Maria da Silva Vendedora",
    "trade_name": "Maria Vendedora",
    "status": "approved",
    "type": "individual",
    "company_type": "MEI",
    "name": "Maria da Silva Vendedora",
    "birthday": "1990-05-15",
    "document": {
      "type": "cpf",
      "value": "12345678901"
    },
    "phone": {
      "type": "mobile",
      "ddi": "55",
      "ddd": "11",
      "number": "987654321"
    },
    "address": {
      "type": "billing",
      "line_1": "Rua das Flores",
      "number": "123",
      "line_2": "Apto 45",
      "neighborhood": "Vila Madalena",
      "city": "São Paulo",
      "state": "SP",
      "postal_code": "01234567",
      "country": "BR"
    },
    "managing_partners": [
      {
        "name": "Maria da Silva Vendedora",
        "email": "maria@exemplo.com.br",
        "document": "12345678901",
        "birthday": "1990-05-15",
        "nationality": "brasileira",
        "type": "AD",
        "role_description": "Proprietária",
        "phone": {
          "type": "mobile",
          "ddd": "11",
          "number": "987654321"
        }
      }
    ],
    "bank_account": {
      "bank_ispb": "00000000",
      "holder_name": "Maria da Silva Vendedora",
      "branch_number": "1234",
      "account_number": "567890",
      "account_check_digit": "1",
      "status": "approved",
      "receiver_type": "checking"
    }
  }'

Resposta

string

UUID único do destinatário

hash

string

Hash único do destinatário

string

Email do destinatário

created_at

string

Data/hora de criação (formato: DD/MM/YYYY HH:mm:ss)

updated_at

string

Data/hora da última atualização

Exemplos de Resposta

201 Created - Novo destinatário

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "hash": "RCP_abc123xyz789",
  "email": "maria.vendedora@exemplo.com.br",
  "created_at": "15/01/2024 10:30:00",
  "updated_at": "15/01/2024 10:30:00"
}

200 OK - Recebedor já existe

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "hash": "RCP_abc123xyz789",
  "email": "maria.vendedora@exemplo.com.br",
  "created_at": "10/01/2024 14:20:00",
  "updated_at": "10/01/2024 14:20:00"
}

Códigos de Status

{
  "message": "Os dados fornecidos são inválidos",
  "errors": {
    "document.value": ["CPF inválido"],
    "email": ["O campo email é obrigatório"],
    "managing_partners": ["É necessário pelo menos um sócio administrador"]
  }
}

Próximos Passos

Após criar um destinatário:

Buscar destinatário para validar criação
Atualizar dados se necessário
Usar em split de pagamento para dividir valores

Criar Estorno Atualizar Recebedor

​Parâmetros da Requisição

​Documento

​Telefone

​Endereço

​Sócios Administradores

​Dados Bancários (Opcional)

​Metadados

​Exemplos de Requisição

​Resposta

​Exemplos de Resposta

​Códigos de Status

​Próximos Passos

Parâmetros da Requisição

Documento

Telefone

Endereço

Sócios Administradores

Dados Bancários (Opcional)

Metadados

Exemplos de Requisição

Resposta

Exemplos de Resposta

Códigos de Status

Próximos Passos