Skip to main content
Retrieve a widget by its ID.
GET /api/v1/businesses/:businessId/widgets/:widgetId

Parameters

Path

NameTypeRequiredDescription
businessIdstringYesThe business ID
widgetIdstringYesThe widget ID

Request example

curl --request GET 'https://payments.bleepay.com/api/v1/businesses/biz_abc123/widgets/wdgt_abc' \
  --header 'Authorization: Bearer <business_token>'

Response

Returns the full widget configuration object. See Create Widget for the field schema.
{
  "id": "wdgt_abc",
  "name": "Checkout Widget",
  "mode": "CUSTOMER_AMOUNT",
  "minAmount": "1",
  "maxAmount": "1000",
  "allowedNetworks": ["polygon", "ethereum"],
  "allowedCurrencies": ["USDC", "EURC"],
  "enabled": true,
  "createdAt": "2026-06-09T12:00:00.000Z",
  "updatedAt": "2026-06-09T12:00:00.000Z"
}