Get All User Threshold Detail

Retrieves all user threshold detail records based on specified filter criteria.

Basic Information

• Method: GET
• URL: https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_detail
• Content-Type: application/json
• companyid: 59388167894b4d10a04fe5da3b8a2104
• requestid: 5bb30135-1815-41d5-827f-baed3daba4af
• Authorization: Token required

Headers

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

Query Parameters

• user_threshold_id (string, optional): Filter threshold details by user threshold ID
  • Example: ?user_threshold_id=2a9d2274fe554ebaa62550034ca24e93
• product_id (string, optional): Filter threshold details by product ID
  • Example: ?product_id=619395711eac4be9bc856ca0d9a6af1f
• product_code (string, optional): Filter threshold details by product code
  • Example: ?product_code=P2P
• threshold_type (integer, optional): Filter by threshold type
  • 1 = AMOUNT (Amount-based thresholds only)
  • 2 = NO_OF_TXN (Transaction count-based thresholds only)
  • 3 = BOTH (Both amount and transaction count thresholds)
  • Example: ?threshold_type=1
• threshold_id (string, optional): Filter by threshold ID
  • Example: ?threshold_id=1dfec6e7b51c4dc1b4204ec3c09589f5
• threshold_detail_id (string, optional): Filter by threshold detail ID
  • Example: ?threshold_detail_id=ef70f29ff8a04ec7984983ee7e73f5b8
• is_modified (boolean, optional): Filter by modification status
  • Example: ?is_modified=false
• is_active (boolean, optional): Filter by active status
  • Example: ?is_active=true
• search_keyword (string, optional): Search by product code
  • Example: ?search_keyword=P2P
• start_date (long, optional): Filter by creation date (Unix timestamp in seconds)
  • Example: ?start_date=1704067200
• end_date (long, optional): Filter by creation date (Unix timestamp in seconds)
  • Example: ?end_date=1735689599
• skip (integer, optional): Number of records to skip for pagination
  • Example: ?skip=0
• limit (integer, optional): Maximum number of records to return
  • Example: ?limit=10
• sorting (string, optional): Sort order (asc/desc)
  • Example: ?sorting=desc

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 (array): Array of user threshold detail objects
    • 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?user_id=e72810252c034a278a433eb0535b7ead&product_code=P2P' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU5NjQ2NTU5fQ.NoUhIlH54d-1UbvNzxl5tUKqnqZq2-uH-7Q_XJ86Oug' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: 5bb30135-1815-41d5-827f-baed3daba4af'

Additional Examples

Get Threshold Details by Product Code

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_detail?product_code=IWT' \
--header 'authorization: Token YOUR_TOKEN' \
--header 'companyid: YOUR_COMPANY_ID' \
--header 'requestid: YOUR_REQUEST_ID'

Get Threshold Details by User Threshold ID

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_detail?user_threshold_id=2a9d2274fe554ebaa62550034ca24e93' \
--header 'authorization: Token YOUR_TOKEN' \
--header 'companyid: YOUR_COMPANY_ID' \
--header 'requestid: YOUR_REQUEST_ID'

Get Threshold Details by Date Range (Epoch Format)

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_detail?start_date=1704067200&end_date=1735689599' \
--header 'authorization: Token YOUR_TOKEN' \
--header 'companyid: YOUR_COMPANY_ID' \
--header 'requestid: YOUR_REQUEST_ID'

Get Threshold Details by Threshold Type

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/user_threshold_detail?threshold_type=1' \
--header 'authorization: Token YOUR_TOKEN' \
--header 'companyid: YOUR_COMPANY_ID' \
--header 'requestid: YOUR_REQUEST_ID'

Notes

• The API returns all threshold details that match the specified criteria
• If no query parameters are provided, all threshold details for the company are returned
• 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
• Only threshold details belonging to the authenticated user's company are returned
• The API supports multiple filter combinations for precise threshold detail retrieval
• Pagination is supported through skip and limit parameters
• Date Format: start_date and end_date parameters use Unix timestamps in seconds (epoch format)
  • Example: 1704067200 = January 1, 2024 00:00:00 UTC
  • Example: 1735689599 = December 31, 2024 23:59:59 UTC