Create merchant API

Create merchant API is an API call that can be used to register a new merchant under a Partner

Request Header

Field	Type	Attribute	Description
Authorization	String	Mandatory	Basic Base64Encode(partnerServerKey:)
X-PARTNER-ID	String	Mandatory	Unique identifier for partner. Provided by Midtrans.

Request Body

Field	Type	Attribute	Description
email	String	Mandatory	Email to be registered as Midtrans merchant
merchant_name	String	Mandatory	Name of the merchant.
callback_url	String	Optional	Merchant’s endpoint URL where Midtrans sends a response after completing a particular request.
notification_url	String	Optional	Merchant’s endpoint URL where Midtrans’ Payment Gateway sends HTTP callbacks for payment success or failure events. This is only for payment notifications and does not apply to disbursement or transfer. For disbursement notifications, see Disbursement HTTP Notification setup
pay_account_url	String	Optional	Merchant’s endpoint URL where Midtrans' notification engine will send HTTP notification related with pay account (linking & unlinking).
owner_name	String	Optional	The name of the merchant’s owner.
phone_number	String	Optional	The phone number of the merchant without country code
mcc	String	Mandatory	Pass the expected value as specified here Possible values of industry category - Partner Onboarding API.
entity_type	string	Optional	Pass either ‘individual’ or ‘corporate’ as the values.
business_name	String	Optional	The name of the legal entity representing said merchant.

Example

POST api/v1/merchants

Authorization: Basic cGFydG5lci1hcGkta2V5Og==
X-PARTNER-ID: 82150823919040624621823174737537
{
  "email": "[email protected]",
  "merchant_name": "HQ Midtrans Merchant",
  "callback_url": "https://merchant.com/midtrans-callback",
  "notification_url": "https://merchant.com/midtrans-notification",
  "pay_account_url": "https://merchant.com/pay-account-notification",
  "owner_name": "Owner Midtrans",
  "phone_number": "81211111111",
  "mcc": "Event",
  "entity_type": "corporate",
  "business_name": "PT Business Name"
}

Response

Header

Field	Type	Description
x-rate-limit-limit	String	Maximum number of requests that can be sent in the current period of time
x-rate-limit-remaining	String	Remaining number of requests that can be sent in the current period of time
x-rate-limit-reset	String	Rate limit reset time (in Unix epoch seconds)
x-rate-limit-retry-after-seconds	String	Number of seconds until the next rate limit reset

Body

Field	Type	Description
status_code	String	Status code
status_message	String	Status message
error_messages	String[]	Error messages
merchant_id	String	Merchant identifier that is unique per each merchant
merchant_name	String	The name of the merchant
phone_number	String	The phone number of the merchant without country code
callback_url	String	Merchant’s endpoint URL where Midtrans sends a response after completing a particular request.
notification_url	String	Merchant’s endpoint URL where Midtrans’ notification engine will send a success or failure HTTP notification.
pay_account_url	String	Merchant’s endpoint URL where Midtrans' notification engine will send HTTP notification related with pay account (linking & unlinking).
mcc	String	Pass the expected value as specified here Possible values of industry category - Partner Onboarding API .
entity_type	String	Pass either ‘individual’ or ‘corporate’ as the values.
business_name	String	The name of the legal entity representing said merchant.

Successful Response

{
  "status_code": "200",
  "status_message": "Merchants have been successfully created.",
  "merchant_id": "M123456",
  "merchant_name": "HQ Midtrans Merchant",
  "phone_number": "81211111111",
  "callback_url": "https://merchant.com/midtrans-callback",
  "notification_url": "https://merchant.com/midtrans-notification",
  "pay_account_url": "https://merchant.com/pay-account-notification",
  "owner_name": "Owner Midtrans",
  "mcc": "Event",
  "entity_type": "corporate",
  "business_name": "business name"
}

Error Response 400

{
  "error_messages": [   
      "merchant_name cannot be empty",
      "email cannot be empty",
  ]
}

Error Response 401

{
    "status_code": "401",
    "status_message": "Partner is unauthorized"
}

Error Response 500

{
  "status_code": "500",
  "status_message": "Internal Server Error"
}