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

# List offers

> List Canton transfer offers directed at a HIFI-provisioned Canton wallet.
Supports pagination by limit and filtering by creation time.




## OpenAPI

````yaml https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/wallets/{walletId}/offers
openapi: 3.0.0
info:
  title: Hifi API
  version: 3.0.0
  description: API documentation for HIFI
servers:
  - url: https://production.hifi.com
    description: Production server
  - url: https://sandbox.hifi.com
    description: Sandbox server
security:
  - bearerAuth: []
tags:
  - name: Common
    description: Common endpoints
  - name: User
    description: User endpoints
  - name: Counter Party
    description: Counter party endpoints
  - name: Crypto Transfer
    description: Crypto transfer and batch transfer endpoints
  - name: Wallet
    description: Wallet and wallet offer endpoints
  - name: External Account
    description: External bank account endpoints (under a counter party)
  - name: External Wallet
    description: External wallet endpoints (under a counter party)
  - name: External Card
    description: External card endpoints (under a counter party)
  - name: Token Swap
    description: Token swap endpoints
  - name: Bridge
    description: Bridge endpoints
  - name: Virtual Account
    description: Virtual account endpoints
  - name: Compliance
    description: Compliance and compliance link endpoints
  - name: Webhook Endpoint
    description: Webhook endpoint endpoints
  - name: File
    description: File upload endpoints
  - name: Onramp
    description: Onramp (fiat to crypto) endpoints
  - name: Offramp
    description: Offramp (crypto to fiat) endpoints
  - name: Orchestration Address
    description: Orchestration (liquidation) address endpoints
  - name: KYC Link
    description: Hosted and custom KYC/KYB link endpoints
  - name: Transfer Approval
    description: Transfer approval endpoints
  - name: Corridor
    description: Supported fiat/crypto transfer corridor endpoints
  - name: Migration
    description: v2-to-v3 ID mapping endpoints
paths:
  /v3/users/{userId}/wallets/{walletId}/offers:
    get:
      tags:
        - Wallet
      summary: List offers
      description: >
        List Canton transfer offers directed at a HIFI-provisioned Canton
        wallet.

        Supports pagination by limit and filtering by creation time.
      operationId: v3ListWalletOffers
      parameters:
        - $ref: '#/components/parameters/UserIdPathParameter'
        - $ref: '#/components/parameters/WalletIdPathParameter'
        - $ref: '#/components/parameters/LimitParameter'
        - $ref: '#/components/parameters/WalletOfferCreatedAfterQueryParameter'
        - $ref: '#/components/parameters/WalletOfferCreatedBeforeQueryParameter'
      responses:
        '200':
          $ref: '#/components/responses/ListWalletOffersResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  parameters:
    UserIdPathParameter:
      name: userId
      in: path
      schema:
        type: string
        pattern: ^user_[A-Za-z0-9]+$
      description: ID of the user.
      required: true
    WalletIdPathParameter:
      name: walletId
      in: path
      required: true
      schema:
        type: string
      description: Public ID of the wallet (prefixed with `wlt_`)
      example: wlt_1aLcs3Kf9dQ2mNpXwZ7bV
    LimitParameter:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
      description: default to 10, maximum to 100
      required: false
    WalletOfferCreatedAfterQueryParameter:
      name: createdAfter
      in: query
      required: false
      schema:
        type: string
        format: date-time
      description: Only return offers created at or after this ISO 8601 datetime.
    WalletOfferCreatedBeforeQueryParameter:
      name: createdBefore
      in: query
      required: false
      schema:
        type: string
        format: date-time
      description: Only return offers created before this ISO 8601 datetime.
  responses:
    ListWalletOffersResponse:
      description: A cursor-paginated list of Canton offers.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WalletOfferListObject'
          example:
            data:
              - id: offer_3Kf9dQ2mNpXwZ7bV1aLcs
                status: RECEIVED
                amount: '100.00'
                currency: USDCX
                source:
                  party: sender::1220abc...
                destination:
                  userId: usr_3Kf9dQ2mNpXwZ7bV1aLcs
                  walletId: wlt_1aLcs3Kf9dQ2mNpXwZ7bV
                  party: recipient::1220def...
                creationTransactionHash: >-
                  0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890
                executionTransactionHash: null
                createdAt: '2026-07-01T10:30:00.000Z'
                updatedAt: '2026-07-01T10:30:00.000Z'
                expiresAt: '2026-07-02T10:30:00.000Z'
            pagination:
              hasMore: false
              startCursor: offer_3Kf9dQ2mNpXwZ7bV1aLcs
              endCursor: offer_3Kf9dQ2mNpXwZ7bV1aLcs
    BadRequestResponse:
      description: Bad Request — the request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: VALIDATION_ERROR
            message: One or more fields are invalid or missing.
            fields:
              - code: invalid_value
                message: Must be a valid email address
                field: email
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    NotFoundResponse:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFound'
    InternalServerErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
  schemas:
    WalletOfferListObject:
      type: object
      description: Cursor-paginated list of Canton offers.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WalletOfferObject'
        pagination:
          $ref: '#/components/schemas/Pagination'
    ApiError:
      type: object
      description: >-
        Standard v3 error shape, returned by validation failures and
        business-logic errors alike.
      properties:
        type:
          type: string
          description: >-
            Machine-readable error type, e.g. VALIDATION_ERROR,
            ACTION_NOT_ALLOWED, RESOURCE_CONFLICT.
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable error message.
          example: One or more fields are invalid or missing.
        fields:
          type: array
          description: >-
            Present on field-level validation errors. One entry per problem
            field.
          items:
            type: object
            properties:
              code:
                type: string
                description: Error code related to the field issue.
              message:
                type: string
                description: Error message for the specific issue.
              field:
                type: string
                description: The name of the field that has an issue.
    Unauthorized:
      type: object
      properties:
        type:
          type: string
          description: Unauthorized enum
          example: UNAUTHORIZED
        message:
          type: string
          description: Unauthorized message
          example: Authentication required
    NotFound:
      type: object
      properties:
        type:
          type: string
          example: RESOURCE_NOT_FOUND
          description: The error type, e.g., RESOURCE_NOT_FOUND
        message:
          type: string
          description: A descriptive error message
        fields:
          type: array
          description: List of specific field errors
          items:
            type: object
            properties:
              code:
                type: string
                description: Error code related to the field issue
              message:
                type: string
                description: Error message for the specific issue
              field:
                type: string
                description: The name of the field that has an issue
    InternalServerError:
      type: object
      properties:
        type:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: Internal server error enum
        message:
          type: string
          example: An internal server error occurred
          description: Internal server error message
    WalletOfferObject:
      type: object
      description: A Canton transfer offer directed at a HIFI-provisioned Canton wallet.
      properties:
        id:
          type: string
          description: Public ID of the offer (prefixed with `offer_`).
          example: offer_3Kf9dQ2mNpXwZ7bV1aLcs
        status:
          type: string
          description: Current status of the offer.
          example: RECEIVED
        amount:
          type: string
          description: Offer amount.
          example: '100.00'
        currency:
          type: string
          example: USDCX
        source:
          $ref: '#/components/schemas/WalletOfferSource'
        destination:
          $ref: '#/components/schemas/WalletOfferDestination'
        creationTransactionHash:
          type: string
          example: '0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890'
        executionTransactionHash:
          type: string
          nullable: true
          example: null
        createdAt:
          type: string
          format: date-time
          example: '2026-07-01T10:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-07-01T10:30:00.000Z'
        expiresAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-07-02T10:30:00.000Z'
    Pagination:
      type: object
      properties:
        hasMore:
          type: boolean
        startCursor:
          type: string
          nullable: true
        endCursor:
          type: string
          nullable: true
      required:
        - hasMore
        - startCursor
        - endCursor
    WalletOfferSource:
      type: object
      description: Source party of the Canton offer.
      properties:
        party:
          type: string
          description: Canton party identifier of the sender.
          example: sender::1220abc...
    WalletOfferDestination:
      type: object
      description: Destination of the Canton offer.
      properties:
        userId:
          type: string
          description: Public ID of the recipient user (prefixed with `usr_`).
          example: usr_3Kf9dQ2mNpXwZ7bV1aLcs
        walletId:
          type: string
          description: Public ID of the recipient wallet (prefixed with `wlt_`).
          example: wlt_1aLcs3Kf9dQ2mNpXwZ7bV
        party:
          type: string
          description: Canton party identifier of the recipient.
          example: recipient::1220def...
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````