Skip to main content

Get User Threshold Detail by ID

Retrieves a specific user threshold detail record by its unique identifier.

Basic Information​

Headers​

companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: 5bb30135-1815-41d5-827f-baed3daba4af
authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU5NjQ2NTU5fQ.NoUhIlH54d-1UbvNzxl5tUKqnqZq2-uH-7Q_XJ86Oug

Path Parameters​

  • id (string, required): Unique identifier of the threshold detail to retrieve
    • Example: d0442d692f4143bc852c9db6e850cd8e

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "user_threshold_detail": {
            "is_active": true,
            "created_by": "af9d2606e8604614a673e7eb9c7b7de9",
            "created_date": 1758946370,
            "updated_by": null,
            "updated_date": 1758946370,
            "id": "d0442d692f4143bc852c9db6e850cd8e",
            "user_threshold_id": "2a9d2274fe554ebaa62550034ca24e93",
            "product_id": "619395711eac4be9bc856ca0d9a6af1f",
            "product_code": "P2P",
            "threshold_type": 1,
            "threshold_amount": {
                "daily_limit": 100000.0,
                "weekly_limit": 1.0E7,
                "monthly_limit": 1.0E9
            },
            "threshold_no_txn": {
                "daily_limit": 0,
                "weekly_limit": 0,
                "monthly_limit": 0
            },
            "min_amount": 1.0,
            "max_amount": 10000.0,
            "threshold_usege_amount": {
                "daily_usage": 0.0,
                "weekly_usage": 0.0,
                "monthly_usage": 0.0
            },
            "threshold_usege_txn": {
                "daily_usage": 0,
                "weekly_usage": 0,
                "monthly_usage": 0
            },
            "threshold_id": "1dfec6e7b51c4dc1b4204ec3c09589f5",
            "threshold_detail_id": "ef70f29ff8a04ec7984983ee7e73f5b8",
            "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_detail (object): User threshold detail object
      • id (string): Unique threshold detail identifier
      • user_threshold_id (string): Associated user threshold master ID
      • product_id (string): Product identifier
      • product_code (string): Product code (e.g., P2P, IWT, P2M, etc.)
      • threshold_type (integer): Type of threshold configuration (1=AMOUNT, 2=NO_OF_TXN, 3=BOTH)
      • threshold_amount (object): Threshold amount limits
        • daily_limit (number): Daily amount limit
        • weekly_limit (number): Weekly amount limit
        • monthly_limit (number): Monthly amount limit
      • threshold_no_txn (object): Threshold transaction count limits
        • daily_limit (integer): Daily transaction count limit
        • weekly_limit (integer): Weekly transaction count limit
        • monthly_limit (integer): Monthly transaction count limit
      • min_amount (number): Minimum transaction amount
      • max_amount (number): Maximum transaction amount
      • threshold_usege_amount (object): Current usage amounts
        • daily_usage (number): Daily amount used
        • weekly_usage (number): Weekly amount used
        • monthly_usage (number): Monthly amount used
      • threshold_usege_txn (object): Current usage transaction counts
        • daily_usage (integer): Daily transactions used
        • weekly_usage (integer): Weekly transactions used
        • monthly_usage (integer): Monthly transactions used
      • threshold_id (string): Associated threshold configuration ID
      • threshold_detail_id (string): Threshold detail configuration ID
      • 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_detail/d0442d692f4143bc852c9db6e850cd8e' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU5NjQ2NTU5fQ.NoUhIlH54d-1UbvNzxl5tUKqnqZq2-uH-7Q_XJ86Oug' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: 5bb30135-1815-41d5-827f-baed3daba4af'

Error Responses​

Threshold Detail Not Found​

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

Invalid Request​

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

Notes​

  • The API returns a single threshold detail record based on the provided ID
  • The threshold detail must belong to the authenticated user's company
  • Threshold Types:
    • 1 = AMOUNT (Amount-based thresholds only)
    • 2 = NO_OF_TXN (Transaction count-based thresholds only)
    • 3 = BOTH (Both amount and transaction count thresholds)
  • The threshold_amount and threshold_no_txn objects define limits for daily, weekly, and monthly periods
  • The threshold_usege_amount and threshold_usege_txn objects track current usage against these limits
  • If the threshold detail is not found, a 404 error response is returned