Merchant Add

Onboard a new merchant with a surcharge program configuration under a TSYS processor.

Response — 200 OK

{
  "status": true,
  "message": "User Added Successfully",
  "Mp_id": 140276,
  "newUserId": 194849,
  "StoreID": {
    "154586": [
      "2319977712"
    ]
  },
  "data": "Success"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`User Added Successfully` on success
`Mp_id`	integer	Unique merchant portal ID assigned to the new merchant
`newUserId`	integer	Unique user ID assigned to the new merchant account
`StoreID`	object	Map of store IDs to their associated EPI numbers. Key = store ID, value = array of EPI identifiers
`data`	string	`Success` on success

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Invalid Password",
  "data": "Invalid Password"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message
`data`	string	Mirrors the `message` field

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant created
`false`	Error	Invalid password or missing required fields

Merchant Update

Update the details of an existing merchant account.

Response — 200 OK

{
  "status": true,
  "message": "Merchant Updated Successfully",
  "Mp_id": "140276",
  "newUserId": "194849",
  "StoreID": {
    "154586": [
      "2319977712"
    ]
  },
  "data": "Success"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Merchant Updated Successfully` on success
`Mp_id`	string	Merchant portal ID of the updated merchant
`newUserId`	string	User ID of the updated merchant account
`StoreID`	object	Map of store IDs to their associated EPI numbers
`data`	string	`Success` on success

Note: On update, Mp_id and newUserId are returned as strings rather than integers as in the Add response.

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "The provided epi or id does not correspond to the specified merchant."
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant updated
`false`	Error	EPI or merchant ID does not match the specified merchant

Merchant Delete

Delete an existing merchant account.

Response — 200 OK

{
  "status": true,
  "message": "Success"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "User already deleted or username not found"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant deleted
`false`	Error	Merchant is already deleted or username not found

Merchant View

Retrieve the full configuration details for a merchant, including store and EPI data.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "data": {
    "id": 53109,
    "userId": 83655,
    "parentId": 52323,
    "dbaName": "Valor Store LLC",
    "legalName": "Valor Store",
    "firstName": "MERCHANT",
    "lastName": "PORTAL",
    "ownerName": "Valor ISO LLC",
    "emailId": "[email protected]",
    "mobile": "8327287578",
    "legalAddress": "Test Address",
    "legalCity": "CLIFFSIDE PARK",
    "legalState": "28",
    "selectedState": "28",
    "legalCountry": "US",
    "legalZipCode": "07010",
    "legalTimezone": "EST",
    "logo": "MERCHANT",
    "role": 10,
    "userType": 4,
    "isTxnAllowed": 1,
    "businessType": "10",
    "storeData": [
      {
        "id": 58887,
        "storeName": "EL TRI MX RESTA Add",
        "storeAddress": "4100 JOHNSTON ST",
        "storeCity": "LAFAYETTE",
        "storeState": "16",
        "selectedState": "LA - Louisiana",
        "storeCountry": "US",
        "storeZipCode": "70503",
        "storeTimezone": "EST",
        "superVisorName": "EL TRI MX RESTA",
        "superVisorEmail": "[email protected]",
        "superVisorContact": "3377040344",
        "mccCode": "5812",
        "selectedMCC": "5812 - EATING PLACES-RESTAURANTS",
        "epiData": [
          {
            "id": 93807,
            "epi": "2319936375",
            "device": 139,
            "deviceType": "Soft Pos",
            "processor": 1,
            "epiLabel": "Virtual Terminal",
            "features": {
              "tip": { "enabled": false, "value": [5, 10, 15, 20] },
              "surcharge": { "enabled": false, "value": "4.00" },
              "tax": { "enabled": false, "value": "0" }
            },
            "last_txn_date": null,
            "serialNoLockStatus": 0,
            "app_download": 1,
            "param_download": 1,
            "assigned_app_version": "1.0.0",
            "valorConnect": "0",
            "processorData": [
              {
                "mid": "887000003193",
                "vNumber": "75021674",
                "storeNo": "5999",
                "termNo": "1515",
                "association": "949006",
                "chain": "111111",
                "agent": "0001",
                "binnumber": "999991",
                "agentBank": "000000",
                "industry": "Retail",
                "EBTcash": 0,
                "EBTfood": 0,
                "surchargeIndicator": 1,
                "surchargePercentage": "4.00",
                "label": "MERCHANT PORTAL LOGIN",
                "programType": "surcharge",
                "vendor": 2,
                "status": 1,
                "app_key": "yPmCz8MMnO*******y7d7G2GVc4",
                "auth_token": "jQGF6gvGxw*******Ep0FkXcd",
                "name_on_account": "Abu",
                "id": 95943
              }
            ]
          }
        ]
      }
    ]
  }
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`data`	object	Full merchant details object

`data` — merchant fields

Field	Type	Description
`id`	integer	Internal merchant record ID
`userId`	integer	Merchant's user account ID
`parentId`	integer	Parent ISO or sub-ISO user ID
`dbaName`	string	Merchant doing-business-as name
`legalName`	string	Merchant legal entity name
`firstName`	string	First name on the merchant account
`lastName`	string	Last name on the merchant account
`ownerName`	string	Name of the owning ISO
`emailId`	string	Merchant contact email
`mobile`	string	Merchant contact phone number
`legalAddress`	string	Merchant legal street address
`legalCity`	string	Merchant legal city
`legalState`	string	Merchant legal state code
`legalCountry`	string	Merchant legal country code (e.g. `US`)
`legalZipCode`	string	Merchant legal ZIP code
`legalTimezone`	string	Merchant timezone (e.g. `EST`)
`role`	integer	Role identifier
`userType`	integer	User type identifier
`isTxnAllowed`	integer	`1` if transactions are permitted; `0` otherwise
`businessType`	string	Business type code
`storeData`	array	Array of store objects (see below)

`storeData` — store fields

Field	Type	Description
`id`	integer	Internal store record ID
`storeName`	string	Store name
`storeAddress`	string	Store street address
`storeCity`	string	Store city
`storeState`	string	Store state code
`selectedState`	string	State label (e.g. `LA - Louisiana`)
`storeCountry`	string	Store country code
`storeZipCode`	string	Store ZIP code
`storeTimezone`	string	Store timezone
`superVisorName`	string	Supervisor or DBA name for the store
`superVisorEmail`	string	Supervisor email address
`superVisorContact`	string	Supervisor contact number
`mccCode`	string	Merchant category code
`selectedMCC`	string	MCC with description (e.g. `5812 - EATING PLACES-RESTAURANTS`)
`epiData`	array	Array of EPI (terminal) objects (see below)

`epiData` — EPI / terminal fields

Field	Type	Description
`id`	integer	Internal EPI record ID
`epi`	string	Terminal EPI identifier
`device`	integer	Device model code
`deviceType`	string	Device type description (e.g. `Soft Pos`)
`processor`	integer	Processor identifier
`epiLabel`	string	Terminal display label
`features.tip.enabled`	boolean	`true` if tip collection is enabled
`features.tip.value`	array	Preset tip percentage options
`features.surcharge.enabled`	boolean	`true` if surcharge is enabled
`features.surcharge.value`	string	Surcharge percentage value
`features.tax.enabled`	boolean	`true` if tax is enabled
`features.tax.value`	string	Tax percentage value
`last_txn_date`	string \| null	Date of the last transaction on this terminal
`serialNoLockStatus`	integer	`1` if serial number lock is active; `0` otherwise
`app_download`	integer	`1` if app download is enabled
`param_download`	integer	`1` if parameter download is enabled
`assigned_app_version`	string	Currently assigned app version
`valorConnect`	string	ValorConnect status flag
`processorData`	array	Array of processor configuration objects (see below)

`processorData` — processor configuration fields

Field	Type	Description
`mid`	string	Merchant ID
`vNumber`	string	Terminal ID (V-number)
`storeNo`	string	Store number
`termNo`	string	Terminal number
`association`	string	Association number
`chain`	string	Chain number
`agent`	string	Agent number
`binnumber`	string	BIN number
`agentBank`	string	Agent bank number
`industry`	string	Industry type (e.g. `Retail`)
`EBTcash`	integer	`1` if EBT cash is enabled; `0` otherwise
`EBTfood`	integer	`1` if EBT food is enabled; `0` otherwise
`EbtNo`	string	EBT number, if applicable
`surchargeIndicator`	integer	`1` if surcharge is enabled; `0` otherwise
`surchargePercentage`	string	Surcharge percentage rate
`label`	string	Terminal label
`programType`	string	Processing program type (e.g. `surcharge`, `traditional`)
`vendor`	integer	Vendor identifier
`status`	integer	`1` if active; `0` if inactive
`app_key`	string	Partially masked App Key for this terminal
`auth_token`	string	Partially masked authentication token
`name_on_account`	string	Name on the merchant account
`id`	integer	Internal processor record ID

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Please Enter Mp_id or Epi_id"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant details returned
`false`	Error	Neither `Mp_id` nor `Epi_id` was provided in the request

Merchant Status

Update the active or inactive status of a merchant account.

Response — 200 OK

{
  "status": true,
  "message": "Success"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success

Response — 400 (Validation Error)

{
  "status": false,
  "message": "merchantIds is not iterable"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant status updated
`false`	Error	`merchantIds` parameter is missing or not provided as an iterable value

Merchant List

Retrieve a paginated list of merchants under an ISO or sub-ISO account.

Response — 200 OK

{
  "code": 200,
  "status": "OK",
  "message": "SUCCESS",
  "data": [
    {
      "DEVICE_COUNT": 1,
      "MTD_VOLUME": 0,
      "STORE_COUNT": 1,
      "PROCESSOR_LIST": "1",
      "LAST_TXN_DATE": null,
      "USER_ID": 52331,
      "USER_TYPE": 4,
      "PARENT_ID": 52323,
      "UPDATED_DATE": "2026-04-27T10:05:08.000Z",
      "MERCHANT_NAME": "MERCHANT PORTAL",
      "ROLE_ID": 10,
      "MOBILE_NO": "8327287578",
      "EMAIL_ID": "[email protected]",
      "STATUS": 1,
      "CREATED_DATE": "2024-05-02T06:52:13.000Z",
      "DBA_NAME": "Valor Store LLC",
      "MP_ID": 29162,
      "CRM_BOARDING": 1,
      "SUBISO_NAME": null,
      "ISO_NAME": "Valor ISO LLC",
      "BOARDED_ON": "05/02/24 02:52 AM (EST)"
    }
  ],
  "number_of_records": 1,
  "page_number": 1,
  "total_pages": 923,
  "total_count": 923,
  "page_size": 1
}

Response fields — top level

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`OK` on success
`message`	string	`SUCCESS` on success
`data`	array	Array of merchant summary objects
`number_of_records`	integer	Number of records returned on this page
`page_number`	integer	Current page number
`total_pages`	integer	Total number of pages available
`total_count`	integer	Total number of merchants
`page_size`	integer	Number of records per page

`data` — merchant summary fields

Field	Type	Description
`DEVICE_COUNT`	integer	Number of terminals (EPIs) assigned to this merchant
`MTD_VOLUME`	number	Month-to-date transaction volume in cents
`STORE_COUNT`	integer	Number of stores under this merchant
`PROCESSOR_LIST`	string	Comma-separated list of processor IDs assigned
`LAST_TXN_DATE`	string \| null	Date of the most recent transaction; `null` if none
`USER_ID`	integer	User account ID
`USER_TYPE`	integer	User type identifier
`PARENT_ID`	integer	Parent ISO user ID
`UPDATED_DATE`	string	Last updated timestamp (ISO 8601)
`MERCHANT_NAME`	string	Merchant account name
`ROLE_ID`	integer	Role identifier
`MOBILE_NO`	string	Merchant contact phone number
`EMAIL_ID`	string	Merchant contact email
`STATUS`	integer	`1` if active; `0` if inactive
`CREATED_DATE`	string	Account creation timestamp (ISO 8601)
`DBA_NAME`	string	Merchant doing-business-as name
`MP_ID`	integer	Merchant portal ID
`CRM_BOARDING`	integer	`1` if boarded via CRM; `0` otherwise
`SUBISO_NAME`	string \| null	Sub-ISO name, if applicable
`ISO_NAME`	string	ISO name
`BOARDED_ON`	string	Boarding timestamp in `MM/DD/YY HH:MM AM/PM (TZ)` format

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Invalid User",
  "data": "Invalid User"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when authentication fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	rror message
`data`	string	Mirrors the `message` field

Error code reference

`status`	Meaning	Typical cause
`OK`	Success	Merchant list returned
`false`	Authentication error	User credentials are invalid

Store Add

Add a new store to an existing merchant account.

Response — 200 OK

{
  "status": true,
  "message": "Merchant Store Updated Successfully",
  "Mp_id": "140276",
  "newUserId": "194849",
  "StoreID": {
    "154592": [
      "2319977714"
    ]
  },
  "data": "Success"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Merchant Store Updated Successfully` on success
`Mp_id`	string	Merchant portal ID
`newUserId`	string	User ID of the merchant
`StoreID`	object	Map of the new store ID to its associated EPI numbers
`data`	string	`Success` on success

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Invalid Password",
  "data": "Invalid Password"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message
`data`	string	Mirrors the `message` field

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Store created and added to the merchant
`false`	Error	Invalid password or missing required fields

Store Delete

Remove a store from an existing merchant account.

Response — 200 OK

{
  "status": true,
  "message": "Deleted Sucessfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Deleted Sucessfully` on success

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "This merchant does not belong to this ISO"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Store deleted
`false`	Error	Merchant does not belong to the requesting ISO

Copy Parameter API

Copy device parameters from one terminal (EPI) to another.

Response — 200 OK

{
  "code": 200,
  "status": "OK",
  "message": "SUCCESS"
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`OK` on success
`message`	string	`SUCCESS` on success

Response — 400 (Validation Error)

{
  "code": 400,
  "status": "FAILED",
  "errors": "The given EPI has been wrong."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request cannot be processed
`errors`	string	Error message describing the reason for failure

Error code reference

`status`	Meaning	Typical cause
`OK`	Success	Parameters copied to the target EPI
`FAILED`	Error	Source or target EPI is invalid

Fetch APP ID & APP Keys

Retrieve the App ID and App Keys associated with a merchant's terminals.

Response — 200 OK

{
  "code": 200,
  "status": "OK",
  "message": "SUCCESS",
  "data": {
    "APP_ID": "Vw7RdW******iqeahSonN",
    "devices": [
      {
        "EPI": "2319916062",
        "DEVICE_NAME": "VT #4",
        "DEVICE_TYPE": "Virtual Terminal",
        "APP_KEY": "Tv26Mi******2XwQE58jU"
      }
    ]
  }
}

Response fields — top level

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`OK` on success
`message`	string	`SUCCESS` on success
`data`	object	App credentials object

`data` fields

Field	Type	Description
`APP_ID`	string	Partially masked App ID shared across all terminals for this merchant
`devices`	array	Array of device credential objects

`devices` — device credential fields

Field	Type	Description
`EPI`	string	Terminal EPI identifier
`DEVICE_NAME`	string	Terminal display name (e.g. `VT #4`)
`DEVICE_TYPE`	string	Terminal type (e.g. `Virtual Terminal`)
`APP_KEY`	string	Partially masked App Key unique to this terminal

Response — 400 (Validation Error)

{
  "code": 400,
  "status": "FAILED",
  "errors": "APP ID does not exist. Please generate an APP ID from the Valor Portal."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request cannot be processed
`errors`	string	Error message describing the reason for failure

Error code reference

`status`	Meaning	Typical cause
`OK`	Success	App ID and App Keys returned
`FAILED`	Error	App ID has not yet been generated — create one in the Valor Portal first

EPI Add

Add a new terminal (EPI) to an existing merchant store.

Response — 200 OK

{
  "status": true,
  "message": "Merchant EPI Updated Successfully",
  "Mp_id": "140279",
  "newUserId": "194852",
  "StoreID": {
    "154595": [
      "2319977717"
    ]
  },
  "data": "Success"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Merchant EPI Updated Successfully` on success
`Mp_id`	string	Merchant portal ID
`newUserId`	string	User ID of the merchant
`StoreID`	object	Map of the store ID to the newly added EPI numbers
`data`	string	`Success` on success

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Invalid Password",
  "data": "Invalid Password"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message
`data`	string	Mirrors the `message` field

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI added to the merchant store
`false`	Error	Invalid password or missing required fields

EPI Status Update

Update the active or inactive status of a terminal (EPI).

Response — 200 OK (Already Active)

Returned when the EPI is already in the requested status state.

{
  "status": true,
  "message": "Success",
  "data": "Device is already in active status."
}

Response — 200 OK (Merchant Inactive)

Returned when the EPI status cannot be changed because the parent merchant is inactive.

{
  "status": true,
  "message": "Success",
  "data": "Merchant is In-Active. Could not update the EPI."
}

Response fields

Field	Type	Description
`status`	boolean	`true` for both informational states
`message`	string	`Success` on both
`data`	string	Informational message describing the current state or reason the update was not applied

Note: Both responses return status: true. Use the data field to determine whether the status was actually changed or if a blocking condition was encountered.

Error code reference

`data` value	Meaning
`Device is already in active status.`	EPI is already in the requested state; no change made
`Merchant is In-Active. Could not update the EPI.`	Parent merchant is inactive; EPI status cannot be updated

EPI Delete

Delete a terminal (EPI) from a merchant account.

Response — 200 OK (Deleted)

{
  "status": true,
  "message": "EPI Deleted Successfully"
}

Response — 200 OK (Already Deleted)

{
  "status": true,
  "message": "EPI ALREADY DELETED"
}

Response fields

Field	Type	Description
`status`	boolean	`true` for both states
`message`	string	Outcome message — either `EPI Deleted Successfully` or `EPI ALREADY DELETED`

Note: Both responses return status: true. Check message to determine whether the deletion was newly applied or the EPI was already in a deleted state.

Error code reference

`message`	Meaning
`EPI Deleted Successfully`	EPI was active and has now been deleted
`EPI ALREADY DELETED`	EPI was already in a deleted state

EPI View

Retrieve the full configuration details for a specific terminal (EPI), including store and processor data.

Response — 200 OK

The response schema for EPI View is identical to Merchant View. Refer to the Merchant View field reference for full field descriptions.

{
  "status": true,
  "message": "Success",
  "data": {
    "id": 53109,
    "userId": 83655,
    "dbaName": "Valor Store LLC",
    "storeData": [
      {
        "epiData": [
          {
            "epi": "2319936375",
            "epiLabel": "Virtual Terminal",
            "processorData": [
              {
                "mid": "887000003193",
                "surchargeIndicator": 1,
                "surchargePercentage": "4.00",
                "app_key": "yPmCz8MMn*******d7G2GVc4",
                "auth_token": "jQGF6gvGxw6*******p0FkXcd"
              }
            ]
          }
        ]
      }
    ]
  }
}

Response — 400 (Validation Error)

{
  "status": false,
  "message": "Login User Not Belongs to this Mp_Id",
  "data": {
    "message": "Login User Not Belongs to this Mp_Id"
  }
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`message`	string	Error message
`data`	object	Contains a nested `message` field mirroring the top-level message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI details returned
`false`	Error	The authenticated user does not have access to the specified `Mp_Id`

EPI Status

Retrieve the current activation status of a terminal (EPI).

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "data": "Device Already In Active Status"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`data`	string	Description of the current EPI status

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Invalid Password",
  "data": "Invalid Password"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message
`data`	string	Mirrors the `message` field

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI status returned
`false`	Error	Invalid password or authentication failure

EPI — Generate API Keys

Generate or retrieve the App ID and App Key for a specific terminal (EPI).

Response — 200 OK

{
  "code": 200,
  "status": "OK",
  "message": "App Key already associated with EPI",
  "data": {
    "epi": "2412333540",
    "Mp_Id": 29156,
    "UserId": 52326,
    "device_model": "Virtual Terminal",
    "device_name": "VT #2",
    "appkey": "zOKj0LU*******xQEpSMm",
    "appid": "h6tSvf0C*******15AsWYo"
  }
}

Response fields — top level

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`OK` on success
`message`	string	Informational message (e.g. `App Key already associated with EPI` if keys already existed)
`data`	object	API key details object

`data` fields

Field	Type	Description
`epi`	string	Terminal EPI identifier
`Mp_Id`	integer	Merchant portal ID
`UserId`	integer	User ID of the merchant
`device_model`	string	Device model description (e.g. `Virtual Terminal`)
`device_name`	string	Terminal display name (e.g. `VT #2`)
`appkey`	string	Partially masked App Key for this terminal
`appid`	string	Partially masked App ID for this merchant

Response — 400 (Validation Error)

{
  "code": 400,
  "status": "FAILED",
  "errors": "Invalid EPI."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request cannot be processed
`errors`	string	Error message describing the reason for failure

Error code reference

`status`	Meaning	Typical cause
`OK`	Success	API keys generated or retrieved
`FAILED`	Error	EPI is invalid or not found

EPI Detail

Retrieve the processor parameters and configuration details for a specific terminal (EPI).

Response — 200 OK

{
  "status": true,
  "code": "200",
  "Mp_id": 29156,
  "StoreID": 33168,
  "epi": "2412333540",
  "SerialNo": null,
  "processor_params": {
    "mid": "887000003193",
    "vNumber": "75021674",
    "storeNo": "5999",
    "termNo": "1515",
    "binnumber": "999991",
    "industry": "Retail",
    "agentBank": "000000",
    "chain": "111111",
    "agent": "0001",
    "EBTcash": 0,
    "EBTfood": 0,
    "EbtNo": "",
    "surchargeIndicator": 1,
    "surchargePercentage": "2.00",
    "mid1": "",
    "vNumber1": "",
    "storeNo1": "",
    "termNo1": "",
    "binnumber1": "",
    "industry1": "",
    "agentBank1": "",
    "chain1": "",
    "agent1": "",
    "EBTcash1": 0,
    "EBTfood1": 0,
    "EbtNo1": "",
    "vendor": 2,
    "client_id": "0",
    "status": 1,
    "app_key": "yPmCz8MMnO*******7d7G2GVc4",
    "auth_token": "jQGF6gvG*******p0FkXcd",
    "name_on_account": "Abu"
  },
  "message": "epi Data Exits",
  "StatusUser": 1
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`code`	string	HTTP status code as a string (`"200"`)
`Mp_id`	integer	Merchant portal ID
`StoreID`	integer	Store ID this EPI belongs to
`epi`	string	Terminal EPI identifier
`SerialNo`	string \| null	Device serial number; `null` for virtual terminals
`processor_params`	object	Processor configuration parameters (see below)
`message`	string	`epi Data Exits` on success
`StatusUser`	integer	`1` if the user/merchant is active; `0` otherwise

`processor_params` fields

Field	Type	Description
`mid`	string	Primary merchant ID
`vNumber`	string	Primary terminal ID (V-number)
`storeNo`	string	Primary store number
`termNo`	string	Primary terminal number
`binnumber`	string	Primary BIN number
`industry`	string	Industry type (e.g. `Retail`)
`agentBank`	string	Agent bank number
`chain`	string	Chain number
`agent`	string	Agent number
`EBTcash`	integer	`1` if EBT cash is enabled; `0` otherwise
`EBTfood`	integer	`1` if EBT food is enabled; `0` otherwise
`EbtNo`	string	EBT number, if applicable
`surchargeIndicator`	integer	`1` if surcharge is enabled; `0` otherwise
`surchargePercentage`	string	Surcharge percentage rate
`mid1`	string	Secondary merchant ID, if applicable
`vNumber1`	string	Secondary terminal ID, if applicable
`vendor`	integer	Vendor identifier
`client_id`	string	Client ID
`status`	integer	`1` if active; `0` if inactive
`app_key`	string	Partially masked App Key
`auth_token`	string	Partially masked authentication token
`name_on_account`	string	Name on the merchant account

Response — 400 (Validation Error)

{
  "status": false,
  "message": "This epi does not belong to this iso"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI detail returned
`false`	Error	EPI does not belong to the requesting ISO

EPI Txn Date

Retrieve transaction volume statistics and date information for a specific terminal (EPI).

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "data": [
    {
      "MTD_VOLUME": "18354.53",
      "LTD_VOLUME": "16883214.00",
      "last_txn_date": "2026-04-25",
      "first_txn_Date": "2024-05-06"
    }
  ],
  "epi_status": [
    {
      "is_deleted": 0,
      "status": 1
    }
  ]
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`data`	array	Array containing transaction volume statistics
`epi_status`	array	Array containing the current EPI status flags

`data` fields

Field	Type	Description
`MTD_VOLUME`	string	Month-to-date transaction volume in decimal format
`LTD_VOLUME`	string	Lifetime-to-date transaction volume in decimal format
`last_txn_date`	string	Date of the most recent transaction in `YYYY-MM-DD` format
`first_txn_Date`	string	Date of the first transaction in `YYYY-MM-DD` format

`epi_status` fields

Field	Type	Description
`is_deleted`	integer	`1` if the EPI is deleted; `0` otherwise
`status`	integer	`1` if the EPI is active; `0` if inactive

Response — 400 (No Records)

{
  "status": false,
  "message": "No Record Found",
  "data": []
}

Response fields

Field	Type	Description
`status`	boolean	`false` when no records are found
`message`	string	`No Record Found`
`data`	array	Empty array

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Transaction statistics returned
`false`	Not found	No transaction records exist for this EPI

Check EPI

Verify that a terminal (EPI) exists and retrieve its full configuration details.

Response — 200 OK

{
  "status": true,
  "code": "200",
  "Mp_id": 29156,
  "newUserId": 52326,
  "StoreID": 33168,
  "epi": "2412333540",
  "SerialNo": null,
  "processor_params": {
    "mid": "887000003193",
    "vNumber": "75021674",
    "surchargeIndicator": 1,
    "surchargePercentage": "2.00",
    "app_key": "yPmCz8********7G2GVc4",
    "auth_token": "jQGF6gv********IV3Ep0FkXcd",
    "name_on_account": "Abu"
  },
  "optStatus": 1,
  "statusEpi": 1,
  "createdDate": "2024-05-02",
  "createdBy": 52323,
  "isDeleted": 0,
  "deletedOn": null,
  "deletedBy": null
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`code`	string	HTTP status code as a string (`"200"`)
`Mp_id`	integer	Merchant portal ID
`newUserId`	integer	User ID of the merchant
`StoreID`	integer	Store ID this EPI belongs to
`epi`	string	Terminal EPI identifier
`SerialNo`	string \| null	Device serial number; `null` for virtual terminals
`processor_params`	object	Processor configuration (see EPI Detail for full field reference)
`optStatus`	integer	Optional feature status flag
`statusEpi`	integer	`1` if the EPI is active; `0` if inactive
`createdDate`	string	EPI creation date in `YYYY-MM-DD` format
`createdBy`	integer	User ID of the account that created this EPI
`isDeleted`	integer	`1` if deleted; `0` otherwise
`deletedOn`	string \| null	Deletion timestamp; `null` if not deleted
`deletedBy`	integer \| null	User ID of the account that deleted this EPI; `null` if not deleted

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "epi Data Not Exits"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI found and details returned
`false`	Error	EPI does not exist

Credential

Validate a user's credentials and retrieve their user ID.

Response — 200 OK

{
  "status": true,
  "code": "200",
  "UserId": 4389
}

Response fields

Field	Type	Description
`status`	boolean	`true` on successful authentication
`code`	string	HTTP status code as a string (`"200"`)
`UserId`	integer	Authenticated user's unique ID

Response — 400 (Validation Error)

{
  "status": false,
  "code": "400",
  "message": "Invalid User",
  "data": "Invalid User"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when authentication fails
`code`	string	HTTP status code as a string (`"400"`)
`message`	string	Error message
`data`	string	Mirrors the `message` field

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Credentials valid; user ID returned
`false`	Error	Username or password is invalid

EPI Deactivate

Deactivate a terminal (EPI) to prevent it from processing transactions.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "data": "Merchant is In-Active. Could not update the EPI."
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`data`	string	Informational message about the deactivation outcome

Note: A status: true response with a data message of "Merchant is In-Active. Could not update the EPI." indicates that the parent merchant is already inactive and the EPI state could not be changed. Check data to confirm the deactivation was applied.

Response — 400 (Validation Error)

{
  "status": false,
  "message": "This epi does not belong to this ISO"
}

Response fields

Field	Type	Description
`status`	boolean	`false` when the request fails
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success (or blocked)	EPI deactivated, or parent merchant is already inactive
`false`	Error	EPI does not belong to the requesting ISO

Device Parameter API

Push updated device parameters to a terminal.

Response — 200 OK

{
  "code": 200,
  "status": "OK",
  "message": "SUCCESS"
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`OK` on success
`message`	string	`SUCCESS` on success

Response — 400 (Validation Error)

{
  "code": 400,
  "status": "FAILED",
  "errors": "The 'descriptor_enabled' depends on the 'generate_pay_now_link'."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request cannot be processed
`errors`	string	Error message describing the dependency or validation failure

Error code reference

`status`	Meaning	Typical cause
`OK`	Success	Device parameters updated
`FAILED`	Validation error	`descriptor_enabled` requires `generate_pay_now_link` to be set first

Merchant Add

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Merchant Update

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Merchant Delete

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Merchant View

Response — 200 OK

Response fields — top level

data — merchant fields

storeData — store fields

epiData — EPI / terminal fields

processorData — processor configuration fields

Response — 400 (Validation Error)

Response fields

Error code reference

Merchant Status

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Merchant List

Response — 200 OK

Response fields — top level

data — merchant summary fields

Response — 400 (Validation Error)

Response fields

Error code reference

Store Add

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Store Delete

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Copy Parameter API

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Fetch APP ID & APP Keys

Response — 200 OK

Response fields — top level

data fields

devices — device credential fields

Response — 400 (Validation Error)

Response fields

Error code reference

EPI Add

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

EPI Status Update

Response — 200 OK (Already Active)

Response — 200 OK (Merchant Inactive)

Response fields

Error code reference

EPI Delete

Response — 200 OK (Deleted)

`data` — merchant fields

`storeData` — store fields

`epiData` — EPI / terminal fields

`processorData` — processor configuration fields

`data` — merchant summary fields

`data` fields

`devices` — device credential fields

`data` fields

`processor_params` fields

`data` fields

`epi_status` fields