Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iterapay.com/docs/llms.txt

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

The Update Merchant endpoint modifies an existing merchant’s details. Send the fields you want to update in the request body. The endpoint returns the merchant’s UUID on a successful update. PUT /merchants/{merchantID}

​
Authentication

Accepts a Bearer token (Authorization: Bearer <token>) or an API key (X-Api-Key: <key>).

​
Path parameters

​
merchantID
string
required
The UUID of the merchant to update.

​
Request body

​
name
string
The updated display name for the merchant.

​
Response fields

A 200 OK response is returned on success.
​
id
string
required
The UUID of the updated merchant.

​
Example request

curl --request PUT \
  --url https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My Updated Store"
  }'

​
Example response

{
  "id": "b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f"
}

​
Error responses

StatusDescription
400Invalid request body. The detail field describes the validation error.
401Missing or invalid credentials.
403Valid credentials but insufficient permissions.
404No merchant found with the given merchantID.