> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get OneTime Payment Item List

## 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

```bash theme={null}
curl -X GET "https://api.unibee.dev/merchant/payment/item/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

### Sandbox

```bash theme={null}
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.


## OpenAPI

````yaml get /merchant/payment/item/list
openapi: 3.0.0
info:
  description: UniBee Api Server
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: OpenAPI UniBee
  version: daily,buildtime:202607240926
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/payment/item/list:
    get:
      tags:
        - Payment
      summary: Get OneTime Payment Item List
      parameters:
        - description: Filter UserId, Default All
          in: query
          name: userId
          schema:
            description: Filter UserId, Default All
            format: int64
            properties: {}
            type: integer
        - description: >-
            Sort，invoice_id|gmt_create|gmt_modify|period_end|total_amount，Default
            gmt_modify
          in: query
          name: sortField
          schema:
            description: >-
              Sort，invoice_id|gmt_create|gmt_modify|period_end|total_amount，Default
              gmt_modify
            format: string
            properties: {}
            type: string
        - description: Sort Type，asc|desc，Default desc
          in: query
          name: sortType
          schema:
            description: Sort Type，asc|desc，Default desc
            format: string
            properties: {}
            type: string
        - description: Page,Start 0
          in: query
          name: page
          schema:
            description: Page,Start 0
            format: int
            properties: {}
            type: integer
        - description: Count Of Page
          in: query
          name: count
          schema:
            description: Count Of Page
            format: int
            properties: {}
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      paymentItems:
                        description: Payment Item Object List
                        format: '[]*bean.PaymentItem'
                        items:
                          $ref: '#/components/schemas/unibee.api.bean.PaymentItem'
                        properties: {}
                        type: array
                      total:
                        description: Total
                        format: int
                        properties: {}
                        type: integer
                    type: object
                  merchantId:
                    format: int64
                    properties: {}
                    type: integer
                  message:
                    format: string
                    properties: {}
                    type: string
                  redirect:
                    format: string
                    properties: {}
                    type: string
                  requestId:
                    format: string
                    properties: {}
                    type: string
                type: object
          description: ''
components:
  schemas:
    unibee.api.bean.PaymentItem:
      properties:
        amount:
          description: amount
          format: int64
          properties: {}
          type: integer
        bizType:
          description: biz_type 1-onetime payment, 3-subscription
          format: int
          properties: {}
          type: integer
        createTime:
          description: create utc time
          format: int64
          properties: {}
          type: integer
        currency:
          description: currency
          format: string
          properties: {}
          type: string
        description:
          description: description
          format: string
          properties: {}
          type: string
        id:
          format: int64
          properties: {}
          type: integer
        invoiceId:
          description: invoice id
          format: string
          properties: {}
          type: string
        merchantId:
          description: merchant id
          format: int64
          properties: {}
          type: integer
        name:
          description: name
          format: string
          properties: {}
          type: string
        paymentId:
          description: PaymentId
          format: string
          properties: {}
          type: string
        quantity:
          description: quantity
          format: int64
          properties: {}
          type: integer
        status:
          description: 0-pending, 1-success, 2-failure
          format: int
          properties: {}
          type: integer
        subscriptionId:
          description: subscription id
          format: string
          properties: {}
          type: string
        uniqueId:
          description: unique id
          format: string
          properties: {}
          type: string
        unitAmount:
          description: unit_amount
          format: int64
          properties: {}
          type: integer
        userId:
          description: userId
          format: int64
          properties: {}
          type: integer
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.