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

# Search payments with advanced filtering

> Search for payments by transaction hash, wallet address, payment reference, request ID, or merchant reference. Supports filtering by payment type, currencies, date ranges, and pagination. Returns complete payment details including customer information and fees. When searching by transaction hash or wallet address, returns ALL payments from batch transactions. Most search parameters are optional, but at least one must be provided and they default to an AND relationship.



## OpenAPI

````yaml /api-reference/openapi.v2.json get /v2/payments
openapi: 3.0.0
info:
  title: Request Network API
  description: API for easily creating and paying Requests with Request Network.
  version: 0.13.0
  contact: {}
servers:
  - url: https://api.request.network
    description: Production server
  - url: https://api.stage.request.network
    description: Staging server
  - url: http://127.0.0.1:8080
    description: Local development server
security: []
tags:
  - name: V2/Request
    description: Core payment request operations (V2)
  - name: V2/Payments
    description: Payment search and management operations (V2)
  - name: V2/Payouts
    description: Pay a request without creating one first (V2)
  - name: V2/Payer
    description: Crypto-to-fiat payer management operations (V2)
  - name: V2/Currencies
    description: Currency operations (V2)
  - name: V2/Client IDs
    description: Client ID management (V2)
  - name: V2/Payee Destination
    description: Payee destination management (V2)
externalDocs:
  description: Request Network Docs
  url: https://docs.request.network/request-network-api
paths:
  /v2/payments:
    get:
      tags:
        - V2/Payments
      summary: Search payments with advanced filtering
      description: >-
        Search for payments by transaction hash, wallet address, payment
        reference, request ID, or merchant reference. Supports filtering by
        payment type, currencies, date ranges, and pagination. Returns complete
        payment details including customer information and fees. When searching
        by transaction hash or wallet address, returns ALL payments from batch
        transactions. Most search parameters are optional, but at least one must
        be provided and they default to an AND relationship.
      operationId: PaymentV2Controller_searchPayments_v2
      parameters:
        - name: x-api-key
          in: header
          description: API key for authentication (optional if using Client ID)
          required: false
          schema:
            type: string
        - name: x-client-id
          in: header
          description: Client ID for frontend authentication (optional if using API key)
          required: false
          schema:
            type: string
        - name: Origin
          in: header
          description: >-
            Origin header (required for Client ID auth, automatically set by
            browser)
          required: false
          schema:
            type: string
        - name: txHash
          required: false
          in: query
          description: >-
            Search by blockchain transaction hash (source or destination).
            Returns ALL payments from the same transaction, including batch
            payments. Must be a valid 66-character hex string starting with
            '0x'. Example: '0x1234567890abcdef...'
          schema:
            example: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef'
            type: string
        - name: walletAddress
          required: false
          in: query
          description: >-
            Search by wallet address (payer or payee). Supports Ethereum (0x...)
            and TRON (T...) addresses. Returns ALL payments involving this
            address, including batch payments where the address is either sender
            or recipient.
          schema:
            example: '0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7'
            type: string
        - name: paymentReference
          required: false
          in: query
          description: >-
            Search by unique payment reference generated by the Request Network.
            This is the hex identifier used for on-chain payments. Example:
            '0xb3581f0b0f74cc61'
          schema:
            example: '0xb3581f0b0f74cc61'
            type: string
        - name: requestId
          required: false
          in: query
          description: >-
            Search by Request Network request ID. This is the unique identifier
            for the payment request. Example:
            '01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb'
          schema:
            example: 01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb
            type: string
        - name: reference
          required: false
          in: query
          description: >-
            Search by your custom merchant reference used for receipt tracking
            and order identification. This is the reference you provided when
            creating the payment. Example: 'ORDER-2024-001234' or 'INV-5678'
          schema:
            example: ORDER-2024-001234
            type: string
        - name: type
          required: false
          in: query
          description: >-
            Filter by payment type: 'direct' (same currency), 'conversion'
            (currency conversion), 'crosschain' (cross-chain payment),
            'recurring' (subscription payment)
          schema:
            enum:
              - direct
              - conversion
              - crosschain
              - recurring
            type: string
        - name: invoiceCurrency
          required: false
          in: query
          description: >-
            Invoice Currency ID, from the [Request Network Token
            List](https://docs.request.network/general/request-network-token-list)
            e.g: USD
          schema:
            example: USD
            type: string
        - name: paymentCurrency
          required: false
          in: query
          description: >-
            Payment currency ID, from the [Request Network Token
            List](https://docs.request.network/general/request-network-token-list)
            e.g: ETH-sepolia-sepolia
          schema:
            example: USDC
            type: string
        - name: fromDate
          required: false
          in: query
          description: >-
            Filter payments from this date (inclusive). Must be in ISO 8601
            format in UTC (ending with 'Z'). Example: '2024-01-01T00:00:00.000Z'
          schema:
            example: '2024-01-01T00:00:00.000Z'
            type: string
        - name: toDate
          required: false
          in: query
          description: >-
            Filter payments until this date (inclusive). Must be in ISO 8601
            format in UTC (ending with 'Z'). Must be after fromDate if both are
            provided. Example: '2024-01-31T23:59:59.999Z'
          schema:
            example: '2024-01-31T23:59:59.999Z'
            type: string
        - name: limit
          required: false
          in: query
          description: ''
          schema:
            example: '20'
            type: string
        - name: offset
          required: false
          in: query
          description: ''
          schema:
            example: '0'
            type: string
      responses:
        '200':
          description: >-
            Payment search results with comprehensive payment data and
            pagination metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  payments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier of the payment
                        amount:
                          type: string
                          description: >-
                            Payment amount as a human-readable decimal string
                            (formatUnits)
                        sourceNetwork:
                          type: string
                          description: Network where the payment originated
                        destinationNetwork:
                          type: string
                          description: Network where the payment was received
                        sourceTxHash:
                          type: string
                          nullable: true
                          description: Transaction hash on the source network
                        destinationTxHash:
                          type: string
                          nullable: true
                          description: Transaction hash on the destination network
                        timestamp:
                          type: string
                          format: date-time
                          description: Timestamp when the payment was processed
                        type:
                          type: string
                          enum:
                            - direct
                            - conversion
                            - crosschain
                            - recurring
                          description: Type of payment
                        conversionRateSource:
                          type: string
                          nullable: true
                          description: Conversion rate used for source currency
                        conversionRateDestination:
                          type: string
                          nullable: true
                          description: Conversion rate used for destination currency
                        convertedAmountSource:
                          type: string
                          nullable: true
                          description: Converted amount in source currency
                        convertedAmountDestination:
                          type: string
                          nullable: true
                          description: Converted amount in destination currency
                        currency:
                          type: string
                          description: Invoice currency symbol
                        paymentCurrency:
                          type: string
                          description: Payment currency symbol
                        fees:
                          type: array
                          nullable: true
                          description: Array of fees associated with the payment
                          items:
                            type: object
                            properties:
                              type:
                                type: string
                                enum:
                                  - gas
                                  - platform
                                  - crosschain
                                  - crypto-to-fiat
                                  - offramp
                                description: Type of fee
                              stage:
                                type: string
                                enum:
                                  - sending
                                  - receiving
                                  - proxying
                                  - refunding
                                description: Stage when the fee is applied
                              provider:
                                type: string
                                description: Provider that charged the fee
                              amount:
                                type: string
                                description: >-
                                  Fee amount in human-readable format (formatted
                                  with token decimals)
                              amountInUSD:
                                type: string
                                description: Fee amount in USD
                              currency:
                                type: string
                                description: Fee currency
                              receiverAddress:
                                type: string
                                description: Address that received the fee
                              network:
                                type: string
                                description: Network where the fee was paid
                              rateProvider:
                                type: string
                                description: Provider used for rate conversion
                        recurringPaymentId:
                          type: string
                          nullable: true
                          description: ID of the recurring payment this payment belongs to
                        rateProvider:
                          type: string
                          enum:
                            - lifi
                            - chainlink
                            - coingecko
                            - unknown
                          nullable: true
                          description: Provider used for exchange rate data
                        request:
                          type: object
                          description: Associated request information
                          properties:
                            requestId:
                              type: string
                              description: Request ID
                            paymentReference:
                              type: string
                              description: Payment reference
                            hasBeenPaid:
                              type: boolean
                              description: Whether the request has been fully paid
                            customerInfo:
                              type: object
                              nullable: true
                              description: Customer information
                              properties:
                                firstName:
                                  type: string
                                lastName:
                                  type: string
                                email:
                                  type: string
                                address:
                                  type: object
                                  properties:
                                    street:
                                      type: string
                                    city:
                                      type: string
                                    state:
                                      type: string
                                    postalCode:
                                      type: string
                                    country:
                                      type: string
                            reference:
                              type: string
                              nullable: true
                              description: Merchant reference
                      required:
                        - id
                        - amount
                        - sourceNetwork
                        - destinationNetwork
                        - timestamp
                        - type
                        - currency
                        - paymentCurrency
                    description: Array of matching payments with complete payment details
                  pagination:
                    type: object
                    description: Pagination information for navigating through results
                    properties:
                      total:
                        type: number
                        description: Total number of payments matching the search criteria
                        example: 157
                      limit:
                        type: number
                        description: Maximum number of results returned in this response
                        example: 20
                      offset:
                        type: number
                        description: Number of results skipped (for pagination)
                        example: 0
                      hasMore:
                        type: boolean
                        description: >-
                          Whether there are more results available beyond this
                          page
                        example: true
                    required:
                      - total
                      - limit
                      - offset
                      - hasMore
                required:
                  - payments
                  - pagination
              examples:
                searchByTxHash:
                  summary: Search by transaction hash
                  value:
                    payments:
                      - id: 01HXAMPLE1234567890ABCDEF
                        amount: '1000000000000000000'
                        sourceNetwork: sepolia
                        destinationNetwork: sepolia
                        sourceTxHash: >-
                          0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                        destinationTxHash: null
                        timestamp: '2024-01-15T10:30:00.000Z'
                        type: conversion
                        conversionRateSource: null
                        conversionRateDestination: null
                        convertedAmountSource: null
                        convertedAmountDestination: null
                        currency: USD
                        paymentCurrency: ETH
                        fees:
                          - type: gas
                            amount: '21000000000000000'
                            currency: ETH
                            provider: request-network
                        recurringPaymentId: null
                        rateProvider: chainlink
                        request:
                          requestId: >-
                            01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb
                          paymentReference: '0xb3581f0b0f74cc61'
                          hasBeenPaid: true
                          customerInfo:
                            firstName: John
                            lastName: Doe
                            email: john.doe@example.com
                          reference: ORDER-2024-001234
                    pagination:
                      total: 1
                      limit: 20
                      offset: 0
                      hasMore: false
                searchByWalletAndDateRange:
                  summary: Search by wallet address with date filtering
                  value:
                    payments:
                      - id: 01HXAMPLE1111222233334444
                        amount: '50000000'
                        sourceNetwork: base
                        destinationNetwork: base
                        sourceTxHash: >-
                          0x1111222233334444555566667777888899990000aaaabbbbccccddddeeeeffff
                        destinationTxHash: null
                        timestamp: '2024-01-14T16:20:00.000Z'
                        type: conversion
                        currency: USD
                        paymentCurrency: USDC
                        fees:
                          - type: platform
                            amount: '500000'
                            currency: USDC
                            provider: request-network
                        request:
                          requestId: >-
                            01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb
                          paymentReference: '0xe1f2a3b4c5d67890'
                          hasBeenPaid: true
                          reference: SERVICE-2024-789
                      - id: 01HXAMPLE5555666677778888
                        amount: '25000000'
                        sourceNetwork: base
                        destinationNetwork: base
                        sourceTxHash: >-
                          0x5555666677778888999900001111222233334444555566667777888899990000
                        destinationTxHash: null
                        timestamp: '2024-01-13T09:15:00.000Z'
                        type: conversion
                        currency: USD
                        paymentCurrency: USDC
                        request:
                          requestId: >-
                            01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb
                          paymentReference: '0xf1e2d3c4b5a67890'
                          hasBeenPaid: true
                          reference: PRODUCT-2024-456
                    pagination:
                      total: 2
                      limit: 20
                      offset: 0
                      hasMore: false
                searchByMerchantReference:
                  summary: Search by merchant reference with pagination
                  value:
                    payments:
                      - id: 01HXAMPLE9999888877776666
                        amount: '150000000000000000000'
                        sourceNetwork: sepolia
                        destinationNetwork: sepolia
                        sourceTxHash: >-
                          0x9999888877776666555544443333222211110000ffffeeeedddcccbbbaaa999
                        destinationTxHash: null
                        timestamp: '2024-01-15T11:45:00.000Z'
                        type: conversion
                        conversionRateSource: '0.0004'
                        conversionRateDestination: '2500.0'
                        convertedAmountSource: '150000000000000000000'
                        convertedAmountDestination: '60000000'
                        currency: USD
                        paymentCurrency: ETH
                        fees:
                          - type: conversion
                            amount: '600000000000000000'
                            currency: ETH
                            provider: request-network
                        request:
                          requestId: >-
                            01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb
                          paymentReference: '0xa1b2c3d4e5f67890'
                          hasBeenPaid: true
                          customerInfo:
                            firstName: Sarah
                            lastName: Wilson
                            email: sarah.wilson@company.com
                            address:
                              street: 789 Pine Street
                              city: Seattle
                              state: WA
                              postalCode: '98101'
                              country: US
                          reference: SUBSCRIPTION-ANNUAL-2024
                    pagination:
                      total: 15
                      limit: 1
                      offset: 0
                      hasMore: true
        '400':
          description: Invalid search parameters or validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 400
                  message:
                    type: string
                    example: Validation failed
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          example: toDate
                        message:
                          type: string
                          example: toDate must be after or equal to fromDate
        '401':
          description: Authentication required - API key or client ID missing
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 401
                  message:
                    type: string
                    example: Unauthorized
                  error:
                    type: string
                    example: Unauthorized
        '429':
          description: Too Many Requests

````