Skip to main content
GET
/
v1
/
gateway
/
payment
/
{id}
Get a payment
curl --request GET \
  --url https://api.pay.walletconnect.com/v1/gateway/payment/{id} \
  --header 'Api-Key: <api-key>'
{
  "amount": {
    "display": {
      "assetName": "USD Coin",
      "assetSymbol": "USDC",
      "decimals": 6,
      "iconUrl": "https://assets.walletconnect.com/usdc.png",
      "networkIconUrl": "https://assets.walletconnect.com/base.png",
      "networkName": "Base"
    },
    "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000",
    "value": "1000000"
  },
  "buyer": {
    "accountCaip10": "eip155:1:0x0000000000000000000000000000000000000000",
    "accountProviderIcon": "https://example.com/icon.png",
    "accountProviderName": "Wallet"
  },
  "expiresAt": 1700000000,
  "merchant": {
    "iconUrl": "https://example.com/icon.png",
    "name": "Merchant"
  },
  "status": "requires_action"
}

Authorizations

​
Api-Key
string
header
required

Headers

​
Api-Key
string | null
​
App-Id
string | null
​
Client-Id
string | null
​
WCP-Version
string | null
​
Sdk-Name
string | null
​
Sdk-Version
string | null
​
Sdk-Platform
string | null

Path Parameters

​
id
string
required

Payment ID

Example:

"pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV"

Response

Payment status retrieved successfully

​
amount
object
required
Example:
{
  "display": {
    "assetName": "USD Coin",
    "assetSymbol": "USDC",
    "decimals": 6,
    "iconUrl": "https://assets.walletconnect.com/usdc.png",
    "networkIconUrl": "https://assets.walletconnect.com/base.png",
    "networkName": "Base"
  },
  "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000",
  "value": "1000000"
}
​
expiresAt
integer<int64>
required
Required range: x >= 0
​
merchant
object
required
Example:
{
  "iconUrl": "https://example.com/icon.png",
  "name": "Merchant"
}
​
status
enum<string>
required

Payment status representing the lifecycle of a payment.

Payments progress through these states from creation to terminal status. Some states are specific to the payment source (pull vs push).

Available options:
requires_action,
processing,
succeeded,
failed,
expired,
cancelled
​
buyer
object
Example:
{
  "accountCaip10": "eip155:1:0x0000000000000000000000000000000000000000",
  "accountProviderIcon": "https://example.com/icon.png",
  "accountProviderName": "Wallet"
}