WalletConnect
WalletGuideRequest Demo
WalletsAppsNetworkPaymentsWallet VerificationAPI Reference

Get the payment status

GET
/v1/gateway/payment/{id}/status

Authorization

headerApi-Key<token>

Path Parameters

id*string

Payment ID

Query Parameters

maxPollMs?|

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

Formatint64
Range0 <= value

Header Parameters

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

Response Body

Payment status retrieved successfully

application/json
  1. response
failureCode?|null
info?|null
isFinal*boolean

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

pollInMs?|

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

Formatint64
Range0 <= value
status*PaymentStatus

Payment status

Value in"requires_action""processing""succeeded""failed""expired""cancelled"
curl -X GET 'https://api.pay.walletconnect.com/v1/gateway/payment/pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV/status'
{  "failureCode": "declined_user",  "info": {    "optionAmount": {      "display": {        "assetName": "string",        "assetSymbol": "string",        "decimals": 0,        "iconUrl": "string",        "networkIconUrl": "string",        "networkName": "string"      },      "unit": "string",      "value": "string"    },    "txId": "string"  },  "isFinal": true,  "pollInMs": 0,  "status": "requires_action"}

Get payment options

Previous Page

POST /v1/gateway/payment/{id}/transition

Next Page