Merchant Management API Specification

Merchant Management API

Get Accepted Payment Types by MID

get /merchant-management/payment-types/mid/{merchantId}

Retrieves the configuration of payment types for a specific merchant by their Merchant ID (MID).

Parameters

merchantId required

Type

string

Minimum Length

Example

111222333444555

Example Response

200 Successfully retrieved payment types.

400 Bad Request - Invalid input data

401 Unauthorized - Error response.

403 Forbidden error response.

500 Internal server error response.

Update Accepted Payment Types by MID

patch /merchant-management/payment-types/mid/{merchantId}

Updates the payment types configuration for a specific merchant by their Merchant ID (MID).

Parameters

merchantId required

Type

string

Minimum Length

Example

111222333444555

Request Schema

amex

Type

object

discover

Type

object

ebt

Type

object

debit

Type

object

Example Request

{
  "amex": {
    "accountType": "R",
    "directAccountNumber": "123"
  },
  "discover": {
    "accountType": "R",
    "directAccountNumber": "1234665"
  },
  "ebt": {
    "ebtFood": true,
    "ebtCash": false,
    "ebtAccountNumber": "12345"
  },
  "debit": {
    "isEnabled": false
  }
}

Example Response

200 Successfully updated payment types.

400 Bad Request - Invalid input data

401 Unauthorized - Error response.

403 Forbidden error response.

422 Unprocessable Entity error response due to validation failures.

500 Internal server error response.