Changed on

This API retrieves the details of a specific hold in Gameball using holdReferenceId. It returns information on the amount of loyalty points held, their monetary value, the hold's status (active, used, or expired), and the time remaining until expiration, supporting effective management and tracking of held points.

get/api/v4.0/integrations/transactions/hold/{holdReferenceId}

Request

  • Base URL: https://api.gameball.co
  • URL: https://api.gameball.co/api/v4.0/integrations/transactions/hold/{holdReferenceId}
  • Auth: API key in header apikey and API key in header secretkey

Path parameters

holdReferenceIdstring required

Unique identifier for the hold transaction, used to retrieve the details of the specific hold.

Response

Hold details retrieved successfully

customerIdstring

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

holdAmountnumber

The monetary value held from the customer's points balance in this specific hold transaction. This is the amount that has been reserved and is associated with the holdReference provided. Example: If a customer has reserved $50 worth of points, the holdAmount in the response would be 50, representing the monetary value currently held under the specified hold reference.

holdEquivalentPointsnumber

The number of points held from the customer's points balance for this specific hold transaction. This represents the exact quantity of points currently locked under the holdReference provided. Example: If the system has held 200 points from the customer's balance, the holdEquivalentPoints in the response would be 200, indicating the points associated with the provided hold reference that are currently unavailable for redemption until further action is taken (e.g., redemption or expiration).

statestring

The current status of the hold: Active (The hold is currently in effect and the points or amount are locked), Expired (The hold has expired and the points or amount have been released), Used (The hold has been used, meaning the points or amount have been redeemed).

dateToExpirestring date-time

The date and time when the hold will expire. After this time, the hold reference will no longer be valid for usage.

Example response

{
  "customerId": "cust_abc12345xyz67890",
  "holdEquivalentPoints": 20,
  "state": "active",
  "dateToExpire": "2024-10-16T08:11:24.675401"
}

Changes

  • 262228c13429Revision changes
    • info

      the endpoint scheme security apiKey AND secretKey was added to the API

    • info

      the endpoint scheme security apiKey was removed from the API

    • info

      the endpoint scheme security secretKey was removed from the API

  • 919eb7a392aaRevision changes
    • breaking

      api path removed without deprecation