Update a merchant

Update a merchant’s profile. At least one of merchantName, merchantEmail, or iconUrl must be provided. Pass iconUrl: null to unset the existing logo.

PATCH /v1/merchants/{merchantId}

Update a merchant

cURL

curl --request PATCH \
  --url https://api.pay.walletconnect.com/v1/merchants/{merchantId} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantName": "<string>",
  "merchantEmail": "[e-mail]",
  "iconUrl": "https://example.com/new-logo.png"
}
'

import requests

url = "https://api.pay.walletconnect.com/v1/merchants/{merchantId}"

payload = {
    "merchantName": "<string>",
    "merchantEmail": "[e-mail]",
    "iconUrl": "https://example.com/new-logo.png"
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    merchantName: '<string>',
    merchantEmail: '[e-mail]',
    iconUrl: 'https://example.com/new-logo.png'
  })
};

fetch('https://api.pay.walletconnect.com/v1/merchants/{merchantId}', 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/merchants/{merchantId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'merchantName' => '<string>',
    'merchantEmail' => '[e-mail]',
    'iconUrl' => 'https://example.com/new-logo.png'
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.pay.walletconnect.com/v1/merchants/{merchantId}"

	payload := strings.NewReader("{\n  \"merchantName\": \"<string>\",\n  \"merchantEmail\": \"[e-mail]\",\n  \"iconUrl\": \"https://example.com/new-logo.png\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

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

}

HttpResponse<String> response = Unirest.patch("https://api.pay.walletconnect.com/v1/merchants/{merchantId}")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantName\": \"<string>\",\n  \"merchantEmail\": \"[e-mail]\",\n  \"iconUrl\": \"https://example.com/new-logo.png\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pay.walletconnect.com/v1/merchants/{merchantId}")

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

request = Net::HTTP::Patch.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchantName\": \"<string>\",\n  \"merchantEmail\": \"[e-mail]\",\n  \"iconUrl\": \"https://example.com/new-logo.png\"\n}"

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

200

Example

{
  "merchant": {
    "id": "mrch_7kBz2qR9xPvLmN4Yw",
    "name": "Acme Store v2",
    "email": "[e-mail]",
    "status": "active",
    "iconUrl": "https://imagedelivery.net/example/acme-icon.png",
    "createdAt": "2025-06-15T10:30:00.000Z"
  }
}

Authorizations

API KeyApiKeyAppId

Api-Key · string · header · required

Path Parameters

merchantId · string · required

Body

application/json

merchantName · string

Updated display name

Required string length: 1 - 256

Example:

"Acme Store v2"

merchantEmail · string<email>

Updated contact email

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"[e-mail]"

iconUrl · string<uri> | null

Updated logo URL (HTTPS only), or null to unset

Example:

"https://example.com/new-logo.png"

Response

200

application/json

Merchant updated

merchant · object · required

Show child attributes