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

# 订单详情

> Returns one order of the token's customer, including the amount breakdown, merchant, payment method, card scheme, products, shipping address and amount, `agent_info`, and a `refund_summary`.



## OpenAPI

````yaml GET /agent/platform/orders/{orderId}
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/{orderId}:
    get:
      summary: Get order
      description: >-
        Returns one order of the token's customer, including the amount
        breakdown, merchant, payment method, card scheme, products, shipping
        address and amount, `agent_info`, and a `refund_summary`.
      operationId: getOrder
      parameters:
        - name: orderId
          in: path
          required: true
          description: Order ID.
          schema:
            type: string
            example: order_...
      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/OrderDetail'
              example:
                code: 200
                msg: Success
                data:
                  order_id: order_...
                  order_time: '2026-01-01T00:00:00Z'
                  amount: 42.5
                  display_amount: $42.50
                  subtotal_amount: 40
                  display_subtotal_amount: $40.00
                  currency: USD
                  status_code: 1
                  status: SUCCESS
                  merchant_name: Example Merchant
                  merchant_url: https://merchant.example
                  payment_method_type: CARD
                  payment_method_label: Visa •••• 4242
                  payment_instrument_last_four: '4242'
                  card_scheme: VISA
                  credit_amount: 2.5
                  display_credit_amount: $2.50
                  paid_amount: 42.5
                  display_paid_amount: $42.50
                  products: []
                  agent_info: {}
                  refund_summary:
                    refund_count: 0
                    refunded_amount: 0
                    currency: USD
                    latest_status: null
                    refunds: []
        '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'
        '404':
          description: The order does not exist or belongs to another customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    OrderDetail:
      type: object
      properties:
        order_id:
          type: string
          description: Order ID.
          example: order_...
        order_time:
          type: string
          description: Order time.
          format: date-time
          example: '2026-01-01T00:00:00Z'
        amount:
          type: number
          description: Order amount in major currency units.
          example: 42.5
        display_amount:
          type: string
          description: Order amount formatted for display.
          example: $42.50
        subtotal_amount:
          type: number
          description: Subtotal amount.
          example: 40
        display_subtotal_amount:
          type: string
          description: Subtotal amount formatted for display.
          example: $40.00
        currency:
          type: string
          description: Currency code.
          example: USD
        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
        merchant_url:
          type: string
          description: Merchant URL.
          example: https://merchant.example
        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_instrument_last_four:
          type: string
          description: Last four digits of the payment card.
          example: '4242'
        card_scheme:
          type: string
          description: Card scheme, for example `VISA`.
          example: VISA
        credit_amount:
          type: number
          description: Credit amount.
          example: 2.5
        display_credit_amount:
          type: string
          description: Credit amount formatted for display.
          example: $2.50
        paid_amount:
          type: number
          description: Amount paid.
          example: 42.5
        display_paid_amount:
          type: string
          description: Amount paid formatted for display.
          example: $42.50
        products:
          type: array
          description: Products in the order.
          items:
            type: object
            description: Product.
        agent_info:
          type: object
          description: Agent that created the order.
        refund_summary:
          $ref: '#/components/schemas/RefundSummary'
    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.
    RefundSummary:
      type: object
      description: Refunds of the order.
      properties:
        refund_count:
          type: integer
          description: Number of refunds for the order.
          example: 0
        refunded_amount:
          type: number
          description: Total refunded amount.
          example: 0
        currency:
          type: string
          description: Currency code.
          example: USD
        latest_status:
          type: string
          description: Status of the latest refund; `null` when there is none.
        refunds:
          type: array
          description: Refunds of the order.
          items:
            type: object
            description: Refund record.
  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.