New Payment Refund

POST /merchant/payment/refund/new

New Payment Refund

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/payment/refund/new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "externalRefundId": "<string>",
  "paymentId": "<string>",
  "refundAmount": 123,
  "metadata": {},
  "reason": "<string>"
}
'

200

{
  "code": 123,
  "data": {
    "externalRefundId": "<string>",
    "paymentId": "<string>",
    "refundId": "<string>",
    "status": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/payment/refund/new

New Payment Refund

---

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
currency	string	Yes	Currency
externalRefundId	string	Yes	ExternalRefundId
metadata	object	No	Metadata，Map
paymentId	string	Yes	PaymentId
reason	string	No	Reason
refundAmount	integer	Yes	RefundAmount, Cent

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/payment/refund/new" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "",
  "externalRefundId": "id_example",
  "metadata": {},
  "paymentId": "id_example",
  "reason": "",
  "refundAmount": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/payment/refund/new" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "",
  "externalRefundId": "id_example",
  "metadata": {},
  "paymentId": "id_example",
  "reason": "",
  "refundAmount": 0
}'

---

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.externalRefundId	string	ExternalRefundId
data.paymentId	string	PaymentId
data.refundId	string	RefundId
data.status	integer	Status,10-create|20-success|30-Failed|40-Reverse
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

currency · string<string> · required

Currency

externalRefundId · string<string> · required

ExternalRefundId

paymentId · string<string> · required

PaymentId

refundAmount · integer<int64> · required

RefundAmount, Cent

metadata · object

Metadata，Map

Show child attributes

reason · string<string>

Reason

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>