Skip to main content
POST
/
payments
/
merchants
import cobo_waas2
from cobo_waas2.models.create_merchant_request import CreateMerchantRequest
from cobo_waas2.models.merchant import Merchant
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    create_merchant_request = cobo_waas2.CreateMerchantRequest(name="Merchant A")

    try:
        # Create merchant
        api_response = api_instance.create_merchant(
            create_merchant_request=create_merchant_request
        )
        print("The response of PaymentApi->create_merchant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_merchant: %s\n" % e)


{
  "merchant_id": "1",
  "name": "Merchant-1",
  "wallet_id": "123e4567-e89b-12d3-a456-426614174001",
  "developer_fee_rate": "0.01",
  "wallet_setup": "Shared",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600
}
import cobo_waas2
from cobo_waas2.models.create_merchant_request import CreateMerchantRequest
from cobo_waas2.models.merchant import Merchant
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    create_merchant_request = cobo_waas2.CreateMerchantRequest(name="Merchant A")

    try:
        # Create merchant
        api_response = api_instance.create_merchant(
            create_merchant_request=create_merchant_request
        )
        print("The response of PaymentApi->create_merchant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_merchant: %s\n" % e)

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.

Body

application/json

The request body to create a merchant.

​
name
string
required

The merchant name.

Example:

"Merchant A"

​
wallet_id
string<uuid>

This field has been deprecated.

Example:

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

​
developer_fee_rate
string

The developer fee rate applied to this merchant. Expressed as a string in decimal format where "0.1" represents 10%. For more information on developer fee rate, please refer to Amounts and balances.

Example:

"0.1"

​
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"

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 developer fee rate applied to this merchant.

Example:

"0.01"

​
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