Docs
Merchant
Get Merchant

Get Merchant Information

To retrieve the details of an existing merchant, you can use the Get Merchant API. This allows you to fetch merchant data based on a specific merchant ID.

Step 1: Send a Request to Fetch Merchant Details

To retrieve the merchant information, send a POST request to the API endpoint with the merchant's ID in the request body.

Endpoint URL

https://api.zipay.co.id/merchant/getMerchant

Request

To get the details of a registered merchant, use the following API endpoint. Be sure to include your Bearer token in the request header for authorization.

  • URL: https://api.zipay.co.id/merchant/getMerchant
  • Method: POST
  • Headers:
    • Content-Type: application/json
    • Authorization: Bearer <YOUR_BEARER_TOKEN>

Request Body

Example Request

{
  "id": 1
}

Response

Example Response

{
  "status": 200,
  "success": true,
  "data": {
    "merchant": {
      "merchantId": "1",
      "merchantKey": "72a22c8a-0338-48de-9e05-dcbf8993591b",
      "fullName": "VIRA YULIANA",
      "businessName": "ZHX GUITAR STORE",
      "mid": "ZPM193031118802",
      "mpan": "9360082500814951041",
      "nmid": "ID2024351834617",
      "status": "ACTIVE"
    },
    "message": "Success Get Data Merchant"
  }
}
FieldDescription
statusThe HTTP status code indicating the result of the request.
successA boolean value indicating whether the request was successful (true) or not (false).
data.merchant.merchantIdThe unique identifier of the merchant.
data.merchant.merchantKeyThe unique key associated with the merchant.
data.merchant.fullNameThe full name of the merchant.
data.merchant.businessNameThe name of the business associated with the merchant.
data.merchant.midThe Merchant ID assigned by the current QRIS provider.
data.merchant.mpanThe Merchant PAN (Primary Account Number). This is a unique identifier for the merchant's account.
data.merchant.nmidThis field can be null when the merchant's account status is not active (e.g., PENDING, NON ACTIVE, FREEZE).
data.merchant.statusThe current activation status of the merchant account (e.g., ACTIVE,PENDING,NON ACTIVE,FREEZE).
messageA message indicating the result of fetching the merchant data.