Payment Gateway Webhook Setup

POST /merchant/gateway/setup_webhook

Payment Gateway Webhook Setup

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/gateway/setup_webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gatewayId": 123,
  "webhookSecret": "<string>"
}
'

200

{
  "code": 123,
  "data": {
    "gatewayWebhookUrl": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/gateway/setup_webhook

Payment Gateway Webhook Setup

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body

Name	Type	Required	Description
gatewayId	integer	Yes	The id of payment gateway
webhookSecret	string	No	The secret of gateway webhook

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/gateway/setup_webhook" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "gatewayId": 0,
  "webhookSecret": ""
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/gateway/setup_webhook" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "gatewayId": 0,
  "webhookSecret": ""
}'

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.gatewayWebhookUrl	string	The webhook endpoint url of payment gateway, if gateway is stripe, the url will setting to stripe by api automatic
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

gatewayId · integer<int64> · required

The id of payment gateway

webhookSecret · string<string>

The secret of gateway webhook

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>