Skip to main content

Get Points Redeem Config API

Overview​

Retrieve the points redemption configuration details for a specific user type and currency, including redemption rules, limits, and available options.

API Details​

Endpoint​

GET https://api.gafapay.com:8443/gafapay/v3/reward_promotion/points_redeem_config

Headers​

Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3NzY5NDU0fQ.QMvK_JLnYBE6XYaFdyg16aVupTONBO7eMGDmzAGVhVg
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: b35d332f-131e-44c1-892f-8322e022da74

Query Parameters​

Required Parameters​

  • user_type (integer, required): Type of user account

    • 2 = Customer
    • 3 = Merchant
    • 5 = Agent
    • Example: 2

  • currency_id (string, required): Unique identifier of the currency

    • Format: UUID string
    • Example: "1f1519903ed240578f071aa45cb479f2"

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "points_redeem_configs": [
            {
                "id": "57c8ed06955c4969b81fc9c9b530d404",
                "user_type": 2,
                "no_of_points": 10.0,
                "redeem_type": 1,
                "points_value": 10.0,
                "voucher_details": null,
                "min_points_to_redeem": 10.0,
                "max_points_to_redeem": 100.0,
                "redeem_cycle": 1,
                "currency_id": "1f1519903ed240578f071aa45cb479f2",
                "is_active": true
            }
        ]
    }
}

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
    • points_redeem_configs (array): Array of points redemption configuration details
      • id (string): Unique identifier for the redemption configuration
      • user_type (integer): Type of user account this configuration applies to
        • 2 = Customer
        • 3 = Merchant
        • 5 = Agent
      • no_of_points (number): Number of points required for redemption
      • redeem_type (integer): Type of redemption
        • 1 = Cashback (REDEEM_TYPE_CASHBACK)
        • 2 = Voucher (REDEEM_TYPE_VOUCHER)
      • points_value (number): Value of points in the specified currency
      • voucher_details (object|null): Voucher details if redeem_type is 2, null otherwise
      • min_points_to_redeem (number): Minimum points required to initiate redemption
      • max_points_to_redeem (number): Maximum points that can be redeemed in a single transaction
      • redeem_cycle (integer): Redemption cycle or frequency
      • currency_id (string): Currency identifier for the redemption configuration
      • is_active (boolean): Whether this redemption configuration is currently active

Constants​

Redeem Types​

  • REDEEM_TYPE_CASHBACK = 1: Points can be redeemed for cashback
  • REDEEM_TYPE_VOUCHER = 2: Points can be redeemed for vouchers

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/reward_promotion/points_redeem_config?user_type=2&currency_id=1f1519903ed240578f071aa45cb479f2' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: b35d332f-131e-44c1-892f-8322e022da74' \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3NzY5NDU0fQ.QMvK_JLnYBE6XYaFdyg16aVupTONBO7eMGDmzAGVhVg'

Notes​

  • This API retrieves the redemption configuration for a specific user type and currency
  • Both user_type and currency_id are required parameters
  • The response includes redemption rules, limits, and available redemption types
  • voucher_details will be null for cashback redemptions (redeem_type = 1)
  • is_active indicates whether the configuration is currently available for use
  • Redemption limits (min_points_to_redeem, max_points_to_redeem) help control redemption behavior