for developers and administrators
User Interface Reference
Resources (Directory Structure)
Zip and Country Codes
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
Base Resource URL:
Provides access to users registered in the system
User name of a user, on which action is required.
Returns list of available users based on specified search conditions.
Index of the first record returned to the customer from the search result of a web search.
Maximum number of records to load per single search web call made by the customer.
Query parameter to search users by their provider creation date. All merchants created within the date range defined will be included.
Represents a date range with lower and upper limits. Range can include only lower or only upper limit.
Query parameter to search users by full or partial name (soundex on full name is supported as well)
Query parameter to search users by full name.
Query parameter to search users by code.
Query parameter to search users by id.
Query parameter to search users by activity status.
HTTP Status Code
HTTP Status Code
Invalid user name/password
Either username/password was not supplied or the supplied credentials were not found in the system.
Specified resource is not available, not found or is not supported by the API.
Object not found
Requested merchant, merchant account or reseller is not registered in the system. Verify that the supplied code/reference code contains no errors.
Object access denied
Access to the merchant, merchant account or reseller is denied. Contact system administrator to verify permissions on your user account.
Sub-merchant resource is not supported
Specified resource is not supported by the API for sub-merchants.
Runtime error occurred during service execution. Please try again later. If the error persists, contact system administrator.
Invalid parameter format
One (or more) of the parameter values is invalid. The value is out of the allowed range or is not properly formatted and thus cannot be parsed and processed.
UniPay - Payment Gateway Software
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.