Get Payment TimeLine List

GET /merchant/payment/timeline/list

Get Payment TimeLine List

cURL

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

200

{
  "code": 123,
  "data": {
    "paymentTimeLines": [
      {
        "autoCharge": true,
        "createTime": 123,
        "currency": "<string>",
        "externalTransactionId": "<string>",
        "fullRefund": 123,
        "gatewayId": 123,
        "id": 123,
        "invoiceId": "<string>",
        "merchantId": 123,
        "payment": {
          "action": {},
          "authorizeComment": "<string>",
          "authorizeReason": "<string>",
          "authorizeStatus": 123,
          "autoCharge": true,
          "automatic": 123,
          "balanceAmount": 123,
          "billingReason": "<string>",
          "cancelTime": 123,
          "countryCode": "<string>",
          "createTime": 123,
          "cryptoAmount": 123,
          "cryptoCurrency": "<string>",
          "currency": "<string>",
          "externalPaymentId": "<string>",
          "failureReason": "<string>",
          "gasPayer": "<string>",
          "gatewayCurrencyExchange": {
            "exchange_amount": 123,
            "exchange_rate": 123,
            "from_currency": "<string>",
            "to_currency": "<string>"
          },
          "gatewayId": 123,
          "gatewayPaymentId": "<string>",
          "gatewayPaymentType": "<string>",
          "invoiceId": "<string>",
          "lastError": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "metadata": {},
          "paidTime": 123,
          "paymentAmount": 123,
          "paymentId": "<string>",
          "refundAmount": 123,
          "returnUrl": "<string>",
          "splitSequence": 123,
          "status": 123,
          "subscriptionId": "<string>",
          "totalAmount": 123,
          "userId": 123
        },
        "paymentId": "<string>",
        "refund": {
          "countryCode": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "externalRefundId": "<string>",
          "gatewayCurrencyExchange": {
            "exchange_amount": 123,
            "exchange_rate": 123,
            "from_currency": "<string>",
            "to_currency": "<string>"
          },
          "gatewayId": 123,
          "gatewayRefundId": "<string>",
          "invoiceId": "<string>",
          "merchantId": 123,
          "metadata": {},
          "paymentId": "<string>",
          "refundAmount": 123,
          "refundComment": "<string>",
          "refundCommentExplain": "<string>",
          "refundId": "<string>",
          "refundTime": 123,
          "returnUrl": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "type": 123,
          "userId": 123
        },
        "refundId": "<string>",
        "status": 123,
        "subscriptionId": "<string>",
        "timelineType": 123,
        "totalAmount": 123,
        "transactionId": "<string>",
        "userId": 123
      }
    ],
    "total": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

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

Get Payment TimeLine 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
amountStart	integer	No	The filter start amount of timeline
amountEnd	integer	No	The filter end amount of timeline
searchKey	string	No	Search SubscriptionId|InvoiceId|PaymentId|UserId
status	array	No	The filter status, 0-pending, 1-success, 2-failure，3-cancel
timelineTypes	array	No	The filter timelineType, 0-pay, 1-refund
gatewayIds	array	No	The filter ids of gateway
currency	string	No	Currency
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
createTimeStart	integer	No	CreateTimeStart，UTC timestamp，seconds
createTimeEnd	integer	No	CreateTimeEnd，UTC timestamp，seconds

---

Request examples

cURL

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

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/payment/timeline/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.paymentTimeLines	array	Payment TimeLine 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

amountStart · integer<*int64>

The filter start amount of timeline

amountEnd · integer<*int64>

The filter end amount of timeline

searchKey · string<string>

Search SubscriptionId|InvoiceId|PaymentId|UserId

status · integer<int>[]

The filter status, 0-pending, 1-success, 2-failure，3-cancel

timelineTypes · integer<int>[]

The filter timelineType, 0-pay, 1-refund

gatewayIds · integer<int64>[]

The filter ids of gateway

currency · string<string>

Currency

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

createTimeStart · integer<int64>

CreateTimeStart，UTC timestamp，seconds

createTimeEnd · integer<int64>

CreateTimeEnd，UTC timestamp，seconds

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>