Get OneTime Payment Item List

GET /merchant/payment/item/list

Get OneTime Payment Item List

cURL

curl --request GET \
  --url https://api.unibee.dev/merchant/payment/item/list \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 123,
  "data": {
    "paymentItems": [
      {
        "amount": 123,
        "bizType": 123,
        "createTime": 123,
        "currency": "<string>",
        "description": "<string>",
        "id": 123,
        "invoiceId": "<string>",
        "merchantId": 123,
        "name": "<string>",
        "paymentId": "<string>",
        "quantity": 123,
        "status": 123,
        "subscriptionId": "<string>",
        "uniqueId": "<string>",
        "unitAmount": 123,
        "userId": 123
      }
    ],
    "total": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/payment/item/list

Get OneTime Payment Item List

---

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.

Query parameters

Name	Type	Required	Description
userId	integer	No	Filter UserId, Default All
sortField	string	No	Sort，invoice_id|gmt_create|gmt_modify|period_end|total_amount，Default gmt_modify
sortType	string	No	Sort Type，asc|desc，Default desc
page	integer	No	Page,Start 0
count	integer	No	Count Of Page

---

Request examples

cURL

curl -X GET "https://api.unibee.dev/merchant/payment/item/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/payment/item/list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

---

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.paymentItems	array	Payment Item Object List
data.total	integer	Total
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.

Query Parameters

userId · integer<int64>

Filter UserId, Default All

sortField · string<string>

Sort，invoice_id|gmt_create|gmt_modify|period_end|total_amount，Default gmt_modify

sortType · string<string>

Sort Type，asc|desc，Default desc

page · integer<int>

Page,Start 0

count · integer<int>

Count Of Page

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>