Skip to main content
POST
/
v1
/
gateway
/
payment
/
{id}
/
cancel
cURL
curl --request POST \
  --url https://api.pay.walletconnect.com/v1/gateway/payment/{id}/cancel \
  --header 'Api-Key: <api-key>'
{
  "cancelledAt": "2025-01-14T10:30:00Z",
  "cancelledReason": "cancelled_by_user",
  "paymentId": "pay_05a2ecc101KMNV56BG17RM6A2S3YKVGPQ2",
  "status": "cancelled"
}

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 cancelled successfully

​
cancelledAt
string
required
​
cancelledReason
string
required
​
paymentId
string
required

Payment ID

Example:

"pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV"

​
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