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

# Get risk rules

> Returns the user's global default risk rules.



## OpenAPI

````yaml GET /agent/platform/risk-rules
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/risk-rules:
    get:
      summary: Get risk rules
      description: Returns the user's global default risk rules.
      operationId: getRiskRules
      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/RiskRules'
              example:
                code: 200
                msg: Success
                data:
                  singleRechargeLimit: 500
                  dailyTotalLimit: 2000
                  dailyMaxCount: 5
                  rechargeInterval: 30m
                  manualApprovalThreshold: 1000
                  manualApprovalEnabled: true
                  autoSuspendEnabled: true
        '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:
    RiskRules:
      type: object
      properties:
        singleRechargeLimit:
          type: number
          description: Single top-up limit in USD.
          example: 500
        dailyTotalLimit:
          type: number
          description: Daily top-up limit in USD.
          example: 2000
        dailyMaxCount:
          type: integer
          description: Maximum top-ups per day.
          example: 5
        rechargeInterval:
          type: string
          description: Cooldown such as `5m`, `10m`, `30m`, or `1h`.
          example: 30m
        manualApprovalThreshold:
          type: number
          description: Manual-approval threshold in USD.
          example: 1000
        manualApprovalEnabled:
          type: boolean
          description: Whether large top-ups need manual approval.
          example: true
        autoSuspendEnabled:
          type: boolean
          description: >-
            Always `true` in the current version; auto-suspend is a fixed safety
            behaviour.
          example: true
        updatedAt:
          type: string
          description: Last update time.
    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.
  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.