New Payment Refund
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>"
}
'import requests
url = "https://api.unibee.dev/merchant/payment/refund/new"
payload = {
"currency": "<string>",
"externalRefundId": "<string>",
"paymentId": "<string>",
"refundAmount": 123,
"metadata": {},
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
externalRefundId: '<string>',
paymentId: '<string>',
refundAmount: 123,
metadata: {},
reason: '<string>'
})
};
fetch('https://api.unibee.dev/merchant/payment/refund/new', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.unibee.dev/merchant/payment/refund/new",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'currency' => '<string>',
'externalRefundId' => '<string>',
'paymentId' => '<string>',
'refundAmount' => 123,
'metadata' => [
],
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.unibee.dev/merchant/payment/refund/new"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"externalRefundId\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"refundAmount\": 123,\n \"metadata\": {},\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.unibee.dev/merchant/payment/refund/new")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"externalRefundId\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"refundAmount\": 123,\n \"metadata\": {},\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/payment/refund/new")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"<string>\",\n \"externalRefundId\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"refundAmount\": 123,\n \"metadata\": {},\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"externalRefundId": "<string>",
"paymentId": "<string>",
"refundId": "<string>",
"status": 123
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Payment
New Payment Refund
POST
/
merchant
/
payment
/
refund
/
new
New Payment Refund
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>"
}
'import requests
url = "https://api.unibee.dev/merchant/payment/refund/new"
payload = {
"currency": "<string>",
"externalRefundId": "<string>",
"paymentId": "<string>",
"refundAmount": 123,
"metadata": {},
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
externalRefundId: '<string>',
paymentId: '<string>',
refundAmount: 123,
metadata: {},
reason: '<string>'
})
};
fetch('https://api.unibee.dev/merchant/payment/refund/new', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.unibee.dev/merchant/payment/refund/new",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'currency' => '<string>',
'externalRefundId' => '<string>',
'paymentId' => '<string>',
'refundAmount' => 123,
'metadata' => [
],
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.unibee.dev/merchant/payment/refund/new"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"externalRefundId\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"refundAmount\": 123,\n \"metadata\": {},\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.unibee.dev/merchant/payment/refund/new")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"externalRefundId\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"refundAmount\": 123,\n \"metadata\": {},\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/payment/refund/new")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"<string>\",\n \"externalRefundId\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"refundAmount\": 123,\n \"metadata\": {},\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"externalRefundId": "<string>",
"paymentId": "<string>",
"refundId": "<string>",
"status": 123
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Endpoint Overview
POSThttps://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 withcode, 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. |
code in the response body is non-zero, check message for details. Use requestId when contacting support.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
⌘I

