Skip to main content
POST
/
transactions
Criar transação
curl --request POST \
  --url https://api.conta.paybeehive.com.br/v1/transactions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 500,
  "paymentMethod": "credit_card",
  "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"
    }
  },
  "items": [
    {
      "title": "Produto X",
      "unitPrice": 5000,
      "quantity": 1,
      "tangible": true,
      "externalRef": "item_ext_001"
    }
  ],
  "metadata": {
    "provider": "CustomCheckout",
    "user_email": "cliente@exemplo.com",
    "order_id": "CC-20260121-000392",
    "checkout_url": "https://seguro.minhaloja.com.br/checkout/sucesso?order_id=CC-20260121-000392",
    "shop_url": "https://minhaloja.com.br"
  },
  "card": {
    "id": 10,
    "hash": "card_hash_abc",
    "number": "4111111111111111",
    "holderName": "Bruce Wayne",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": "123",
    "brand": "visa",
    "lastDigits": "1111",
    "reusable": true,
    "createdAt": "2026-01-04T12:00:00Z"
  },
  "installments": 1,
  "pix": {
    "expiresInSeconds": 3600
  },
  "boleto": {
    "expiresInDays": 3
  },
  "shipping": {
    "address": {
      "street": "Av. Brigadeiro Faria Lima",
      "streetNumber": "1811",
      "complement": "Conj 1119",
      "neighborhood": "Itaim Bibi",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "01452001",
      "country": "BR"
    },
    "fee": 0,
    "deliveryDate": "2026-01-10"
  },
  "postbackUrl": "https://webhook.minhaloja.com/bee",
  "traceable": false,
  "ip": "189.10.20.30",
  "externalRef": "order_123",
  "splits": [
    {
      "recipientId": 321,
      "amount": 500,
      "netAmount": 475
    }
  ]
}
'
{
  "id": 12345,
  "amount": 500,
  "refundedAmount": 0,
  "companyId": 77,
  "installments": 1,
  "paymentMethod": "credit_card",
  "status": "paid",
  "postbackUrl": "https://webhook.minhaloja.com/bee",
  "metadata": {
    "provider": "CustomCheckout",
    "user_email": "cliente@exemplo.com",
    "order_id": "CC-20260121-000392",
    "checkout_url": "https://seguro.minhaloja.com.br/checkout/sucesso?order_id=CC-20260121-000392",
    "shop_url": "https://minhaloja.com.br"
  },
  "traceable": false,
  "secureId": "sec_abc123",
  "secureUrl": "https://checkout.paybeehive.com/sec_abc123",
  "createdAt": "2026-01-04T12:00:00Z",
  "updatedAt": "2026-01-04T12:00:10Z",
  "paidAt": "2026-01-04T12:00:20Z",
  "ip": "189.10.20.30",
  "externalRef": "order_123",
  "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": 123,
    "createdAt": "2026-01-04T12:00:00Z"
  },
  "address": {
    "street": "Av. Brigadeiro Faria Lima",
    "streetNumber": "1811",
    "complement": "Conj 1119",
    "neighborhood": "Itaim Bibi",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01452001",
    "country": "BR"
  },
  "card": {
    "id": 10,
    "hash": "card_hash_abc",
    "number": "4111111111111111",
    "holderName": "Bruce Wayne",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": "123",
    "brand": "visa",
    "lastDigits": "1111",
    "reusable": true,
    "createdAt": "2026-01-04T12:00:00Z"
  },
  "boleto": null,
  "pix": null,
  "shipping": {
    "address": {
      "street": "Av. Brigadeiro Faria Lima",
      "streetNumber": "1811",
      "complement": "Conj 1119",
      "neighborhood": "Itaim Bibi",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "01452001",
      "country": "BR"
    },
    "fee": 0,
    "deliveryDate": "2026-01-10"
  },
  "refusedReason": null,
  "items": [
    {
      "title": "Produto X",
      "unitPrice": 5000,
      "quantity": 1,
      "tangible": true,
      "externalRef": "item_ext_001"
    }
  ],
  "splits": [
    {
      "recipientId": 321,
      "amount": 500,
      "netAmount": 475
    }
  ],
  "refunds": [
    {
      "id": 999,
      "amount": 5000,
      "createdAt": "2026-01-04T12:10:00Z"
    }
  ],
  "fee": {
    "fixedAmount": 199,
    "spreadPercentage": 349,
    "estimatedFee": 320,
    "netAmount": 4680
  }
}

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