Merchant — Create Bearer Token

Authenticate and obtain a JWT bearer token for use in subsequent API requests.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "UserId": 52323,
  "userType_id": 2,
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9***********9PIJ4cUlOTR75Sd8hGMIQ"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`UserId`	integer	Authenticated user's unique ID
`userType_id`	integer	User type identifier
`access_token`	string	JWT bearer token. Include in the `Authorization: Bearer <token>` header for subsequent requests

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Could not find the account"
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	boolean	`false` when authentication fails
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Bearer token issued
`false`	Error	Account not found or invalid credentials

Merchant Add

Onboard a new merchant account.

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 ID to associated EPI numbers. Key = store ID, value = array of EPI identifiers
`data`	string	`Success` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "User Name already exist"
}

Response fields

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

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant created
`false`	Error	Username already exists

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
`newUserId`	string	User ID of the merchant
`StoreID`	object	Map of store ID to associated EPI numbers
`data`	string	`Success` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "The store is not associated with the merchants under this ISO"
}

Response fields

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

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant updated
`false`	Error	Store does not belong to a merchant under this ISO

Merchant Delete

Delete an existing merchant account.

Response — 200 OK

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

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Given merchant is already deleted"
}

Response fields

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

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant deleted
`false`	Error	Merchant is already deleted

Merchant Get Details

Retrieve a summary of the EPIs and program types associated with a merchant.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "data": [
    {
      "epi": "2319970727",
      "programType": "Surcharge"
    }
  ]
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`data`	array	Array of EPI summary objects

`data` fields

Field	Type	Description
`epi`	string	Terminal EPI identifier
`programType`	string	Processing program type assigned to this terminal (e.g. `Surcharge`, `Traditional`)

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Please Enter UserId"
}

Response fields

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

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant EPI details returned
`false`	Error	`UserId` parameter is missing from the request

Merchant Operator — Create

Create an operator user account under an existing merchant.

Response — 200 OK

{
  "status": 1,
  "message": "Success",
  "code": 200,
  "status_desc": "User has been created sucessfully UserID: 194876"
}

Response fields

Field	Type	Description
`status`	integer	`1` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`status_desc`	string	Detailed confirmation message including the new user ID

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Merchant not found"
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request fails
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`1`	Success	Merchant operator created
`FAILED`	Error	Merchant not found for the provided ID

Sub-ISO Operator — Create

Create an operator user account under an existing Sub-ISO.

Response — 200 OK

{
  "status": 1,
  "message": "Success",
  "code": 200,
  "status_desc": "Sub ISO operator Boarding successfull."
}

Response fields

Field	Type	Description
`status`	integer	`1` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`status_desc`	string	Detailed confirmation message

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid Sub ISO username."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request fails
`message`	string	Error message

Error code reference

`status`	Meaning	Typical cause
`1`	Success	Sub-ISO operator created
`FAILED`	Error	Sub-ISO username is invalid or not found

Merchant Status

Activate or deactivate one or more merchant accounts.

Response — 200 OK (Success)

{
  "status": true,
  "message": "Status update completed successfully.",
  "code": 200,
  "updatedMerchants": [
    29156
  ],
  "erroredMerchants": []
}

Response — 400 (Partial or Full Failure)

{
  "status": false,
  "message": "Status update failed for all merchants.",
  "code": 400,
  "updatedMerchants": [],
  "erroredMerchants": [
    {
      "statustag": "Pending",
      "merchantId": [
        29159
      ],
      "error": "Merchant is pending. Please activate in the Valor portal"
    }
  ]
}

Response fields

Field	Type	Description
`status`	boolean	`true` if all updates succeeded; `false` if any or all failed
`message`	string	Summary of the update result
`code`	integer	`200` on success; `400` on failure
`updatedMerchants`	array	List of merchant IDs that were successfully updated
`erroredMerchants`	array	List of error objects for merchants that could not be updated (see below)

`erroredMerchants` object fields

Field	Type	Description
`statustag`	string	Current status of the merchant that prevented the update (e.g. `Pending`)
`merchantId`	array	List of merchant IDs that failed
`error`	string	Reason for the failure

Note: A code: 400 response may still include successfully updated merchants in updatedMerchants if only some of the submitted merchants failed.

Error code reference

`status`	Meaning	Typical cause
`true`	Success	All merchant statuses updated
`false`	Partial/full failure	One or more merchants are in `Pending` status and cannot be activated via API

Merchant View

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

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {
    "id": 43919,
    "userId": 72239,
    "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",
    "legalCountry": "US",
    "legalZipCode": "07010",
    "legalTimezone": "EST",
    "role": 10,
    "userType": 4,
    "isTxnAllowed": 1,
    "businessType": "Direct Marketing",
    "sicCode": "7230 - Beauty and Barber",
    "storeData": [
      {
        "id": 48779,
        "storeName": "Test Store",
        "mccCode": "0742",
        "selectedMCC": "0742 - VETERINARY SERVICES",
        "epiData": [
          {
            "id": 78818,
            "epi": "2319931361",
            "epiLabel": "Virtual Terminal",
            "processorData": [
              {
                "mid": "887000003193",
                "surchargeIndicator": 0,
                "surchargePercentage": "4.00",
                "programType": "surcharge",
                "app_key": "yPmCz8*******d7G2GVc4",
                "auth_token": "jQGF*******0FkXcd"
              }
            ]
          }
        ]
      }
    ]
  }
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`data`	object	Full merchant details. See the Merchant View field reference in the ISO API section for the complete schema

Note: This endpoint returns the same data schema as the ISO Merchant View. Additional fields present in this bearer-auth version include businessType and sicCode.

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid epi_id"
}

Response fields

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

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant details returned
`false`	Error	EPI ID is invalid

Merchant List

Retrieve a paginated list of merchants under an ISO.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": [
    {
      "DEVICE_COUNT": 5,
      "MTD_VOLUME": "1841311",
      "STORE_COUNT": 1,
      "PROCESSOR_LIST": "1,2,4",
      "LAST_TXN_DATE": "2026-04-28 02:44:27",
      "USER_ID": 52326,
      "USER_TYPE": 4,
      "PARENT_ID": 52323,
      "UPDATED_DATE": "2026-04-28 06:45:06",
      "MERCHANT_NAME": "MERCHANT PORTAL",
      "ROLE_ID": 10,
      "MOBILE_NO": "8327287578",
      "EMAIL_ID": "ra******.com",
      "STATUS": 0,
      "CREATED_DATE": "2024-05-02 05:14:18",
      "DBA_NAME": "Valor Store LLC",
      "MP_ID": 29156,
      "CRM_BOARDING": 0,
      "SUBISO_NAME": null,
      "ISO_NAME": "Valor ISO LLC",
      "BOARDED_ON": "05/02/24 01:14 AM (EST)"
    }
  ],
  "number_of_records": 1,
  "page_number": 1,
  "total_pages": 925,
  "total_results": 925,
  "page_size": 1
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`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
`total_results`	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
`MTD_VOLUME`	string	Month-to-date transaction volume in cents
`STORE_COUNT`	integer	Number of stores
`PROCESSOR_LIST`	string	Comma-separated list of processor IDs
`LAST_TXN_DATE`	string \| null	Most recent transaction timestamp
`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
`MERCHANT_NAME`	string	Merchant account name
`ROLE_ID`	integer	Role identifier
`MOBILE_NO`	string	Contact phone number
`EMAIL_ID`	string	Contact email (may be partially masked)
`STATUS`	integer	`1` if active; `0` if inactive
`CREATED_DATE`	string	Account creation timestamp
`DBA_NAME`	string	Doing-business-as name
`MP_ID`	integer	Merchant portal ID
`CRM_BOARDING`	integer	`1` if boarded via CRM
`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 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid user_id"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant list returned
`false`	Error	`user_id` is invalid

Copy Parameter API

Copy device parameters from one terminal to another.

Response — 200 OK

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

Response fields

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

Response — 400 (Error)

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

Error code reference

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

Store Add

Add a new store to an existing merchant.

Response — 200 OK

{
  "status": true,
  "message": "Merchant Store Created Successfully",
  "Mp_id": "43919",
  "newUserId": "72239",
  "StoreID": {
    "154628": [
      "2319977735"
    ]
  },
  "data": "Success"
}

Response fields

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

Response — 400 (Validation Error)

{
  "status": "Validation Failed",
  "message": [
    "newUserId Required"
  ],
  "code": 400
}

Response fields

Field	Type	Description
`status`	string	`Validation Failed` when required fields are missing
`message`	array	List of validation error messages
`code`	integer	HTTP status code (`400`)

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Store created
`Validation Failed`	Error	Required field `newUserId` missing from the request

Create Ticket

Submit a new support ticket for a terminal.

Response — 200 OK

{
  "status": true,
  "message": "Ticket Created Successfully",
  "code": 200
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Ticket Created Successfully` on success
`code`	integer	HTTP status code (`200`)

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Unknown Epi"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Ticket created
`false`	Error	EPI not found or unrecognised

Update Ticket — ISO

Update an existing support ticket as an ISO user.

Response — 200 OK

{
  "code": 200,
  "status": true,
  "message": "Ticket Updated Successfully."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	boolean	`true` on success
`message`	string	`Ticket Updated Successfully.` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "You are not authorized to update tickets."
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Ticket updated
`false`	Error	Authenticated user does not have permission to update this ticket

View Ticket

Retrieve support ticket records and available ticket subjects for a terminal.

Response — 200 OK

{
  "message": "success",
  "data": {
    "subjects": [
      { "id": 1, "subject": "HARDWARE", "send_to": "HELPDESK", "created_on": "2020-07-24 07:32:27" },
      { "id": 2, "subject": "TRANSACTION", "send_to": "HELPDESK", "created_on": "2020-07-29 02:56:29" },
      { "id": 4, "subject": "STATEMENT", "send_to": "HELPDESK", "created_on": "2020-07-29 02:56:38" },
      { "id": 6, "subject": "PAYMENT", "send_to": "HELPDESK", "created_on": "2020-07-29 02:57:04" },
      { "id": 8, "subject": "OTHER", "send_to": "ALL", "created_on": "2020-07-29 02:57:10" },
      { "id": 10, "subject": "SALES", "send_to": "SUPPORT", "created_on": "2021-09-22 10:52:57" }
    ],
    "meta": {
      "current_page": 1,
      "total_records": 1,
      "last_page": 1,
      "per_page": 25
    },
    "records": [
      {
        "id": 28285,
        "epi": "2412333540",
        "subject": "SALES",
        "status": "OPEN",
        "description": "Hi there",
        "resolution": null,
        "channel": "CRM",
        "phone": "5247896523",
        "dba_name": "Valor Store LLC",
        "device_type": "Virtual Terminal",
        "created_on": "2025-12-11 13:19:28",
        "created_by_name": "MERCHANT PORTAL",
        "created_at": "12/11/2025 08:19 AM (EST)",
        "total_count": 1,
        "store_id": 33168,
        "mp_id": 29156,
        "last_txn_date": "2026-04-28 02:44:27"
      }
    ]
  }
}

Response fields — top level

Field	Type	Description
`message`	string	`success` on success
`data`	object	Contains ticket subjects, pagination meta, and ticket records

`subjects` — ticket subject fields

Field	Type	Description
`id`	integer	Subject identifier
`subject`	string	Subject category name (e.g. `HARDWARE`, `TRANSACTION`)
`send_to`	string	Routing destination (e.g. `HELPDESK`, `SUPPORT`, `ALL`)
`created_on`	string	Subject creation timestamp

`meta` object

Field	Type	Description
`current_page`	integer	Current page number
`total_records`	integer	Total number of ticket records
`last_page`	integer	Last available page number
`per_page`	integer	Records per page

`records` — ticket record fields

Field	Type	Description
`id`	integer	Unique ticket ID
`epi`	string	Terminal EPI this ticket is associated with
`subject`	string	Ticket subject category
`status`	string	Ticket status (e.g. `OPEN`, `CLOSED`)
`description`	string	Ticket description submitted by the user
`resolution`	string \| null	Resolution notes; `null` if unresolved
`channel`	string	Submission channel (e.g. `CRM`)
`phone`	string	Contact phone number
`dba_name`	string	Merchant DBA name
`device_type`	string	Terminal type
`created_on`	string	Ticket creation timestamp in `YYYY-MM-DD HH:MM:SS` format
`created_by_name`	string	Name of the user who created the ticket
`created_at`	string	Formatted creation timestamp in `MM/DD/YYYY HH:MM AM/PM (TZ)`
`total_count`	integer	Total number of tickets matching the query
`store_id`	integer	Store ID associated with the ticket
`mp_id`	integer	Merchant portal ID
`last_txn_date`	string	Last transaction date for the associated terminal

Store Sync

Trigger a synchronisation of store data for a merchant.

Response — 200 OK

{
  "code": 200,
  "status": "SUCCESS",
  "message": "Store data synced successfully. You'll be notified by email once processing is complete"
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`SUCCESS` on success
`message`	string	Confirmation message. Email notification will be sent when processing completes

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Store sync is already in progress. You'll be notified by email once it's complete."
}

Error code reference

`status`	Meaning	Typical cause
`SUCCESS`	Success	Store sync initiated
`FAILED`	Error	A sync is already running for this store

Store Delete

Delete a store from an existing merchant.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "result": "Deleted Successfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`result`	string	`Deleted Successfully` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Store is already deleted."
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Store deleted
`false`	Error	Store is already in a deleted state

EPI Add

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

Response — 200 OK

{
  "status": true,
  "message": "Merchant EPI Updated Successfully",
  "Mp_id": "43919",
  "newUserId": "72239",
  "StoreID": {
    "48779": [
      "2319977747"
    ]
  },
  "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 store ID to newly added EPI numbers
`data`	string	`Success` on success

Response — 400 (Validation Error)

{
  "status": "Validation Failed",
  "message": {
    "mp_id": "mp_id Required"
  },
  "code": 400
}

Response fields

Field	Type	Description
`status`	string	`Validation Failed` when required fields are missing
`message`	object	Key-value map of field names to validation error messages
`code`	integer	HTTP status code (`400`)

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI added
`Validation Failed`	Error	Required field `mp_id` missing from the request

EPI Activate

Activate a terminal (EPI).

Response — 200 OK

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

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`data`	string	Informational message. `Device is already active status.` if no change was needed

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success (or no-op)	EPI activated, or was already active
`false`	Error	EPI is invalid or not found

EPI Delete

Delete a terminal (EPI) from a merchant account.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "result": "EPI Deleted Successfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`result`	string	`EPI Deleted Successfully` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI deleted
`false`	Error	EPI is invalid or not found

EPI Detail

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

Response — 200 OK

{
  "status": true,
  "code": "200",
  "Mp_id": 43019,
  "StoreID": 47831,
  "epi": "2319930907",
  "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": 0,
    "surchargePercentage": "4.00",
    "vendor": 2,
    "status": 1,
    "app_key": "yPmCz*********GVc4",
    "auth_token": "jQGF6g*********FkXcd",
    "name_on_account": "Abu"
  },
  "message": "epi Data Exits",
  "StatusUser": 1
}

Note: The response schema is identical to the ISO EPI Detail endpoint. Refer to the EPI Detail field reference in the ISO API section for the full processor_params field descriptions.

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI detail returned
`false`	Error	EPI is invalid or not found

EPI View

Retrieve the full merchant, store, and EPI configuration for a specific terminal.

Response — 200 OK

The response schema is identical to the bearer-auth Merchant View endpoint. Refer to the Merchant View field reference above.

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid epi_id"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI and merchant details returned
`false`	Error	EPI ID is invalid

Assign App — EPI

Assign a specific application version to a terminal.

Response — 200 OK

{
  "data": [
    {
      "epi": "2319970909",
      "assigned_version": "3.0.9si"
    }
  ],
  "status": true,
  "message": "Success",
  "code": 200,
  "assigned_by": 52323
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`assigned_by`	integer	User ID of the account that performed the assignment
`data`	array	Array of assignment result objects

`data` fields

Field	Type	Description
`epi`	string	Terminal EPI the app version was assigned to
`assigned_version`	string	Application version assigned (e.g. `3.0.9si`)

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid epi or device"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	App version assigned to EPI
`false`	Error	EPI or device model is invalid

Fetch E-Receipt

Retrieve a hosted e-receipt URL for a completed transaction.

Response — 200 OK

{
  "status": true,
  "message": "SUCCESS",
  "code": 200,
  "e_receipt": "https://rcpt-staging.valorpaytech.com:4430/?id=8730870-517111500704--v3.0&type=mc"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`SUCCESS` on success
`code`	integer	HTTP status code (`200`)
`e_receipt`	string	URL to the hosted e-receipt page

Response — 400 (Validation Error)

{
  "code": 400,
  "status": "FAILED",
  "errors": "Missing required field: txn_id"
}

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 missing field

Error code reference

`status`	Meaning	Typical cause
`true`	Success	E-receipt URL returned
`FAILED`	Error	Required field `txn_id` is missing from the request

Transaction List

Retrieve a paginated list of transactions for a given terminal or merchant.

Response — 200 OK

{
  "status": true,
  "message": "SUCCESS",
  "code": 200,
  "data": [
    {
      "txn_id": 10331469,
      "epi": "2412333540",
      "rrn": "611806503508",
      "txn_type": "SALE",
      "txn_type_code": 101,
      "base_amount": 1000,
      "custom_fee_amount": 102,
      "net_amount": 1102,
      "tip_amount": 0,
      "tax_amount": 0,
      "state_tax_amount": 0,
      "city_tax_amount": 0,
      "surcharge_fee_amount": 0,
      "cashback_amount": 0,
      "food_amount": 0,
      "card_scheme": "MasterCard",
      "masked_card_no": "5200 XXXX XXXX 8210",
      "card_bin": "520082",
      "card_type": "",
      "card_holder_name": "",
      "approval_code": "VTLMC1",
      "response_code": "00",
      "processor_response_code": "00",
      "switch_error_code": "V0000",
      "host_response": "APPROVALVTLMC1",
      "batch_no": "623",
      "stan_no": "709481",
      "request_date": "2026-04-28",
      "request_time": "02:44 AM",
      "created_at": "2026-04-28 06:44:27",
      "timezone": "EST",
      "mp_id": 29156,
      "store_id": 33168,
      "merchant_name": "Valor Store LLC",
      "store_name": "Test Store",
      "device_id": 139,
      "device_model": "Virtual Terminal",
      "device_label": "VT #2",
      "processor_id": 1,
      "mid": "887000003191",
      "pos_entry_mode": "812",
      "pos_condition_code": "59",
      "message_type": "0200",
      "is_txn_approved": 1,
      "is_voided": 0,
      "is_reversed": 0,
      "is_partial_approved": 0,
      "is_auth_completed": 0,
      "is_avs_failed": 0,
      "is_avs_txn": 0,
      "is_pin_txn": 0,
      "is_non_cash_charge_txn": 0,
      "is_followup_txn": 0,
      "is_ebt_voucher_txn": 0,
      "refunded_amount": 0,
      "refunded_count": 0,
      "tip_adjusted_count": 0,
      "surcharge_label": "Adjustment",
      "description": "king size bed 10x12",
      "invoicenumber": "inv0001",
      "ref_txn_type": "CREDIT SALE",
      "token": "09AA65********128506788",
      "subscription_id": "",
      "invoice_mode": null,
      "customer_name": null,
      "company_name": null,
      "email_id": "",
      "phone_number": ""
    }
  ],
  "number_of_records": 1,
  "page_number": 1,
  "total_pages": 806,
  "total_results": 806,
  "page_size": 1
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`SUCCESS` on success
`code`	integer	HTTP status code (`200`)
`data`	array	Array of transaction objects
`number_of_records`	integer	Records returned on this page
`page_number`	integer	Current page number
`total_pages`	integer	Total pages available
`total_results`	integer	Total matching transactions
`page_size`	integer	Records per page

`data` — transaction fields

Field	Type	Description
`txn_id`	integer	Unique transaction identifier
`epi`	string	Terminal EPI identifier
`rrn`	string	Retrieval reference number
`txn_type`	string	Transaction type (e.g. `SALE`, `REFUND`)
`txn_type_code`	integer	Internal transaction type code
`base_amount`	integer	Base transaction amount in cents
`custom_fee_amount`	integer	Custom fee amount in cents
`net_amount`	integer	Net charged amount in cents
`tip_amount`	integer	Tip amount in cents
`tax_amount`	integer	Total tax amount in cents
`state_tax_amount`	integer	State tax amount in cents
`city_tax_amount`	integer	City tax amount in cents
`surcharge_fee_amount`	integer	Surcharge fee amount in cents
`cashback_amount`	integer	Cashback amount in cents
`food_amount`	integer	Food amount in cents, if applicable
`card_scheme`	string	Card network (e.g. `Visa`, `MasterCard`)
`masked_card_no`	string	Masked card number
`card_bin`	string	Card BIN (first 6 digits)
`card_type`	string	Card type (`DEBIT`, `CREDIT`, or empty)
`card_holder_name`	string	Cardholder name, if provided
`approval_code`	string	Issuer authorization code
`response_code`	string	Gateway response code. `00` = approved
`processor_response_code`	string	Processor-level response code
`switch_error_code`	string	Switch-level error code
`host_response`	string	Full host response string
`batch_no`	string	Settlement batch number
`stan_no`	string	System trace audit number
`request_date`	string	Transaction date in `YYYY-MM-DD` format
`request_time`	string	Transaction time (e.g. `02:44 AM`)
`created_at`	string	Transaction creation timestamp
`timezone`	string	Terminal timezone (e.g. `EST`)
`mp_id`	integer	Merchant portal ID
`store_id`	integer	Store ID
`merchant_name`	string	Merchant DBA name
`store_name`	string	Store name
`device_id`	integer	Device model ID
`device_model`	string	Device model description
`device_label`	string	Terminal display label
`processor_id`	integer	Processor identifier
`mid`	string	Merchant ID used for this transaction
`pos_entry_mode`	string	POS entry mode code
`pos_condition_code`	string	POS condition code
`message_type`	string	ISO 8583 message type
`is_txn_approved`	integer	`1` if approved; `0` if declined
`is_voided`	integer	`1` if voided
`is_reversed`	integer	`1` if reversed
`is_partial_approved`	integer	`1` if partially approved
`is_auth_completed`	integer	`1` if auth has been captured
`is_avs_failed`	integer	`1` if AVS check failed
`refunded_amount`	integer	Total refunded amount in cents
`refunded_count`	integer	Number of refunds issued
`tip_adjusted_count`	integer	Number of tip adjustments made
`surcharge_label`	string	Surcharge display label
`description`	string	Order or item description
`invoicenumber`	string	Invoice reference
`ref_txn_type`	string	Reference transaction type label
`token`	string	Card token (partially masked)
`subscription_id`	string	Subscription ID, if part of a recurring plan
`customer_name`	string \| null	Customer name, if linked to a vault profile

Note: The data array also contains addtl_data_label1 through addtl_data_label25 and their corresponding addtl_data_value1 through addtl_data_value25 fields for custom additional data labels. These are all strings and return empty when not configured.

EPI Last Txn

Retrieve transaction volume statistics and status for a specific terminal.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "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
`code`	integer	HTTP status code (`200`)
`data`	array	Array containing transaction volume statistics
`epi_status`	array	Array containing 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 deleted; `0` otherwise
`status`	integer	`1` if active; `0` if inactive

Response — 400 (No Records)

{
  "status": false,
  "message": "No Record Found",
  "code": 400,
  "data": [],
  "epi_status": [
    {
      "is_deleted": 0,
      "status": 1
    }
  ]
}

Note: Even when no transaction records exist, epi_status is still returned with the current terminal status.

Error code reference

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

EPI Update

Update the configuration of an existing terminal (EPI).

Response — 200 OK

{
  "status": true,
  "message": "Epi Updated Successfully",
  "code": 200
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Epi Updated Successfully` on success
`code`	integer	HTTP status code (`200`)

Response — 400 (Validation Error)

{
  "Validation Failed": "epi length should be 10 digit ."
}

Note: This error response uses a non-standard shape — the key is "Validation Failed" and the value is the error message string. There is no status or code field.

Error code reference

Response shape	Meaning	Typical cause
`status: true`	Success	EPI updated
`{"Validation Failed": "..."}`	Validation error	EPI must be exactly 10 digits

Check EPI

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

Response — 200 OK

{
  "status": true,
  "code": "200",
  "Mp_id": 43019,
  "newUserId": 70979,
  "StoreID": 47831,
  "epi": "2319930907",
  "SerialNo": null,
  "processor_params": {
    "mid": "887000003193",
    "surchargeIndicator": 0,
    "surchargePercentage": "4.00",
    "app_key": "yPmCz*********G2GVc4",
    "auth_token": "jQGF6g*********p0FkXcd",
    "name_on_account": "Abu"
  },
  "optStatus": 1,
  "statusEpi": 1,
  "createdDate": "2024-11-20",
  "createdBy": 52323,
  "isDeleted": 0,
  "deletedOn": null,
  "deletedBy": null
}

Note: The response schema is identical to the ISO Check EPI endpoint. Refer to the Check EPI field reference in the ISO API section for full field descriptions.

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi"
}

Error code reference

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

Sub-ISO — Create

Create a new Sub-ISO account.

Response — 200 OK

{
  "status": 1,
  "message": "Success",
  "code": 200,
  "statusDesc": "sub iso User has been created Sucessfully.",
  "user_id": 194999,
  "customer_id": 10914,
  "office_id": 26672
}

Response fields

Field	Type	Description
`status`	integer	`1` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`statusDesc`	string	Detailed confirmation message
`user_id`	integer	Unique user ID assigned to the new Sub-ISO
`customer_id`	integer	Customer ID associated with the Sub-ISO account
`office_id`	integer	Office ID assigned to the Sub-ISO

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid state"
}

Error code reference

`status`	Meaning	Typical cause
`1`	Success	Sub-ISO created
`FAILED`	Error	Invalid state value provided in the request

Device Parameter

Push updated device parameters to a terminal.

Response — 200 OK

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

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)

Response — 400 (Error)

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

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Device parameters updated
`FAILED`	Error	`descriptor_enabled` requires `generate_pay_now_link` to be enabled first

EPI Status

Retrieve the current status of a terminal (EPI).

Response — 200 OK

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

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`data`	string	Current EPI status description

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI status returned
`false`	Error	EPI is invalid or not found

EPI Deactivate

Deactivate a terminal to prevent it from processing transactions.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": "EPI Deactivated Successfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`data`	string	`EPI Deactivated Successfully` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi or EPI doesn`t belong to this ISO"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	EPI deactivated
`false`	Error	EPI is invalid or does not belong to this ISO

Check Profile

Verify that a merchant profile exists and retrieve its summary details.

Response — 200 OK

{
  "status": true,
  "code": "200",
  "Mp_id": 43019,
  "newUserId": 70979,
  "StoreID": 47831,
  "message": "Profile Data Exits",
  "StatusUser": 1
}

Response fields

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 associated with the merchant
`message`	string	`Profile Data Exits` when the profile is found
`StatusUser`	integer	`1` if the merchant is active; `0` otherwise

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Please Enter newUserId"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Profile found and details returned
`false`	Error	Required field `newUserId` missing from the request

Generating API Keys

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

Response — 200 OK

{
  "status": "OK",
  "message": "App Key already associated with EPI",
  "code": 200,
  "data": {
    "epi": "2319930907",
    "Mp_Id": 43019,
    "UserId": 70979,
    "device_model": "Virtual Terminal",
    "device_name": "Virtual Terminal",
    "appkey": "I8GMof******vyVkl",
    "appid": "XFsxjryY******jh62shr"
  }
}

Response fields — top level

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

`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
`device_name`	string	Terminal display name
`appkey`	string	Partially masked App Key for this terminal
`appid`	string	Partially masked App ID for this merchant

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid Epi"
}

Error code reference

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

EPI Status Update

Update the active or inactive status of a terminal.

Response — 200 OK

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

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`data`	string	Informational outcome message

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "Invalid Epi"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success (or no-op)	Status updated, or EPI was already in the requested state
`false`	Error	EPI is invalid or not found

Fetch APP ID & APP Keys

Retrieve the App ID and App Keys for all terminals under a merchant.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {
    "APP_ID": "XFsx********jh62shr",
    "devices": [
      {
        "EPI": "2319930907",
        "DEVICE_NAME": "Virtual Terminal",
        "DEVICE_TYPE": "Virtual Terminal",
        "APP_KEY": "I8GMo********R3RMyvyVkl"
      }
    ]
  }
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`data`	object	App credentials object

`data` fields

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

`devices` fields

Field	Type	Description
`EPI`	string	Terminal EPI identifier
`DEVICE_NAME`	string	Terminal display name
`DEVICE_TYPE`	string	Terminal type description
`APP_KEY`	string	Partially masked App Key unique to this terminal

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "You are Not Authorized"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	App ID and keys returned
`false`	Error	Authenticated user is not authorised to access this data

Update Ticket — Merchant

Update an existing support ticket as a merchant user.

Response — 200 OK

{
  "code": 200,
  "status": true,
  "message": "Ticket Updated Successfully."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	boolean	`true` on success
`message`	string	`Ticket Updated Successfully.` on success

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "You are not authorized to update tickets."
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Ticket updated
`false`	Error	User does not have permission to update this ticket

ISO Billing Statement

Retrieve the billing statement for an ISO, including per-merchant fee details and aggregate summary.

Response — 200 OK

{
  "status": true,
  "message": "Success",
  "code": 200,
  "result": {
    "iso_billing_report": [
      {
        "dba_name": "Valor Store LLC",
        "mp_id": 29156,
        "email_id": "ab*****ech.com",
        "basic_portal_store": "1",
        "basic_portal_store_fee": "100.00",
        "vt_txn_count": "0",
        "vt_per_txn_fee": "0.15",
        "sim_count": "0",
        "sim_fee": "1.50",
        "sms_count": "0",
        "sms_fee": "2.00",
        "price": "100.00"
      }
    ],
    "iso_billing_summary": [
      {
        "user_id": 52323,
        "cust_id": 10914,
        "store_count": "932",
        "merchant_count": "914",
        "sms_count": "0",
        "sim_count": "0",
        "net_volume": "93200.00"
      }
    ]
  }
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`result`	object	Billing data containing `iso_billing_report` and `iso_billing_summary`

`iso_billing_report` — per-merchant billing fields

Field	Type	Description
`dba_name`	string	Merchant DBA name
`mp_id`	integer	Merchant portal ID
`email_id`	string	Merchant contact email (may be partially masked)
`basic_portal_store`	string	Number of portal stores billed
`basic_portal_store_fee`	string	Fee charged per portal store
`vt_txn_count`	string	Number of virtual terminal transactions
`vt_per_txn_fee`	string	Fee per virtual terminal transaction
`sim_count`	string	Number of SIM devices
`sim_fee`	string	Fee per SIM device
`sms_count`	string	Number of SMS messages sent
`sms_fee`	string	Fee per SMS message
`price`	string	Total billed amount for this merchant

`iso_billing_summary` — aggregate summary fields

Field	Type	Description
`user_id`	integer	ISO user ID
`cust_id`	integer	ISO customer ID
`store_count`	string	Total number of stores across all merchants
`merchant_count`	string	Total number of merchants under this ISO
`sms_count`	string	Total SMS messages sent
`sim_count`	string	Total SIM devices
`net_volume`	string	Total billing volume in decimal format

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid year. Please provide a valid year in YYYY format"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Billing statement returned
`FAILED`	Error	Year parameter is missing or not in `YYYY` format

ISO Operator — Create

Create an operator user account under an ISO.

Response — 200 OK

{
  "status": 1,
  "message": "Success",
  "code": 200,
  "status_desc": "ISO operator Boarding successfull.",
  "user_id": 195038
}

Response fields

Field	Type	Description
`status`	integer	`1` on success
`message`	string	`Success` on success
`code`	integer	HTTP status code (`200`)
`status_desc`	string	Detailed confirmation message
`user_id`	integer	Unique user ID assigned to the new ISO operator

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "UserName already exsists."
}

Error code reference

`status`	Meaning	Typical cause
`1`	Success	ISO operator created
`FAILED`	Error	Username already exists

Differential Setting Bulk Update

Trigger a bulk update of differential settings across multiple terminals.

Response — 200 OK

{
  "code": 200,
  "status": "SUCCESS",
  "desc": "Differential Setting submitted successfully. You'll be notified by email once processing is complete"
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`200`)
`status`	string	`SUCCESS` on success
`desc`	string	Confirmation message. Email notification will be sent when processing completes

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Differential setting is already in progress. You'll be notified by email once it's complete."
}

Error code reference

`status`	Meaning	Typical cause
`SUCCESS`	Success	Bulk update submitted
`FAILED`	Error	A differential setting update is already running

Merchant Add Multi-MID

Onboard a new merchant with multiple MID (merchant ID) configurations.

Response — 200 OK

{
  "status": true,
  "message": "User Added Successfully",
  "code": 200,
  "storeInfo": {
    "154703": [
      "2319977764"
    ]
  },
  "mpId": 140390,
  "newUserId": 195041
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`User Added Successfully` on success
`code`	integer	HTTP status code (`200`)
`storeInfo`	object	Map of store ID to associated EPI numbers
`mpId`	integer	Unique merchant portal ID assigned to the new merchant
`newUserId`	integer	Unique user ID assigned to the new merchant account

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "ErrorMessage: User Name already exist in child userList"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Multi-MID merchant created
`false`	Error	Username already exists under this hierarchy

Merchant Info Update

Update the details of an existing Multi-MID merchant.

Response — 200 OK

{
  "status": true,
  "message": "User Updated Successfully",
  "code": 200,
  "storeInfo": {
    "154703": [
      "2319977764"
    ]
  },
  "mpId": 140390,
  "newUserId": 195041
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`User Updated Successfully` on success
`code`	integer	HTTP status code (`200`)
`storeInfo`	object	Map of store ID to associated EPI numbers
`mpId`	integer	Merchant portal ID
`newUserId`	integer	User ID of the merchant

Response — 400 (Error)

{
  "code": 400,
  "status": false,
  "message": "User Name already exist in child userList"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Merchant info updated
`false`	Error	Username already exists in the child hierarchy

Multi-MID — Store Update

Update a store under a Multi-MID merchant configuration.

Response — 200 OK

{
  "status": true,
  "message": "Merchant Store Updated Successfully",
  "code": 200,
  "storeInfo": {
    "154703": [
      "2319977764"
    ]
  },
  "mpId": 140390,
  "newUserId": 195041
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Merchant Store Updated Successfully` on success
`code`	integer	HTTP status code (`200`)
`storeInfo`	object	Map of store ID to associated EPI numbers
`mpId`	integer	Merchant portal ID
`newUserId`	integer	User ID of the merchant

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid User"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Store updated
`FAILED`	Error	User credentials are invalid

Multi-MID — Child EPI Update

Update the EPI data for a child terminal in a Multi-MID configuration.

Response — 200 OK

{
  "status": true,
  "message": "Child EpiData details updated successfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Child EpiData details updated successfully` on success

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid User"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Child EPI data updated
`FAILED`	Error	User credentials are invalid

Multi-MID — Parent EPI Update

Update the EPI data for the parent terminal in a Multi-MID configuration.

Response — 200 OK

{
  "status": true,
  "message": "Parent EpiData details updated successfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Parent EpiData details updated successfully` on success

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid User"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Parent EPI data updated
`FAILED`	Error	User credentials are invalid

Multi-MID — Module Update

Update the module list configuration for a Multi-MID merchant.

Response — 200 OK

{
  "status": true,
  "message": "Merchant ModuleList details updated successfully"
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Merchant ModuleList details updated successfully` on success

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Invalid User"
}

Error code reference

`status`	Meaning	Typical cause
`true`	Success	Module list updated
`FAILED`	Error	User credentials are invalid

Device Parameter Fetch API

Retrieve the full parameter configuration for a specific terminal.

Response — 200 OK

{
  "status": true,
  "message": "Epi parameter Fetch successfully",
  "code": 200,
  "result": {
    "tip_enabled": "0",
    "tip_on_screen": false,
    "tip_options": ["15", "20", "22", "25"],
    "max_tip_percentage": "350",
    "custom_fee_enabled": "1",
    "card_type": "All Cards",
    "surcharge_label": "Surcharge",
    "surcharge": "4.000",
    "tax_enabled": "0",
    "state_tax": "0.600",
    "federal_tax": "6.000",
    "avs": "NONE",
    "duplicate_transaction_check": "None",
    "duplicate_transaction_action": "Decline Duplicate Transaction",
    "partial_approval": false,
    "enable_l2": false,
    "descriptor_enabled": false,
    "descriptor_label": "Valor Store LLC",
    "batch_out_enabled": false,
    "batch_out_timer": "00:00 AM",
    "header_one": "EL TRI MX RESTA Add",
    "header_two": "4100 JOHNSTON ST",
    "header_three": "LAFAYETTE LA 70503",
    "header_four": "337-704-0344",
    "footer_one": "Thank You",
    "disclaimer_one": "Cardholder acknowledges",
    "enable_disclaimer": true,
    "email_settlement_report": true,
    "password_for_refund_enabled": false,
    "password_for_refund_amount": "100",
    "max_limit_per_attempt": "1000",
    "max_limit_per_day": "5000"
  }
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`Epi parameter Fetch successfully` on success
`code`	integer	HTTP status code (`200`)
`result`	object	Full device parameter configuration (see below)

`result` — device parameter fields

Field	Type	Description
`tip_enabled`	string	`1` if tip collection is enabled; `0` otherwise
`tip_on_screen`	boolean	`true` if tip prompt is shown on screen
`tip_options`	array	List of preset tip percentage options
`max_tip_percentage`	string	Maximum tip adjustment percentage
`custom_fee_enabled`	string	`1` if custom fee is enabled; `0` otherwise
`card_type`	string	Card types subject to the custom fee (e.g. `All Cards`)
`surcharge_label`	string	Display label for the surcharge
`surcharge`	string	Surcharge percentage value
`tax_enabled`	string	`1` if tax is enabled; `0` otherwise
`state_tax`	string	State tax percentage
`federal_tax`	string	Federal tax percentage
`avs`	string	AVS check setting (e.g. `NONE`, `BASIC`)
`duplicate_transaction_check`	string	Duplicate transaction check window (e.g. `None`, `60 Minutes`)
`duplicate_transaction_action`	string	Action on duplicate detection
`partial_approval`	boolean	`true` if partial approval is enabled
`enable_l2`	boolean	`true` if Level 2 data collection is enabled
`descriptor_enabled`	boolean	`true` if dynamic descriptor is enabled
`descriptor_label`	string	Descriptor text displayed on cardholder statements
`batch_out_enabled`	boolean	`true` if automatic batch-out is enabled
`batch_out_timer`	string	Scheduled batch-out time
`header_one` through `header_seven`	string	Receipt header lines
`footer_one`	string	Receipt footer line
`disclaimer_one` through `disclaimer_five`	string	Receipt disclaimer lines
`enable_disclaimer`	boolean	`true` if disclaimer is printed on receipts
`email_settlement_report`	boolean	`true` if settlement report is emailed
`password_for_refund_enabled`	boolean	`true` if a password is required for refunds
`password_for_refund_amount`	string	Refund amount threshold above which a password is required
`max_limit_per_attempt`	string	Maximum transaction amount per attempt in dollars
`max_limit_per_day`	string	Maximum total transaction amount per day in dollars
`server_clerk_setup`	boolean	`true` if server/clerk tracking is enabled
`donations`	boolean	`true` if donation prompts are enabled
`charity_name`	string	Name of the charity for donation prompts
`customer_satisfaction_survey`	boolean	`true` if post-transaction survey is enabled
`avs_for_einvoice`	boolean	`true` if AVS check is applied to e-invoice transactions
`generate_otp_paynow_link`	boolean	`true` if OTP is required for Pay Now links
`additional_input_enabled`	boolean	`true` if additional custom input fields are enabled
`additional_input`	array	List of configured additional input field definitions

Note: The result object also contains up to 25 present_on_customer_receipt_N boolean fields (1–25) controlling which additional data labels appear on customer receipts, as well as several disable_*_copy_* flags for controlling receipt delivery by email and SMS.

Response — 400 (Error)

{
  "message": "Epi is not available for this user"
}

Note: This error response returns only a message field with no status or code.

Error code reference

Response shape	Meaning	Typical cause
`status: true`	Success	Device parameters returned
`{"message": "..."}`	Error	EPI does not belong to the authenticated user

Get POS Menu Configuration API

Retrieve the POS menu configuration for a terminal, including all payment method categories and their enabled transaction sub-types.

Response — 200 OK

{
  "status": true,
  "message": "SUCCESS",
  "code": 200,
  "data": [
    {
      "label": "CREDIT",
      "is_enabled": true,
      "sub_menu": [
        { "label": "SALE", "is_enabled": true },
        { "label": "VOID", "is_enabled": true },
        { "label": "PREAUTH", "is_enabled": true },
        { "label": "TICKET", "is_enabled": false },
        { "label": "REFUND", "is_enabled": true },
        { "label": "PRESALE", "is_enabled": true },
        { "label": "POSTAUTH", "is_enabled": true }
      ]
    },
    {
      "label": "DEBIT",
      "is_enabled": true,
      "sub_menu": [
        { "label": "SALE", "is_enabled": true },
        { "label": "REFUND", "is_enabled": false }
      ]
    },
    {
      "label": "EBT FOOD",
      "is_enabled": true,
      "sub_menu": [
        { "label": "SALE", "is_enabled": true },
        { "label": "V SALE", "is_enabled": false },
        { "label": "REFUND", "is_enabled": false },
        { "label": "BALANCE", "is_enabled": false }
      ]
    },
    {
      "label": "EBT CASH",
      "is_enabled": true,
      "sub_menu": [
        { "label": "SALE", "is_enabled": true },
        { "label": "BALANCE", "is_enabled": false },
        { "label": "W DRAWL", "is_enabled": false }
      ]
    },
    {
      "label": "CASH",
      "is_enabled": true,
      "sub_menu": [
        { "label": "SALE", "is_enabled": true },
        { "label": "REFUND", "is_enabled": false }
      ]
    },
    {
      "label": "VAULT",
      "is_enabled": false,
      "sub_menu": [
        { "label": "ADD CARD", "is_enabled": false }
      ]
    }
  ]
}

Response fields — top level

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`SUCCESS` on success
`code`	integer	HTTP status code (`200`)
`data`	array	Array of menu category objects

`data` — menu category fields

Field	Type	Description
`label`	string	Payment method category name (e.g. `CREDIT`, `DEBIT`, `EBT FOOD`)
`is_enabled`	boolean	`true` if this payment method category is enabled on the POS
`sub_menu`	array	Array of transaction type objects available under this category (see below)

`sub_menu` — transaction type fields

Field	Type	Description
`label`	string	Transaction type name (e.g. `SALE`, `VOID`, `REFUND`)
`is_enabled`	boolean	`true` if this transaction type is enabled for the parent category

Menu categories and available sub-menu items

Category	Available sub-menu items
`CREDIT`	`SALE`, `VOID`, `PREAUTH`, `TICKET`, `REFUND`, `PRESALE`, `POSTAUTH`
`DEBIT`	`SALE`, `REFUND`
`EBT FOOD`	`SALE`, `V SALE`, `REFUND`, `BALANCE`
`EBT CASH`	`SALE`, `BALANCE`, `W DRAWL`
`CASH`	`SALE`, `REFUND`
`VAULT`	`ADD CARD`

Note: A category with is_enabled: false hides the entire payment method from the POS, regardless of individual sub-menu settings. A sub-menu item with is_enabled: false is hidden from the operator but remains configured on the terminal.

Response — 400 (Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "Not authorized to access this POS menu config."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request cannot be processed
`message`	string	Human-readable error message

Error code reference

`status`	Meaning	Typical cause
`true`	Success	POS menu configuration returned
`FAILED`	Authorization error	The authenticated user does not have permission to access this terminal's POS menu configuration

Update POS Menu Configuration API

Update the enabled/disabled state of payment method categories and their transaction sub-types on a terminal's POS menu.

Response — 200 OK

{
  "status": true,
  "message": "POS menu configuration updated successfully",
  "code": 200
}

Response fields

Field	Type	Description
`status`	boolean	`true` on success
`message`	string	`POS menu configuration updated successfully` on success
`code`	integer	HTTP status code (`200`)

Response — 400 (Validation Error)

{
  "code": 400,
  "status": "FAILED",
  "message": "The menu label 'GIFT' is not valid."
}

Response fields

Field	Type	Description
`code`	integer	HTTP status code (`400`)
`status`	string	`FAILED` when the request cannot be processed
`message`	string	Human-readable error message identifying the invalid label

Error code reference

`status`	Meaning	Typical cause
`true`	Success	POS menu configuration updated
`FAILED`	Validation error	A menu `label` value in the request is not a recognised POS menu category or sub-menu item

Merchant — Create Bearer Token

Response — 200 OK

Response fields

Response — 400 (Error)

Response fields

Error code reference

Merchant Add

Response — 200 OK

Response fields

Response — 400 (Error)

Response fields

Error code reference

Merchant Update

Response — 200 OK

Response fields

Response — 400 (Error)

Response fields

Error code reference

Merchant Delete

Response — 200 OK

Response fields

Response — 400 (Error)

Response fields

Error code reference

Merchant Get Details

Response — 200 OK

Response fields — top level

data fields

Response — 400 (Error)

Response fields

Error code reference

Merchant Operator — Create

Response — 200 OK

Response fields

Response — 400 (Error)

Response fields

Error code reference

Sub-ISO Operator — Create

Response — 200 OK

Response fields

Response — 400 (Error)

Response fields

Error code reference

Merchant Status

Response — 200 OK (Success)

Response — 400 (Partial or Full Failure)

Response fields

erroredMerchants object fields

Error code reference

Merchant View

Response — 200 OK

Response fields — top level

Response — 400 (Error)

Response fields

Error code reference

Merchant List

Response — 200 OK

Response fields — top level

data — merchant summary fields

Response — 400 (Error)

Error code reference

Copy Parameter API

Response — 200 OK

Response fields

Response — 400 (Error)

Error code reference

Store Add

Response — 200 OK

Response fields

Response — 400 (Validation Error)

Response fields

Error code reference

Create Ticket

Response — 200 OK

Response fields

Response — 400 (Error)

Error code reference

Update Ticket — ISO

Response — 200 OK

Response fields

`data` fields

`erroredMerchants` object fields

`data` — merchant summary fields

`subjects` — ticket subject fields

`meta` object

`records` — ticket record fields

`data` fields

`data` — transaction fields