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

# Claim Fees



## OpenAPI

````yaml https://api.coinvoyage.io/v3/openapi.json post /fees/claim
openapi: 3.1.0
info:
  title: CoinVoyage API (v3)
  description: >-
    CoinVoyage v3 payment API. Unified Intent envelope, snake_case money via the
    Amount shape, and a single SHA-256 signature scheme.
  version: 3.0.0
servers:
  - url: https://api.coinvoyage.io/v3
security: []
paths:
  /fees/claim:
    post:
      tags:
        - fees
      summary: Claim Fees
      operationId: v3ClaimFees
      parameters:
        - description: >-
            HMAC-SHA256 signature header:
            'APIKey=<api_key>,signature=<hex>,timestamp=<unix_timestamp>'. The
            signature is computed over METHOD + path (with the /v3 prefix
            stripped) + timestamp.
          in: header
          name: Authorization-Signature
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimFeesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimFeesView'
          description: Fees claimed (or a no-claimable-fees message)
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid recipient address
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid request body
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
      security:
        - Authorization: []
components:
  schemas:
    ClaimFeesRequest:
      example:
        currency:
          address: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
          chain_id: 30000000000001
        metadata:
          items:
            - currency: USD
              description: High-quality widget with extra features
              image: https://example.com/images/widget.png
              name: Premium Widget
              quantity: 2
              unit_price: 49.99
          refund:
            additional_info: Item was never shipped
            currency: USD
            name: Order Cancellation
            reason: Customer requested refund
            refund_amount: 99.98
        recipient: 0x1234...abcd
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyBase'
        recipient:
          example: 0x1234...abcd
          type: string
        metadata:
          anyOf:
            - $ref: '#/components/schemas/OrderMetadata'
            - type: 'null'
      required:
        - currency
        - recipient
      type: object
    ClaimFeesView:
      example:
        claim_order_id: cuidjkhg3e289y74u5t6v
        currency:
          raw: '100000000'
          ui: '100.0'
          value_usd: 100
        source_chain_id: 1
        source_transaction_hash: 0x1234...abcd
      properties:
        claim_order_id:
          example: cuidjkhg3e289y74u5t6v
          type: string
        source_transaction_hash:
          example: 0x1234...abcd
          type: string
        source_chain_id:
          $ref: '#/components/schemas/ChainID'
          example: 1
        currency:
          $ref: '#/components/schemas/Amount'
      required:
        - claim_order_id
        - source_transaction_hash
        - source_chain_id
        - currency
      type: object
    ErrorResponse:
      example:
        code: 400
        error: Bad Request
        message: Invalid request parameters
      properties:
        error:
          example: Bad Request
          type: string
        message:
          example: Invalid request parameters
          type: string
        code:
          example: 400
          format: int64
          type: integer
        details:
          anyOf:
            - type: string
            - type: number
            - type: object
      required:
        - error
        - message
        - code
      type: object
    CurrencyBase:
      example:
        address: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
        chain_id: 30000000000001
      properties:
        address:
          example: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
          type:
            - string
            - 'null'
        chain_id:
          $ref: '#/components/schemas/ChainID'
          example: 30000000000001
      required:
        - chain_id
      type: object
    OrderMetadata:
      example:
        items:
          - currency: USD
            description: High-quality widget with extra features
            image: https://example.com/images/widget.png
            name: Premium Widget
            quantity: 2
            unit_price: 49.99
        refund:
          additional_info: Item was never shipped
          currency: USD
          name: Order Cancellation
          reason: Customer requested refund
          refund_amount: 99.98
      properties:
        items:
          items:
            $ref: '#/components/schemas/MetadataItems'
          type: array
        refund:
          anyOf:
            - $ref: '#/components/schemas/MetadataRefund'
            - type: 'null'
      type: object
    ChainID:
      enum:
        - 1
        - 10
        - 56
        - 137
        - 4663
        - 8453
        - 42161
        - 20000000000001
        - 30000000000001
        - 30000000000002
      example: 1
      format: int64
      type: integer
    Amount:
      example:
        raw: '100000000'
        ui: '100.0'
        value_usd: 100
      properties:
        ui:
          example: '100.0'
          type: string
        raw:
          $ref: '#/components/schemas/BigInt'
          example: '100000000'
        value_usd:
          example: 100
          type:
            - number
            - 'null'
      required:
        - ui
        - raw
      type: object
    MetadataItems:
      example:
        currency: USD
        description: High-quality widget with extra features
        image: https://example.com/images/widget.png
        name: Premium Widget
        quantity: 2
        unit_price: 49.99
      properties:
        name:
          example: Premium Widget
          type:
            - string
            - 'null'
        description:
          example: High-quality widget with extra features
          type:
            - string
            - 'null'
        image:
          example: https://example.com/images/widget.png
          type:
            - string
            - 'null'
        quantity:
          example: 2
          type:
            - integer
            - 'null'
        unit_price:
          example: 49.99
          type:
            - number
            - 'null'
        currency:
          example: USD
          type:
            - string
            - 'null'
      type: object
    MetadataRefund:
      example:
        additional_info: Item was never shipped
        currency: USD
        name: Order Cancellation
        reason: Customer requested refund
        refund_amount: 99.98
      properties:
        name:
          example: Order Cancellation
          type:
            - string
            - 'null'
        reason:
          example: Customer requested refund
          type:
            - string
            - 'null'
        additional_info:
          example: Item was never shipped
          type:
            - string
            - 'null'
        refund_amount:
          example: 99.98
          type:
            - number
            - 'null'
        currency:
          example: USD
          type:
            - string
            - 'null'
      type: object
    BigInt:
      description: A big integer represented as a string to preserve precision
      example: '1000000000000000000'
      type: string
  securitySchemes:
    Authorization:
      description: >-
        HMAC-SHA256 signature. See the Authorization-Signature header parameter
        on signed operations.
      in: header
      name: Authorization
      type: apiKey

````