Skip to main content
GET
Get Payment TimeLine List

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.

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Query parameters


Request examples

cURL

Sandbox


Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Error handling

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

planIds
integer<int64>[]

Filter timelines whose invoice includes any of these plan IDs (OR)

planTagFilter
object

Filter by plan tags. Omit or empty tagIds = no tag filter. When planIds is also set, results use union OR.

hasDiscountCode
boolean<*bool>

Filter by whether invoice discount_code is set

discountCode
string<string>

Filter by exact invoice discount code (case-insensitive)

Response

200 - application/json
code
integer<int>
data
object
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>