Acquirer Profile - MineSec Developer Docs

API endpoints for managing acquirer profiles.

⚠️

Legacy API — deprecated. This page documents the legacy /api/v2 Acquirer Profile endpoints, kept for existing integrations. New integrations should use the current Acquirer Profile API. Once your PBO group has been switched over to the current Service API, every endpoint on this page — including reads — returns code: 13310 ("Your group has open the multi_acquirers;please use the new Service API") instead of working. See the Service API overview for details.

An acquirer profile represents one connection to a payment host (MID/TID, message format, allowed payment methods, EMV templates).

Get Acquirer Profiles

GET /api/v2/acquirer
Accept: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
profileName	query	string	false	Filter by profile name (partial match)
pageNumber	query	number	false	Default `1`
pageSize	query	number	false	Default `10`; use `-1` to return all profiles on one page

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	Example response	Wrapper: `Response List<T>` Data: AcquirerProfile

Example Response (200)

Example Response - Acquirer Profile List

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "total": 1,
    "current": 1,
    "hasNext": false,
    "records": [
      {
        "profileId": 316,
        "groupId": "G-12345678",
        "profileName": "Visa & Mastercard - US",
        "currency": "USD",
        "connUrl": "https://acquirer-host.example.com/gateway",
        "notifyUrl": "https://your-server.example.com/webhooks/acquirer",
        "connMessageFormat": "MS_ENABLER",
        "connTimeout": 30000,
        "connRequestTimeout": 30000,
        "connRetryCount": 2,
        "connSync": 1,
        "connExtraParams": "{}",
        "methodList": "{\"01\":[],\"02\":[]}",
        "emvList": "{\"01\":[1675],\"02\":[1676]}",
        "createdBy": "[email protected]",
        "createdAt": "2026-05-01T02:12:57+0000",
        "updatedAt": "2026-05-01T02:12:57+0000"
      }
    ]
  }
}

Create Acquirer Profile

Both emvList and methodList are sent as a JSON-encoded string, keyed by PaymentMethod code — only set the keys for payment methods this profile actually accepts. See AcqProfileRequest for the decoded per-payment-method shape.

POST /api/v2/acquirer
Content-Type: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
profileName	body	string	true	Display name for this acquirer profile; must be unique within the PBO
currency	body	string	true	Settlement currency this profile is created for (ISO 4217 code)
connMessageFormat	body	string	true	Host message format used on this connection (e.g. `MS_ENABLER`)
connUrl	body	string	false	Acquirer host endpoint URL
notifyUrl	body	string	false	Callback URL for async notifications from this acquirer
connTimeout	body	number	false	Connection timeout in milliseconds
connRequestTimeout	body	number	false	Request timeout in milliseconds
emvList	body	string	false	JSON-encoded map of EMV config IDs per payment method — see the note above
methodList	body	string	false	JSON-encoded map of allowed entry-mode tags per payment method — see the note above

Request Body Example

Example Request - Create Acquirer Profile

{
  "profileName": "Visa & Mastercard - US",
  "currency": "USD",
  "connMessageFormat": "MS_ENABLER",
  "connUrl": "https://acquirer-host.example.com/gateway",
  "notifyUrl": "https://your-server.example.com/webhooks/acquirer",
  "connTimeout": 30000,
  "connRequestTimeout": 30000,
  "emvList": "{\"01\":[1675],\"02\":[1676]}",
  "methodList": "{\"01\":[],\"02\":[]}"
}

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	Created	Wrapper: `Response<T>` Data: `{ id: number }`
—	`code: 10000`, `"currency invalid"`	`currency` is not a valid ISO 4217 code	—

Example Response (200)

Example Response - Create Acquirer Profile

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "id": 316
  }
}

Update Acquirer Profile

Same fields as Create, all optional — only the fields you include are changed.

PUT /api/v2/acquirer/{profileId}
Content-Type: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
profileId	path	string	true	Acquirer profile ID
profileName	body	string	false	Display name for this acquirer profile
currency	body	string	false	Settlement currency (ISO 4217 code)
connMessageFormat	body	string	false	Host message format used on this connection (e.g. `MS_ENABLER`)
connUrl	body	string	false	Acquirer host endpoint URL
notifyUrl	body	string	false	Callback URL for async notifications from this acquirer
connTimeout	body	number	false	Connection timeout in milliseconds
connRequestTimeout	body	number	false	Request timeout in milliseconds
emvList	body	string	false	JSON-encoded map of EMV config IDs per payment method
methodList	body	string	false	JSON-encoded map of allowed entry-mode tags per payment method

Request Body Example

Example Request - Update Acquirer Profile

{
  "profileName": "Visa & Mastercard - US (primary)",
  "connUrl": "https://acquirer-host-new.example.com/gateway"
}

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	OK	Wrapper: `Response<T>`
—	`code: 10000`, `"not exist"`	`profileId` not found under this PBO	—

Example Response (200)

Example Response - Update Acquirer Profile

{
  "msg": "SUCCESS",
  "code": 0
}

Delete Acquirer Profile

Fails if any merchant is still bound to this profile.

DELETE /api/v2/acquirer/{profileId}
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
profileId	path	string	true	Acquirer profile ID

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	OK	Wrapper: `Response<T>`
—	`code: 10000`, `"Current acquirer used by merchant"`	Merchant(s) still bound to this profile	—

Example Response (200)

Example Response - Delete Acquirer Profile

{
  "msg": "SUCCESS",
  "code": 0
}

EMV Config Merchant