Changed on

This API cancels a specific hold on loyalty points in Gameball using the provided holdReferenceId. It releases the held points back into the customer's account, enabling flexibility in point management.

delete/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 release the held points or amount.

Response

Hold released successfully

successboolean

Indicates whether the hold was successfully released.

messagestring

Confirmation message indicating the hold has been released.

Example response

{
  "success": true,
  "message": "Hold released successfully"
}

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