v1

latestOpenAPI 3.0.02026-07-22290108.6 KB
V2/Payments

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.

get/v2/payments

Query parameters

txHashstring
Example:0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

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

walletAddressstring
Example:0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7

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.

paymentReferencestring
Example:0xb3581f0b0f74cc61

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

requestIdstring
Example:01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb

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

referencestring
Example:ORDER-2024-001234

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'

type'direct' | 'conversion' | 'crosschain' | 'recurring'

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

invoiceCurrencystring
Example:USD

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

paymentCurrencystring
Example:USDC

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

fromDatestring
Example:2024-01-01T00:00:00.000Z

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

toDatestring
Example:2024-01-31T23:59:59.999Z

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'

limitstring
Example:20
offsetstring
Example:0

Headers

x-api-keystring

API key for authentication (optional if using Client ID)

x-client-idstring

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

Originstring

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

Response

Payment search results with comprehensive payment data and pagination metadata

Example response

{
  "pagination": {
    "total": 157,
    "limit": 20,
    "hasMore": true
  }
}