Skip to main content

Get User Points Redeem API

Overview​

Retrieve the redemption history of user reward points, including details about redeemed points, amounts, and transaction information.

API Details​

Endpoint​

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

Headers​

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

Query Parameters​

Required Parameters​

  • user_id (string, required): Unique identifier of the user

    • Format: UUID string
    • Example: "fb8f09210e0f46b7b4262d77f5b6c273"

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

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

Optional Parameters​

  • skip (integer, optional): Number of records to skip for pagination

    • Default: 0
    • Example: 0, 10, 20

  • limit (integer, optional): Maximum number of records to return

    • Default: 10
    • Example: 10, 25, 50

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "user_points_redeem": [
            {
                "id": "1a97fec2fad14d8690916ee617a8a2fc",
                "user_id": "fb8f09210e0f46b7b4262d77f5b6c273",
                "points": 10.0,
                "transaction_id": null,
                "amount": 10.0,
                "description": "Reward points redeemed as cashback.",
                "currency_id": "1f1519903ed240578f071aa45cb479f2",
                "created_date": 1757168623
            },
            {
                "id": "2e5534156f984832929ec63e12edb519",
                "user_id": "fb8f09210e0f46b7b4262d77f5b6c273",
                "points": 10.0,
                "transaction_id": null,
                "amount": 10.0,
                "description": "Reward points redeemed as cashback.",
                "currency_id": "1f1519903ed240578f071aa45cb479f2",
                "created_date": 1757166529
            }
        ]
    }
}

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_points_redeem (array): Array of user points redemption history
      • id (string): Unique identifier for the redemption record
      • user_id (string): User's unique identifier
      • points (number): Number of points that were redeemed
      • transaction_id (string|null): Associated transaction identifier (may be null)
      • amount (number): Amount credited to the wallet from the redemption
      • description (string): Human-readable description of the redemption
      • currency_id (string): Currency identifier for the redemption
      • created_date (integer): Unix timestamp when the redemption was created

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/reward_promotion/user_points_redeem?skip=0&limit=10&user_id=fb8f09210e0f46b7b4262d77f5b6c273&currency_id=1f1519903ed240578f071aa45cb479f2' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3NzY5NDU0fQ.QMvK_JLnYBE6XYaFdyg16aVupTONBO7eMGDmzAGVhVg' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: b35d332f-131e-44c1-892f-8322e022da74'

Notes​

  • This API retrieves the redemption history for a specific user and currency
  • Both user_id and currency_id are required parameters
  • Use skip and limit parameters for pagination
  • The response includes details about each redemption transaction
  • transaction_id may be null for some redemption records
  • The description provides context about the type of redemption (e.g., "cashback")