POST /v1/payments/{id}/cancel - WalletConnect Pay Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request POST \
  --url https://api.pay.walletconnect.com/v1/payments/{id}/cancel \
  --header 'Api-Key: <api-key>' \
  --header 'Merchant-Id: <merchant-id>'

import requests

url = "https://api.pay.walletconnect.com/v1/payments/{id}/cancel"

headers = {
    "Api-Key": "<api-key>",
    "Merchant-Id": "<merchant-id>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Api-Key': '<api-key>', 'Merchant-Id': '<merchant-id>'}
};

fetch('https://api.pay.walletconnect.com/v1/payments/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api.pay.walletconnect.com/v1/payments/{id}/cancel",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_HTTPHEADER => [\
    "Api-Key: <api-key>",\
    "Merchant-Id: <merchant-id>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api.pay.walletconnect.com/v1/payments/{id}/cancel"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Api-Key", "<api-key>")
    req.Header.Add("Merchant-Id", "<merchant-id>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://api.pay.walletconnect.com/v1/payments/{id}/cancel")
  .header("Api-Key", "<api-key>")
  .header("Merchant-Id", "<merchant-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pay.walletconnect.com/v1/payments/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Merchant-Id"] = '<merchant-id>'

response = http.request(request)
puts response.read_body

Response Codes

Example Response

{
  "cancelledAt": "2025-01-14T10:30:00Z",
  "cancelledReason": "cancelled_by_merchant",
  "paymentId": "pay_71a2ecc101KQFN7X7RM3Z9GB4ZGNM17TRB",
  "status": "cancelled"
}

{
  "message": "<string>"
}

Authorizations

API Key: ApiKey

Parameter Type Location Required
Api-Key string header required
Merchant-Id string header required

Path Parameters

Parameter Type Required Description
id string required Payment ID

Success Response

200