Alterar status de entrega

curl --request PUT \
  --url https://api.conta.paybeehive.com.br/v1/transactions/{transactionId}/delivery \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "in_transit",
  "trackingCode": "BR123456789"
}
'

{
  "id": 12345,
  "amount": 500,
  "refundedAmount": 0,
  "companyId": 77,
  "installments": 1,
  "paymentMethod": "credit_card",
  "status": "paid",
  "deliveryStatus": "in_transit",
  "trackingCode": "BR123456789",
  "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
  }
}

{
  "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": {}
}

{
  "message": "Invalid request",
  "code": "bad_request",
  "details": {}
}

PUT

transactions

{transactionId}

delivery

curl --request PUT \
  --url https://api.conta.paybeehive.com.br/v1/transactions/{transactionId}/delivery \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "in_transit",
  "trackingCode": "BR123456789"
}
'

{
  "id": 12345,
  "amount": 500,
  "refundedAmount": 0,
  "companyId": 77,
  "installments": 1,
  "paymentMethod": "credit_card",
  "status": "paid",
  "deliveryStatus": "in_transit",
  "trackingCode": "BR123456789",
  "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
  }
}

{
  "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": {}
}

{
  "message": "Invalid request",
  "code": "bad_request",
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

transactionId

integer<int32>

required

Body

application/json

status

enum<string>

required

Status atual da entrega.

Available options:

waiting,

in_transit,

delivered

Example:

"in_transit"

trackingCode

string

Código de rastreio informado pela transportadora.

Example:

"BR123456789"

Response

Status de entrega atualizado

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"

deliveryStatus

enum<string>

Status logístico da entrega.

Available options:

waiting,

in_transit,

delivered

Example:

"in_transit"

trackingCode

string | null

Example:

"BR123456789"

postbackUrl

string

Example:

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

metadata

object

Show child attributes

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"

string

Example:

"189.10.20.30"

externalRef

string

Example:

"order_123"

customer

object

Show child attributes

address

object

Show child attributes

card

object

Show child attributes

boleto

string | null

Example:

null

pix

string | null

Example:

null

shipping

object

Show child attributes

refusedReason

string | null

Example:

null

items

object[]

Show child attributes

splits

object[]

Show child attributes

refunds

object[]

Show child attributes

fee

object

Show child attributes

Visão Geral

Transações

Reembolsos

Clientes

Transferências

Saldo

Recebedores

Contas Bancárias

Empresa

Links de Pagamento

Webhooks

Alterar status de entrega

Authorizations

Path Parameters

Body

Response