Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.pay.walletconnect.com/v1/payments \
  --header 'Api-Key: <api-key>'
{ "data": [ { "paymentId": "pay_a1a2ecc101KGF210FP7PN3BK08PZARS1CZ", "merchant": { "id": "acme-store-1", "name": "Acme Store", "iconUrl": "https://imagedelivery.net/example/icon.png" }, "referenceId": "a1b2cad4e5f2783012345678axcdea90", "status": "succeeded", "isTerminal": true, "fiatAmount": { "unit": "iso4217/USD", "value": "500", "display": { "assetSymbol": "USD", "assetName": "US Dollar", "decimals": 2 } }, "tokenAmount": { "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000", "value": "5000000", "display": { "assetSymbol": "USDC", "assetName": "USD Coin", "decimals": 6, "networkName": "Base", "iconUrl": "https://api.walletconnect.com/assets/v1/image/token/USDC/md", "networkIconUrl": "https://api.walletconnect.com/assets/v1/image/network/eip155%3A8453/md" } }, "buyer": { "accountCaip10": "eip155:8453:0x0000000000000000000000000000000000000000", "accountProviderName": "MetaMask", "accountProviderIcon": "https://api.walletconnect.com/assets/v1/image/wallet/metamask/md" }, "transaction": { "networkId": "8453", "hash": "0x0000000000000000000000000000000000000000000000000000000000000000", "nonce": 42 }, "settlement": { "amount": { "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000", "value": "4840000", "display": { "assetSymbol": "USDC", "assetName": "USD Coin", "decimals": 6, "iconUrl": "https://api.walletconnect.com/assets/v1/image/token/USDC/md", "networkName": "Base", "networkIconUrl": "https://api.walletconnect.com/assets/v1/image/network/eip155%3A8453/md" } }, "settled": true, "txHash": "0x0000000000000000000000000000000000000000000000000000000000000000" }, "fees": { "total": { "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000", "value": "160000", "display": { "assetSymbol": "USDC", "assetName": "USD Coin", "decimals": 6, "iconUrl": "https://api.walletconnect.com/assets/v1/image/token/USDC/md", "networkName": "Base", "networkIconUrl": "https://api.walletconnect.com/assets/v1/image/network/eip155%3A8453/md" } }, "fixed": { "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000", "value": "140000", "display": { "assetSymbol": "USDC", "assetName": "USD Coin", "decimals": 6, "iconUrl": "https://api.walletconnect.com/assets/v1/image/token/USDC/md", "networkName": "Base", "networkIconUrl": "https://api.walletconnect.com/assets/v1/image/network/eip155%3A8453/md" } }, "percentage": "0.4" }, "createdAt": "2024-01-01T12:00:00.000Z", "lastUpdatedAt": "2024-01-01T12:00:00.000Z", "settledAt": "2024-01-01T12:00:00.000Z" } ], "nextCursor": null, "stats": { "totalRevenue": [ { "amount": 1000, "currency": "USD" } ], "totalTransactions": 100, "totalCustomers": 25 } }

Documentation Index

Fetch the complete documentation index at: https://walletconnect-pay-docs-docs-add-ai-agent-sdk-section.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Api-Key
string
header
required

Headers

​
WCP-Version
string

Optional WalletConnect Pay API version override. If omitted, the partner's pinned version is used.

Examples:

"2026-02-18"

"2026-02-19.preview"

Query Parameters

​
startTs
string<date-time>

RFC3339 timestamp, inclusive

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Example:

"2026-01-06T00:00:00Z"

​
endTs
string<date-time>

RFC3339 timestamp, exclusive

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Example:

"2026-01-07T00:00:00Z"

​
token_symbol
string[]

Filter by token symbol (e.g. USDC). CAIP-19 identifiers are not supported. Accepts a single value or multiple repeated params:

  • Single: ?token_symbol=USDC
  • Multiple: ?token_symbol=USDC&token_symbol=EURC
Minimum string length: 1
​
asset
string
deprecated

Deprecated. This parameter will be removed in a future API version. Use token_symbol param instead.

​
network
string

Filter by CAIP-2 chain ID. Comma-separated for multiple.

Examples:

"eip155:8453"

"eip155:8453,eip155:1"

​
sortBy
enum<string>

Field to sort by

Available options:
date,
amount
​
sortDir
enum<string>

Sort direction

Available options:
asc,
desc
​
cursor
string

Opaque pagination cursor — use the value from nextCursor in the previous response.

​
limit
integer

Page size (default 50, max 200)

Required range: 1 <= x <= 200
​
status
enum<string>[]

Filter by payment status. Accepts a single value or multiple repeated params:

  • Single: ?status=succeeded
  • Multiple: ?status=succeeded&status=processing
Available options:
requires_action,
processing,
succeeded,
failed,
expired
​
referenceId
string

Substring search on the merchant-provided reference ID. Between 3 and 35 characters. Allowed characters: ASCII letters, digits, and /-:.,+.

Required string length: 3 - 35
Pattern: ^[A-Za-z0-9 /:.,+-]+$
Example:

"order-42"

​
merchantId
string[]

Filter by merchant ID. Accepts a single value or multiple repeated params:

  • Single: ?merchantId=acme-store-1
  • Multiple: ?merchantId=acme-store-1&merchantId=widget_co
Minimum string length: 1
Examples:
["acme-store-1"]

["acme-store-1", "widget_co"]

Response

Payments with statistics

​
data
object[]
required
​
nextCursor
string | null
required

Cursor for the next page, or null if no more results

​
stats
object
required

Aggregate statistics for the query