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

# List orders

> Lists the orders of the token's customer.



## OpenAPI

````yaml GET /agent/platform/orders
openapi: 3.1.0
info:
  title: Clink Agent Portal API
  description: >-
    Agent Portal APIs let an Agent platform read and manage one user's Clink
    account with a portal user token: payment methods, orders, refunds, purchase
    instructions, payment credentials, payment results, and settings.
  version: 1.0.0
servers:
  - url: https://uat-api.clinkbill.com
    description: Sandbox
security:
  - PortalToken: []
paths:
  /agent/platform/orders:
    get:
      summary: List orders
      description: Lists the orders of the token's customer.
      operationId: listOrders
      parameters:
        - name: pageNum
          in: query
          required: false
          description: Page number, starting at 1.
          schema:
            type: integer
            format: int32
            minimum: 1
            example: 1
        - name: pageSize
          in: query
          required: false
          description: Page size.
          schema:
            type: integer
            format: int32
            example: 20
        - name: status
          in: query
          required: false
          description: Order status filter.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: Inclusive lower time bound (ISO 8601).
          schema:
            type: string
            example: '2026-01-01'
        - name: to
          in: query
          required: false
          description: Inclusive upper time bound (ISO 8601).
          schema:
            type: string
            example: '2026-01-31'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    description: '`200` on success.'
                    example: 200
                  msg:
                    type: string
                    description: Result message.
                    example: Success
                  data:
                    $ref: '#/components/schemas/OrderPage'
              example:
                code: 200
                msg: Success
                data:
                  total: 2
                  page_num: 1
                  page_size: 20
                  truncated: false
                  records:
                    - order_id: order_...
                      paid_time: '2026-01-01T00:00:00Z'
                      amount: 42.5
                      currency: USD
                      display_amount: $42.50
                      status_code: 1
                      status: SUCCESS
                      merchant_name: Example Merchant
                      payment_method_type: CARD
                      payment_method_label: Visa •••• 4242
                      payment_method_icon: https://...
                      payment_instrument_last_four: '4242'
                      agent_info:
                        clientId: agent_...
        '400':
          description: Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, expired, or invalid portal token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Wrong token audience, missing scope, or a platform client token used
            instead of a portal token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    OrderPage:
      type: object
      properties:
        total:
          type: integer
          description: >-
            Number of records. With status or time filters, this is the number
            of records scanned; see `truncated`.
          example: 2
        page_num:
          type: integer
          description: Page number.
          example: 1
        page_size:
          type: integer
          description: Page size.
          example: 20
        truncated:
          type: boolean
          description: >-
            `true` when the status/time filtered scan reached Clink's internal
            scan bound; `total` then describes the records scanned, not
            necessarily the customer's complete matching history. Without
            filters, the endpoint reads one page and does not use the bounded
            scan.
          example: false
        records:
          type: array
          description: Orders on this page.
          items:
            $ref: '#/components/schemas/OrderSummary'
    ErrorResponse:
      type: object
      description: Business errors use the standard envelope without `data`.
      properties:
        code:
          type: integer
          description: >-
            Numeric business error code. Judge an error by the HTTP status
            together with `code`, not by a string error code.
        msg:
          type: string
          description: Human-readable description.
    OrderSummary:
      type: object
      properties:
        order_id:
          type: string
          description: Order ID.
          example: order_...
        paid_time:
          type: string
          description: Payment time.
          format: date-time
          example: '2026-01-01T00:00:00Z'
        amount:
          type: number
          description: Order amount in major currency units.
          example: 42.5
        currency:
          type: string
          description: Currency code.
          example: USD
        display_amount:
          type: string
          description: Order amount formatted for display.
          example: $42.50
        status_code:
          type: integer
          description: Numeric order status.
          example: 1
        status:
          type: string
          description: Order status, for example `SUCCESS`.
          example: SUCCESS
        merchant_name:
          type: string
          description: Merchant name.
          example: Example Merchant
        payment_method_type:
          type: string
          description: Payment method type, for example `CARD`.
          example: CARD
        payment_method_label:
          type: string
          description: Payment method label for display.
          example: Visa •••• 4242
        payment_method_icon:
          type: string
          description: Payment method icon URL.
          example: https://...
        payment_instrument_last_four:
          type: string
          description: Last four digits of the payment card.
          example: '4242'
        agent_info:
          type: object
          description: Agent that created the order, such as its `clientId`.
  securitySchemes:
    PortalToken:
      type: http
      scheme: bearer
      description: >-
        Portal user token from `POST /agent/cwallet/platform/portal/tokens`.
        Reads require `portal:read`; writes require `portal:write`.

````

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