Mark a payment as refunded - WalletConnect Pay Docs
Mark a payment as refunded
cURL
curl --request POST \
--url https://api.pay.walletconnect.com/v1/refunds \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Merchant-Id: <merchant-id>' \
--data '
{
"paymentId": "<string>"
}
'
Python
import requests
url = "https://api.pay.walletconnect.com/v1/refunds"
payload = { "paymentId": "<string>" }
headers = {
"Merchant-Id": "<merchant-id>",
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {
method: 'POST',
headers: {
'Merchant-Id': '<merchant-id>',
'Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({paymentId: '<string>'})
};
fetch('https://api.pay.walletconnect.com/v1/refunds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, [\
CURLOPT_URL => "https://api.pay.walletconnect.com/v1/refunds",\
CURLOPT_RETURNTRANSFER => true,\
CURLOPT_ENCODING => "",\
CURLOPT_MAXREDIRS => 10,\
CURLOPT_TIMEOUT => 30,\
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
CURLOPT_CUSTOMREQUEST => "POST",\
CURLOPT_POSTFIELDS => json_encode([\
'paymentId' => '<string>'\
]),\
CURLOPT_HTTPHEADER => [\
"Api-Key: <api-key>",\
"Content-Type: application/json",\
"Merchant-Id: <merchant-id>"\
],\
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
Go
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pay.walletconnect.com/v1/refunds"
payload := strings.NewReader("{\n \"paymentId\": \"<string>\"}\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Merchant-Id", "<merchant-id>")
req.Header.Add("Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Java (Unirest)
HttpResponse<String> response = Unirest.post("https://api.pay.walletconnect.com/v1/refunds")
.header("Merchant-Id", "<merchant-id>")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentId\": \"<string>\"}\n")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://api.pay.walletconnect.com/v1/refunds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Merchant-Id"] = '<merchant-id>'
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentId\": \"<string>\"}\n"
response = http.request(request)
puts response.read_body
200 OK Response Example
{
"paymentId": "pay_a1a2ecc101KGF210FP7PN3BK08PZARS1CZ"
}
Authorizations
- Api-Key: required
- Merchant-Id: required
- WCP-Version: optional
Body Parameters
- paymentId: string, required, Payment ID to refund.
Response
- 200: Payment marked as refunded.