Skip to main content
Manage user profiles (User, Department, Merchant) in your organization.

Methods

getProfiles()

Get a paginated list of profiles. Signature:
Parameters:
ParameterTypeRequiredDescription
request.skipnumberNoNumber of records to skip (default: 0)
request.takenumberNoNumber of records to retrieve (default: 10, max: 100)
Example:
Response:

createProfile()

Create a new profile. Signature:
Parameters:
ParameterTypeRequiredDescription
request.referencestringYesUnique identifier for the profile in your system
request.type'User' | 'Department' | 'Merchant'YesType of profile
Example:
Response:
Throws:
  • BadRequestError - Invalid request parameters
  • UnauthorizedError - Missing or invalid API key
  • InternalServerError - Server error

Profile Types

  • User: Individual users in your system
  • Department: Organizational units or departments
  • Merchant: Business entities or merchants

Complete Example