Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
MasterMerchant APIs

Add Sub-merchant

Add or Invite the new sub-merchant. The sub merchant will asked to register if Login Flow is enabled for sub-merchant.

post/api/master-merchant/{mkey}/add-merchant

Path parameters

mkeystring required

Headers

X-Portone-Client-Keystring
Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

email_addressstring required

The email of sub-merchant.

namestring required

The name of sub-merchant.

countrystring required

The country code of sub-merchant.

is_login_allowedboolean required

The boolean flag indicating whether is login allowed for sub-merchant.

is_invite_merchantboolean required

The boolean flag indicating whether to send invitation to the merchant.

use_master_merchant_credsboolean required

The boolean flag indicating whether sub-merchant can use master merchant credentials..

send_kyc_link_emailboolean required

The boolean flag indicating whether to send KYC to the sub-merchant.

Example request

{
  "email_address": "jatin+testm21@portone.io",
  "name": "Test Sub merchant 20",
  "country": "VN",
  "is_login_allowed": false,
  "is_invite_merchant": false,
  "use_master_merchant_creds": false,
  "send_kyc_link_email": false
}

Response

Successful response

messagestring

The description of the API request execution result

status_codestring

The status_code for API request execution result

status_reasonstring

The status_reason for API request execution result