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

> Lists the refunds of the token's customer.



## OpenAPI

````yaml GET /agent/platform/refunds
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/refunds:
    get:
      summary: List refunds
      description: Lists the refunds of the token's customer.
      operationId: listRefunds
      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
      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/RefundPage'
              example:
                code: 200
                msg: Success
                data:
                  total: 1
                  page_num: 1
                  page_size: 20
                  records:
                    - refund_order_id: refund_...
                      order_id: order_...
                      refund_amount: 10
                      refund_currency: USD
                      status: SUCCESS
                      refund_reason: Customer request
                      payment_instrument_id: pi_...
        '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:
    RefundPage:
      type: object
      properties:
        total:
          type: integer
          description: Number of records.
          example: 1
        page_num:
          type: integer
          description: Page number.
          example: 1
        page_size:
          type: integer
          description: Page size.
          example: 20
        records:
          type: array
          description: Refunds on this page.
          items:
            $ref: '#/components/schemas/Refund'
    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.
    Refund:
      type: object
      properties:
        refund_order_id:
          type: string
          description: Refund ID.
          example: refund_...
        order_id:
          type: string
          description: ID of the refunded order.
          example: order_...
        refund_amount:
          type: number
          description: Refund amount.
          example: 10
        refund_currency:
          type: string
          description: Refund currency code.
          example: USD
        status:
          type: string
          description: Refund status, for example `SUCCESS`.
          example: SUCCESS
        refund_reason:
          type: string
          description: Refund reason.
          example: Customer request
        payment_instrument_id:
          type: string
          description: Payment method ID.
          example: pi_...
  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.