Skip to main content
GET
/
v1
/
gateway
/
payment
/
{id}
/
status
Get the payment status
curl --request GET \
  --url https://api.pay.walletconnect.com/v1/gateway/payment/{id}/status \
  --header 'Api-Key: <api-key>'
{
  "info": null,
  "isFinal": false,
  "pollInMs": 1000,
  "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"

Query Parameters

​
maxPollMs
integer<int64> | null

Maximum time to long-poll for payment status, in milliseconds.

Required range: x >= 0

Response

Payment status retrieved successfully

​
isFinal
boolean
required

True if the payment is in a final state and no longer requires polling

​
status
enum<string>
required

Payment status

Available options:
requires_action,
processing,
succeeded,
failed,
expired,
cancelled
​
info
object

Payment information (transaction hash, amount). Present when status is Succeeded, null otherwise.

Example:
{
  "optionAmount": {
    "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"
  },
  "txId": "0xabc123..."
}
​
pollInMs
integer<int64> | null

Time to poll for payment status, in milliseconds. Not present if the payment is in a final state.

Required range: x >= 0