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 '
{
  "name": "Loja ABC",
  "email": "[email protected]",
  "document": {
    "number": "12345678909",
    "type": "cpf"
  },
  "bankAccount": {
    "bankCode": "341",
    "agency": "1234",
    "accountNumber": "123456",
    "accountType": "checking",
    "holderName": "Bruce Wayne",
    "holderDocument": "12345678909",
    "accountDigit": "7"
  }
}
'
{
  "name": "Loja ABC",
  "email": "[email protected]",
  "document": {
    "number": "12345678909",
    "type": "cpf"
  },
  "bankAccount": {
    "bankCode": "341",
    "agency": "1234",
    "accountNumber": "123456",
    "accountType": "checking",
    "holderName": "Bruce Wayne",
    "holderDocument": "12345678909",
    "accountDigit": "7"
  },
  "id": 321,
  "createdAt": "2026-01-04T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Chave de idempotência para evitar duplicidade em retries.

Body

application/json
​
name
string
required
Example:

"Loja ABC"

​
email
string
​
document
object
​
bankAccount
object

Response

Recebedor criado

​
name
string
required
Example:

"Loja ABC"

​
email
string
​
document
object
​
bankAccount
object
​
id
integer
Example:

321

​
createdAt
string
Example:

"2026-01-04T12:00:00Z"