Retrieve Merchant

ENDPOINT

GET

https://open.sunbay.us/v1/merchant/query

Retrieve the profile of a merchant. Returns basic identity, address, MCC, and status of the merchant.

Parameters

Header parameters

Name	Type	Required	Description
`Authorization`	`string`	Yes	Bearer Token authentication, format: Bearer {your_api_key} Example: `"Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"`
`X-Client-Request-Id`	`string(64)`	Yes	Request unique identifier (UUID recommended), used for idempotency and troubleshooting. Example: `"550e8400-e29b-41d4-a716-446655440000"`
`X-Timestamp`	`string`	Yes	Request timestamp, Unix timestamp in milliseconds (13 digits). Must be within ±10 minutes of server time. Pattern: `^[0-9]{13}$` Example: `"1701234567890"`

Query parameters

Name	Type	Required	Description
`appId`	`string(32)`	Yes	Application ID, the unique identifier of the integrated application created through the SUNBAY Connect developer platform Example: `"smkrjobsk3sifh90"`
`merchantId`	`string(11-11)`	Yes	SUNBAY platform merchant unique identifier, created via the SUNBAY Copilot portal. Format: 11-character alphanumeric string starting with M. ⚠ Note: This is not the MID assigned by a payment processor Pattern: `^M[A-Za-z0-9]{10}$` Example: `"M1261833002"`

Response parameters

Name	Type	Required	Description
`code`	`string(16)`	Y	Response code, 0 indicates success Example: `"0"`
`msg`	`string(128)`	N	Response description Example: `"Success"`
`traceId`	`string(64)`	Y	Trace ID for troubleshooting Example: `"TRACE123456789"`
`data`	`object`	Y

Response Example (200)

{
  "code": "0",
  "msg": "Success",
  "traceId": "TRACE123456789",
  "data": {
    "merchantId": "M1261833002",
    "dbaName": "Sunmi Coffee",
    "mcc": "5812",
    "country": "USA",
    "stateName": "California",
    "cityName": "San Francisco",
    "street": "Market Street",
    "detailAddress": "123 Market Street, Suite 400",
    "zipCode": "94103",
    "status": "Y",
    "createTime": "2023-11-19T10:30:00-08:00",
    "midList": [
      {
        "channelCode": "TSYS",
        "channelName": "TSYS",
        "mid": "887000001234567"
      },
      {
        "channelCode": "FISERV",
        "channelName": "Fiserv",
        "mid": "542900008765432"
      }
    ]
  }
}