Skip to main content
POST
/
recipients
Criar recebedor
curl --request POST \
  --url https://api.conta.paybeehive.com.br/v1/recipients \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legalName": "netero isaac",
  "document": {
    "number": "12345678909",
    "type": "cpf"
  },
  "transferSettings": {
    "transferEnabled": true,
    "automaticAnticipationEnabled": true,
    "anticipatableVolumePercentage": 2
  },
  "bankAccount": {
    "bankCode": "341",
    "agencyNumber": "1234",
    "accountNumber": "123456",
    "accountDigit": "7",
    "type": "conta_corrente",
    "legalName": "minhalojinha",
    "documentNumber": "12345678909",
    "documentType": "cpf"
  },
  "email": "financeiro@lojaabc.com"
}
'
{
  "legalName": "netero isaac",
  "document": {
    "number": "12345678909",
    "type": "cpf"
  },
  "transferSettings": {
    "transferEnabled": true,
    "automaticAnticipationEnabled": true,
    "anticipatableVolumePercentage": 2
  },
  "bankAccount": {
    "bankCode": "341",
    "agencyNumber": "1234",
    "accountNumber": "123456",
    "accountDigit": "7",
    "type": "conta_corrente",
    "legalName": "minhalojinha",
    "documentNumber": "12345678909",
    "documentType": "cpf"
  },
  "email": "financeiro@lojaabc.com",
  "id": 916,
  "companyId": 287,
  "tenantId": 1,
  "createdAt": "2025-12-04T04:33:10.000Z",
  "balance": {}
}

Authorizations

​
Authorization
string
header
required

Basic Authorization usando SECRET_KEY como usuário e "x" como senha.

Body

application/json
​
legalName
string
required

Razão social / nome legal do recebedor (obrigatório).

Maximum string length: 50
Example:

"netero isaac"

​
document
object
required
​
transferSettings
object
required

Regras de transferência/antecipação do recebedor.

​
bankAccount
object
required

Dados bancários do recebedor.

​
email
string<email>

Email do recebedor (opcional).

Example:

"financeiro@lojaabc.com"

Response

Recebedor criado

​
legalName
string
required

Razão social / nome legal do recebedor (obrigatório).

Maximum string length: 50
Example:

"netero isaac"

​
document
object
required
​
transferSettings
object
required

Configurações retornadas pelo sistema (podem incluir campos adicionais).

​
bankAccount
object
required

Dados bancários do recebedor.

​
email
string<email>

Email do recebedor (opcional).

Example:

"financeiro@lojaabc.com"

​
id
integer
Example:

916

​
companyId
integer
Example:

287

​
tenantId
integer
Example:

1

​
createdAt
string
Example:

"2025-12-04T04:33:10.000Z"

​
balance
object

Resumo de saldo do recebedor (pode variar por ambiente).