Skip to main content
GET
/
v2
/
payments
Search payments with advanced filtering
curl --request GET \
  --url https://api.request.network/v2/payments
{
  "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": "[email protected]"
        },
        "reference": "ORDER-2024-001234"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0,
    "hasMore": false
  }
}

Headers

​
x-api-key
string

API key for authentication (optional if using Client ID)

​
x-client-id
string

Client ID for frontend authentication (optional if using API key)

​
Origin
string

Origin header (required for Client ID auth, automatically set by browser)

Query Parameters

​
txHash
string

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

Example:

"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

​
walletAddress
string

Search by Ethereum wallet address (payer or payee). Returns ALL payments involving this address, including batch payments where the address is either sender or recipient. Example: '0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7'

Example:

"0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7"

​
paymentReference
string

Search by unique payment reference generated by the Request Network. This is the hex identifier used for on-chain payments. Example: '0xb3581f0b0f74cc61'

Example:

"0xb3581f0b0f74cc61"

​
requestId
string

Search by Request Network request ID. This is the unique identifier for the payment request. Example: '01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb'

Example:

"01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"

​
reference
string

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'

Example:

"ORDER-2024-001234"

​
type
enum<string>

Filter by payment type: 'direct' (same currency), 'conversion' (currency conversion), 'crosschain' (cross-chain payment), 'recurring' (subscription payment)

Available options:
direct,
conversion,
crosschain,
recurring
​
invoiceCurrency
string

Invoice Currency ID, from the Request Network Token List e.g: USD

Example:

"USD"

​
paymentCurrency
string

Payment currency ID, from the Request Network Token List e.g: ETH-sepolia-sepolia

Example:

"USDC"

​
fromDate
string

Filter payments from this date (inclusive). Must be in ISO 8601 format in UTC (ending with 'Z'). Example: '2024-01-01T00:00:00.000Z'

Example:

"2024-01-01T00:00:00.000Z"

​
toDate
string

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'

Example:

"2024-01-31T23:59:59.999Z"

​
limit
string
Example:

"20"

​
offset
string
Example:

"0"

Response

Payment search results with comprehensive payment data and pagination metadata

​
payments
object[]
required

Array of matching payments with complete payment details

​
pagination
object
required

Pagination information for navigating through results