> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gameball.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Hold Details

> Retrieve details of held points for a specific hold reference.

<Info>
  Security: Provide both `apikey` and `secretkey` headers.
</Info>


## OpenAPI

````yaml GET /api/v4.0/integrations/transactions/hold/{holdReferenceId}
openapi: 3.1.0
info:
  title: Gameball API
  description: >-
    Gameball REST API v4.0 - Complete API reference for integrating loyalty,
    gamification, and customer engagement features
  version: 4.0.0
servers:
  - url: https://api.gameball.co
security:
  - bearerAuth: []
paths:
  /api/v4.0/integrations/transactions/hold/{holdReferenceId}:
    get:
      description: >-
        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.
      parameters:
        - name: holdReferenceId
          in: path
          required: true
          schema:
            type: string
          description: >-
            Unique identifier for the hold transaction, used to retrieve the
            details of the specific hold.
      responses:
        '200':
          description: Hold details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  customerId:
                    type: string
                    description: >-
                      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.
                    example: cust_abc12345xyz67890
                  holdAmount:
                    type: number
                    description: >-
                      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.
                    example: '2'
                  holdEquivalentPoints:
                    type: number
                    description: >-
                      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).
                    example: 20
                  state:
                    type: string
                    description: >-
                      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).
                    example: active
                  dateToExpire:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the hold will expire. After this
                      time, the hold reference will no longer be valid for
                      usage.
                    example: '2024-10-16T08:11:24.675401'
      security:
        - apiKey: []
          secretKey: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````