Mark External Gateway Payment As Paid

Mark payment as paid using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex).

POST /merchant/payment/external_gateway_payment/mark_paid

Mark External Gateway Payment As Paid

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/payment/external_gateway_payment/mark_paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalTransactionId": "<string>",
  "paymentId": "<string>",
  "signature": "<string>",
  "timestamp": 123,
  "gatewayId": 123,
  "metadata": {},
  "paidTime": 123
}
'

200

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

Endpoint Overview

POST https://api.unibee.dev/merchant/payment/external_gateway_payment/mark_paid

Mark payment as paid using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex).

---

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
externalTransactionId	string	Yes	External payment transaction id from gateway, used as idempotent key
gatewayId	integer	No	External gateway id (optional), if omitted will be resolved from paymentId
metadata	object	No	Additional metadata from external gateway
paidTime	integer	No	Payment success time (unix timestamp in seconds, optional)
paymentId	string	Yes	The UniBee paymentId
signature	string	Yes	HMAC-SHA256 hex signature using External Gateway API Key over ‘paymentId|externalTransactionId|timestamp’
timestamp	integer	Yes	Unix timestamp in seconds, used for signature and anti-replay

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/payment/external_gateway_payment/mark_paid" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalTransactionId": "id_example",
  "gatewayId": 0,
  "metadata": {},
  "paidTime": 0,
  "paymentId": "id_example",
  "signature": "",
  "timestamp": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/payment/external_gateway_payment/mark_paid" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalTransactionId": "id_example",
  "gatewayId": 0,
  "metadata": {},
  "paidTime": 0,
  "paymentId": "id_example",
  "signature": "",
  "timestamp": 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.invoiceId	string	The related UniBee invoiceId
data.paymentId	string	The UniBee paymentId
data.status	string	Result status, e.g. success
data.subscriptionId	string	The related UniBee subscriptionId (if any)
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

Mark payment as paid using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex).

externalTransactionId · string<string> · required

External payment transaction id from gateway, used as idempotent key

paymentId · string<string> · required

The UniBee paymentId

signature · string<string> · required

HMAC-SHA256 hex signature using External Gateway API Key over 'paymentId|externalTransactionId|timestamp'

timestamp · integer<int64> · required

Unix timestamp in seconds, used for signature and anti-replay

gatewayId · integer<int64>

External gateway id (optional), if omitted will be resolved from paymentId

metadata · object

Additional metadata from external gateway

Show child attributes

paidTime · integer<int64>

Payment success time (unix timestamp in seconds, optional)

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>