Skip to main content
POST
Criar transação

Authorizations

Authorization
string
header
required

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

Body

application/json
amount
integer
required

Valor em centavos (500 = R$ 5,00)

Example:

500

paymentMethod
enum<string>
required

Forma de pagamento

Available options:
credit_card,
boleto,
pix
Example:

"credit_card"

customer
object
required

Dados do cliente.

items
object[]
required
metadata
object
required
card
object

Obrigatório quando paymentMethod = credit_card

installments
integer

Número de parcelas. Obrigatório quando paymentMethod = credit_card

Example:

1

pix
object

Obrigatório quando paymentMethod = pix

boleto
object

Obrigatório quando paymentMethod = boleto

shipping
object
postbackUrl
string
Example:

"https://webhook.minhaloja.com/bee"

traceable
boolean
default:false

Se status de entrega será gerenciado pelo painel

ip
string
Example:

"189.10.20.30"

externalRef
string
Example:

"order_123"

splits
object[]

Response

Transação criada

id
integer
Example:

12345

amount
integer
Example:

500

refundedAmount
integer
Example:

0

companyId
integer
Example:

77

installments
integer
Example:

1

paymentMethod
string
Example:

"credit_card"

status
string
Example:

"paid"

postbackUrl
string
Example:

"https://webhook.minhaloja.com/bee"

metadata
object
traceable
boolean
Example:

false

secureId
string
Example:

"sec_abc123"

secureUrl
string
Example:

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

createdAt
string
Example:

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

updatedAt
string
Example:

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

paidAt
string
Example:

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

ip
string
Example:

"189.10.20.30"

externalRef
string
Example:

"order_123"

customer
object
address
object
card
object
boleto
string | null
Example:

null

pix
string | null
Example:

null

shipping
object
refusedReason
string | null
Example:

null

items
object[]
splits
object[]
refunds
object[]
fee
object