Create New Payment Method

POST /merchant/payment/method_new

Create New Payment Method

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/payment/method_new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gatewayId": 123,
  "userId": 123,
  "currency": "<string>",
  "metadata": {},
  "redirectUrl": "<string>",
  "subscriptionId": "<string>",
  "type": "<string>"
}
'

200

{
  "code": 123,
  "data": {
    "method": {
      "data": {},
      "id": "<string>",
      "isDefault": true,
      "type": "<string>"
    },
    "url": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/payment/method_new

Create New Payment Method

---

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	No	The currency of payment method
gatewayId	integer	Yes	The unique id of gateway
metadata	object	No	Metadata，Map
redirectUrl	string	No	The redirect url when method created return back
subscriptionId	string	No	The id of subscription that want to attach
type	string	No
userId	integer	Yes	The customer’s unique id

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/payment/method_new" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "",
  "gatewayId": 0,
  "metadata": {},
  "redirectUrl": "https://example.com",
  "subscriptionId": "id_example",
  "type": "",
  "userId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/payment/method_new" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "",
  "gatewayId": 0,
  "metadata": {},
  "redirectUrl": "https://example.com",
  "subscriptionId": "id_example",
  "type": "",
  "userId": 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.method	object
data.url	string	The gateway url to create a new method
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 unique id of gateway

userId · integer<int64> · required

The customer's unique id

currency · string<string>

The currency of payment method

metadata · object

Metadata，Map

Show child attributes

redirectUrl · string<string>

The redirect url when method created return back

subscriptionId · string<string>

The id of subscription that want to attach

type · string<string>

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>