Skip to main content
POST
/
checkouts
Criar checkout
curl --request POST \
  --url https://api.conta.paybeehive.com.br/v1/checkouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10000,
  "description": "Link de pagamento",
  "expiresAt": "2026-01-10T00:00:00Z",
  "externalRef": "chk_1001",
  "customer": {
    "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"
    }
  }
}
'
{
  "amount": 10000,
  "description": "Link de pagamento",
  "expiresAt": "2026-01-10T00:00:00Z",
  "externalRef": "chk_1001",
  "customer": {
    "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": 9001,
  "url": "https://checkout.paybeehive.com/9001",
  "status": "active",
  "createdAt": "2026-01-04T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
integer
required
Example:

10000

​
description
string
required
Example:

"Link de pagamento"

​
expiresAt
string
Example:

"2026-01-10T00:00:00Z"

​
externalRef
string
Example:

"chk_1001"

​
customer
object

Response

Checkout criado

​
amount
integer
required
Example:

10000

​
description
string
required
Example:

"Link de pagamento"

​
expiresAt
string
Example:

"2026-01-10T00:00:00Z"

​
externalRef
string
Example:

"chk_1001"

​
customer
object
​
id
integer
Example:

9001

​
url
string
Example:

"https://checkout.paybeehive.com/9001"

​
status
string
Example:

"active"

​
createdAt
string
Example:

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