Skip to main content
PUT

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

merchant_id
string
required

The merchant ID.

Body

application/json

The request body to update a merchant.

name
string

The merchant name.

Example:

"Merchant B"

developer_fee_rate
string

The developer fee rate applied to this merchant. Must be a valid float between 0 and 1 (inclusive), with up to 4 decimal places. For more information on developer fee rate, please refer to Accounts and fund allocation.

Example:

"0.1"

Response

The request was successful.

merchant_id
string
required

The merchant ID.

Example:

"1"

name
string
required

The merchant name.

Example:

"Merchant-1"

wallet_id
string<uuid>
required

This field has been deprecated.

Example:

"123e4567-e89b-12d3-a456-426614174001"

developer_fee_rate
string

The merchant-level fee fraction applied specifically to Top-up-mode deposits. The value can range from 0 through 1 and can contain up to four decimal places. For example, 0.015 represents 1.5%. An absent or cleared value is treated as zero, so no developer fee is charged on Top-up deposits.

An update applies only to subsequent Top-up deposits and is not retroactive to deposits that have already been processed. The developer share is rounded down to the token's precision.

This rate does not combine with a Payment Order's fee_amount. Order-mode and Top-up-mode deposits use separate, mutually exclusive settlement paths, so there is no calculation order or precedence between the two fees.

For configuration and settlement details, see Merchant management, Payment collection in order mode, and Accounts and fund allocation.

Example:

"0.015"

wallet_setup
enum<string>

The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses.

  • Shared: (Default) Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously.
  • Separate: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant.
  • Default: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization). Do not select this option when creating a merchant.
Available options:
Default,
Shared,
Separate
Example:

"Shared"

created_timestamp
integer

The creation time of the merchant, represented as a UNIX timestamp in seconds.

Example:

1744689600

updated_timestamp
integer

The last update time of the merchant, represented as a UNIX timestamp in seconds.

Example:

1744689600