API Reference2026-02-19.previewGateway

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

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

Authorization

headerApi-Key<token>

Path Parameters

id*string

Payment ID

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

application/json
  1. response
cancelledAt*string
cancelledReason*string
paymentId*PaymentId

Payment ID

status*PaymentStatus

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).

Value in"requires_action""processing""succeeded""failed""expired""cancelled"
curl -X POST 'https://api.pay.walletconnect.com/v1/gateway/payment/pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV/cancel'
{  "cancelledAt": "string",  "cancelledReason": "string",  "paymentId": "pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV",  "status": "requires_action"}