Criar cliente
curl --request POST \
--url https://api.conta.paybeehive.com.br/v1/customers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Bruce Wayne",
"email": "bruce@wayne.com",
"document": {
"number": "12345678909",
"type": "cpf"
},
"externalRef": "cust_ext_001",
"phone": "+5511999999999",
"birthdate": "1990-01-01",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"streetNumber": "1811",
"complement": "Conj 1119",
"neighborhood": "Itaim Bibi",
"city": "São Paulo",
"state": "SP",
"zipCode": "01452001",
"country": "BR"
}
}
'import requests
url = "https://api.conta.paybeehive.com.br/v1/customers"
payload = {
"name": "Bruce Wayne",
"email": "bruce@wayne.com",
"document": {
"number": "12345678909",
"type": "cpf"
},
"externalRef": "cust_ext_001",
"phone": "+5511999999999",
"birthdate": "1990-01-01",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"streetNumber": "1811",
"complement": "Conj 1119",
"neighborhood": "Itaim Bibi",
"city": "São Paulo",
"state": "SP",
"zipCode": "01452001",
"country": "BR"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Bruce Wayne',
email: 'bruce@wayne.com',
document: {number: '12345678909', type: 'cpf'},
externalRef: 'cust_ext_001',
phone: '+5511999999999',
birthdate: '1990-01-01',
address: {
street: 'Av. Brigadeiro Faria Lima',
streetNumber: '1811',
complement: 'Conj 1119',
neighborhood: 'Itaim Bibi',
city: 'São Paulo',
state: 'SP',
zipCode: '01452001',
country: 'BR'
}
})
};
fetch('https://api.conta.paybeehive.com.br/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conta.paybeehive.com.br/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Bruce Wayne',
'email' => 'bruce@wayne.com',
'document' => [
'number' => '12345678909',
'type' => 'cpf'
],
'externalRef' => 'cust_ext_001',
'phone' => '+5511999999999',
'birthdate' => '1990-01-01',
'address' => [
'street' => 'Av. Brigadeiro Faria Lima',
'streetNumber' => '1811',
'complement' => 'Conj 1119',
'neighborhood' => 'Itaim Bibi',
'city' => 'São Paulo',
'state' => 'SP',
'zipCode' => '01452001',
'country' => 'BR'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.conta.paybeehive.com.br/v1/customers"
payload := strings.NewReader("{\n \"name\": \"Bruce Wayne\",\n \"email\": \"bruce@wayne.com\",\n \"document\": {\n \"number\": \"12345678909\",\n \"type\": \"cpf\"\n },\n \"externalRef\": \"cust_ext_001\",\n \"phone\": \"+5511999999999\",\n \"birthdate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Av. Brigadeiro Faria Lima\",\n \"streetNumber\": \"1811\",\n \"complement\": \"Conj 1119\",\n \"neighborhood\": \"Itaim Bibi\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipCode\": \"01452001\",\n \"country\": \"BR\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.conta.paybeehive.com.br/v1/customers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Bruce Wayne\",\n \"email\": \"bruce@wayne.com\",\n \"document\": {\n \"number\": \"12345678909\",\n \"type\": \"cpf\"\n },\n \"externalRef\": \"cust_ext_001\",\n \"phone\": \"+5511999999999\",\n \"birthdate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Av. Brigadeiro Faria Lima\",\n \"streetNumber\": \"1811\",\n \"complement\": \"Conj 1119\",\n \"neighborhood\": \"Itaim Bibi\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipCode\": \"01452001\",\n \"country\": \"BR\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conta.paybeehive.com.br/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Bruce Wayne\",\n \"email\": \"bruce@wayne.com\",\n \"document\": {\n \"number\": \"12345678909\",\n \"type\": \"cpf\"\n },\n \"externalRef\": \"cust_ext_001\",\n \"phone\": \"+5511999999999\",\n \"birthdate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Av. Brigadeiro Faria Lima\",\n \"streetNumber\": \"1811\",\n \"complement\": \"Conj 1119\",\n \"neighborhood\": \"Itaim Bibi\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipCode\": \"01452001\",\n \"country\": \"BR\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "Bruce Wayne",
"email": "bruce@wayne.com",
"document": {
"number": "12345678909",
"type": "cpf"
},
"externalRef": "cust_ext_001",
"phone": "+5511999999999",
"birthdate": "1990-01-01",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"streetNumber": "1811",
"complement": "Conj 1119",
"neighborhood": "Itaim Bibi",
"city": "São Paulo",
"state": "SP",
"zipCode": "01452001",
"country": "BR"
},
"id": 123,
"createdAt": "2026-01-04T12:00:00Z"
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}Clientes
Criar cliente
Permite que você crie um novo cliente para a sua loja.
POST
/
customers
Criar cliente
curl --request POST \
--url https://api.conta.paybeehive.com.br/v1/customers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Bruce Wayne",
"email": "bruce@wayne.com",
"document": {
"number": "12345678909",
"type": "cpf"
},
"externalRef": "cust_ext_001",
"phone": "+5511999999999",
"birthdate": "1990-01-01",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"streetNumber": "1811",
"complement": "Conj 1119",
"neighborhood": "Itaim Bibi",
"city": "São Paulo",
"state": "SP",
"zipCode": "01452001",
"country": "BR"
}
}
'import requests
url = "https://api.conta.paybeehive.com.br/v1/customers"
payload = {
"name": "Bruce Wayne",
"email": "bruce@wayne.com",
"document": {
"number": "12345678909",
"type": "cpf"
},
"externalRef": "cust_ext_001",
"phone": "+5511999999999",
"birthdate": "1990-01-01",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"streetNumber": "1811",
"complement": "Conj 1119",
"neighborhood": "Itaim Bibi",
"city": "São Paulo",
"state": "SP",
"zipCode": "01452001",
"country": "BR"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Bruce Wayne',
email: 'bruce@wayne.com',
document: {number: '12345678909', type: 'cpf'},
externalRef: 'cust_ext_001',
phone: '+5511999999999',
birthdate: '1990-01-01',
address: {
street: 'Av. Brigadeiro Faria Lima',
streetNumber: '1811',
complement: 'Conj 1119',
neighborhood: 'Itaim Bibi',
city: 'São Paulo',
state: 'SP',
zipCode: '01452001',
country: 'BR'
}
})
};
fetch('https://api.conta.paybeehive.com.br/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conta.paybeehive.com.br/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Bruce Wayne',
'email' => 'bruce@wayne.com',
'document' => [
'number' => '12345678909',
'type' => 'cpf'
],
'externalRef' => 'cust_ext_001',
'phone' => '+5511999999999',
'birthdate' => '1990-01-01',
'address' => [
'street' => 'Av. Brigadeiro Faria Lima',
'streetNumber' => '1811',
'complement' => 'Conj 1119',
'neighborhood' => 'Itaim Bibi',
'city' => 'São Paulo',
'state' => 'SP',
'zipCode' => '01452001',
'country' => 'BR'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.conta.paybeehive.com.br/v1/customers"
payload := strings.NewReader("{\n \"name\": \"Bruce Wayne\",\n \"email\": \"bruce@wayne.com\",\n \"document\": {\n \"number\": \"12345678909\",\n \"type\": \"cpf\"\n },\n \"externalRef\": \"cust_ext_001\",\n \"phone\": \"+5511999999999\",\n \"birthdate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Av. Brigadeiro Faria Lima\",\n \"streetNumber\": \"1811\",\n \"complement\": \"Conj 1119\",\n \"neighborhood\": \"Itaim Bibi\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipCode\": \"01452001\",\n \"country\": \"BR\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.conta.paybeehive.com.br/v1/customers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Bruce Wayne\",\n \"email\": \"bruce@wayne.com\",\n \"document\": {\n \"number\": \"12345678909\",\n \"type\": \"cpf\"\n },\n \"externalRef\": \"cust_ext_001\",\n \"phone\": \"+5511999999999\",\n \"birthdate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Av. Brigadeiro Faria Lima\",\n \"streetNumber\": \"1811\",\n \"complement\": \"Conj 1119\",\n \"neighborhood\": \"Itaim Bibi\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipCode\": \"01452001\",\n \"country\": \"BR\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conta.paybeehive.com.br/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Bruce Wayne\",\n \"email\": \"bruce@wayne.com\",\n \"document\": {\n \"number\": \"12345678909\",\n \"type\": \"cpf\"\n },\n \"externalRef\": \"cust_ext_001\",\n \"phone\": \"+5511999999999\",\n \"birthdate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Av. Brigadeiro Faria Lima\",\n \"streetNumber\": \"1811\",\n \"complement\": \"Conj 1119\",\n \"neighborhood\": \"Itaim Bibi\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipCode\": \"01452001\",\n \"country\": \"BR\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "Bruce Wayne",
"email": "bruce@wayne.com",
"document": {
"number": "12345678909",
"type": "cpf"
},
"externalRef": "cust_ext_001",
"phone": "+5511999999999",
"birthdate": "1990-01-01",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"streetNumber": "1811",
"complement": "Conj 1119",
"neighborhood": "Itaim Bibi",
"city": "São Paulo",
"state": "SP",
"zipCode": "01452001",
"country": "BR"
},
"id": 123,
"createdAt": "2026-01-04T12:00:00Z"
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}{
"message": "Invalid request",
"code": "bad_request",
"details": {}
}Authorizations
basicAuthapiKeyAuth
Basic Authorization usando SECRET_KEY como usuário e "x" como senha.
Body
application/json
Response
Cliente criado
Example:
"Bruce Wayne"
Example:
"bruce@wayne.com"
Show child attributes
Show child attributes
Example:
"cust_ext_001"
Example:
"+5511999999999"
Example:
"1990-01-01"
Show child attributes
Show child attributes
Example:
123
Example:
"2026-01-04T12:00:00Z"