Skip to main content

Get User Threshold Master by ID API

Overview​

Retrieve a specific user threshold master record by its unique identifier. This API allows you to fetch detailed information about a particular threshold configuration for a user.

API Details​

Endpoint​

GET https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_master/{id}

Path Parameters​

ParameterTypeRequiredDescription
idstringYesUnique identifier of the user threshold master record

Headers​

companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: 5bb30135-1815-41d5-827f-baed3daba4af
authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU4OTY2OTAzfQ.4e8MwJFrhoh2-vSvyR-s828TmEbgpYp-ocHlfo3Fnu4

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "user_threshold_master": {
            "is_active": true,
            "created_by": "e72810252c034a278a433eb0535b7ead",
            "created_date": 1758944507,
            "updated_by": null,
            "updated_date": 1758944507,
            "id": "41ebd05c2e614c22ba0e73ad330d2bd6",
            "threshold_id": "1dfec6e7b51c4dc1b4204ec3c09589f5",
            "user_id": "e72810252c034a278a433eb0535b7ead",
            "user_type": 2,
            "name": "Customer",
            "currency_id": "1f1519903ed240578f071aa45cb479f2",
            "min_balance": 0.0,
            "max_balance": 800000000.0,
            "is_modified": false
        }
    }
}

Response Fields​

  • success (integer): Response status indicator
    • 1 = Success
    • 0 = Failure
  • error (array): Array of error messages (empty on success)
  • data (object): Response data object
    • user_threshold_master (object): User threshold master object
      • id (string): Unique threshold master identifier
      • threshold_id (string): Associated threshold configuration ID
      • user_id (string): User identifier
      • user_type (integer): Type of user (2=USER, 3=MERCHANT)
      • name (string): Name of the threshold configuration
      • currency_id (string): Currency identifier
      • min_balance (number): Minimum balance allowed for the user
      • max_balance (number): Maximum balance allowed for the user
      • is_modified (boolean): Whether the threshold has been modified
      • is_active (boolean): Whether the threshold is active
      • created_by (string): User who created the threshold
      • created_date (number): Unix timestamp when threshold was created
      • updated_by (string): User who last updated the threshold
      • updated_date (number): Unix timestamp when threshold was last updated

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_master/41ebd05c2e614c22ba0e73ad330d2bd6' \
--header 'accept: application/json' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU4OTY2OTAzfQ.4e8MwJFrhoh2-vSvyR-s828TmEbgpYp-ocHlfo3Fnu4' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: 5bb30135-1815-41d5-827f-baed3daba4af'

Error Responses​

Threshold Master Not Found​

{
    "success": 0,
    "error": ["USER_THRESHOLD_MASTER_DATA_NOT_FOUND"],
    "data": {}
}

Invalid ID Format​

{
    "success": 0,
    "error": ["BAD_REQUEST"],
    "data": {}
}

Notes​

  • The API returns a single threshold master record if found
  • The threshold master must belong to the authenticated user's company
  • Only active threshold masters are returned by default
  • The id parameter must be a valid UUID format
  • If the threshold master is not found, an error response is returned
  • The API validates company access to ensure data security