Merchant List
Retrieves a list of merchants under this PBO (Payment Business Owner).
GET /api/v2/mchInfo
Authorization: Bearer {jwt}Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| mchName | string | false | Merchant name |
| mchId | string | true | Merchant unique ID generated by MineSec system |
Response
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK (opens in a new tab) | OK | Wrapper: Response List<T> Data: Merchant |
Example Response (200)
{
"msg": "SUCCESS",
"code": 0,
"data": {
"total": 10,
"current": 1,
"hasNext": false,
"records": [
{
"mchName": "Coffee Shop",
"mchId": "M-12345678",
"providerReference": "MID180045210008",
"contactName": "John Smith",
"contactEmail": "john@coffeeshop.com",
"contactAddress": "123 Main St, Springfield",
"contactPhone": "555-1234",
"mcc": "5811",
"activated": true,
"timeZone": "Asia/Singapore",
"supportedPaymentMethods": [
{
"paymentMethod": "VISA",
"mchId": "M-12345678",
"profileId": 316
},
{
"paymentMethod": "MASTERCARD",
"mchId": "M-12345678",
"profileId": 316
}
],
"extParams": {
"acqMid": "1234567850001",
"acqTid": "0001252001"
}
}
]
}
}Create Merchant
Creates a new merchant with the provided information.
POST /api/v2/mchInfo
Authorization: Bearer {jwt}Parameters
Response
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK (opens in a new tab) | OK | Wrapper: Response<T> Data: Merchant |
Example Response (200)
{
"msg": "SUCCESS",
"code": 0,
"data": {
"mchName": "Coffee Shop",
"mchId": "M-87654321",
"providerReference": "MID180045210008",
"contactName": "John.Haris",
"contactEmail": "John.Haris@CofeeShop.bz",
"activated": true,
"timeZone": "Asia/HongKong",
"supportedPaymentMethods": [
{
"paymentMethod": "VISA",
"mchId": "M-87654321",
"profileId": 316
},
{
"paymentMethod": "MASTERCARD",
"mchId": "M-87654321",
"profileId": 316
}
]
}
}Get Merchant Details
Retrieves detailed information about a specific merchant.
GET /api/v2/mchInfo/{mchId}
Authorization: Bearer {jwt}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| mchId | path | string | true | Merchant ID |
Response
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK (opens in a new tab) | OK | Wrapper: Response<T> Data: Merchant |
Update Merchant
Updates an existing merchant with the provided information.
PUT /api/v2/mchInfo/{mchId}
Content-Type: application/json
Authorization: Bearer {jwt}Parameters
Response
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK (opens in a new tab) | OK | Wrapper: Response<T> Data: Merchant |