Skip to main content
POST
/
api
/
v4.0
/
integrations
/
transactions
/
otp
cURL
curl --request POST \
  --url https://api.gameball.co/api/v4.0/integrations/transactions/otp \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "customerId": "cust_abc12345xyz67890",
  "email": "alex.jones@example.com",
  "mobile": "+1234567890",
  "amount": 100,
  "points": null,
  "ruleId": null
}
'

​
Generate OTP

The API call generates a new one-time password (OTP) for redeeming or holding loyalty points and sends it via SMS. This service ensuring that only authorized transactions can be completed with the provided OTP.
This API is effective only if SMS & OTP are enabled in your Gameball account. Contact support for more information.
Channel Merging Available If your system uses different customer IDs across multiple channels (e.g., online and offline), Gameball’s channel merging feature helps unify customer profiles. By including the customer’s mobile number or email (based on your merging configuration) with each request, Gameball will combine activities into a single profile.For more information, head to the Channel Merging Guide.
Security: Provide both apikey and secretkey headers.

Authorizations

​
apikey
string
header
required

Body

application/json
​
customerId
string
required

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"

​
email
string

Customer's email address. This is required if your account uses email-based channel merging.

Example:

"alex.jones@example.com"

​
mobile
string

Customer's mobile number. This is required if your account uses mobile-based channel merging.

Example:

"+1234567890"

​
amount
number

The monetary value associated with the redemption or hold operation for which the OTP is being generated. This allows you to secure specific financial transactions by tying the OTP to an exact amount. Note: Only one of ruleId, points, or amount must be provided for the OTP request to proceed.

Example:

100

​
points
integer

The number of loyalty points for which the OTP is being generated. This allows the customer to redeem or hold a specific quantity of points, adding an extra layer of security to the transaction. Note: Only one of ruleId, points, or amount must be provided for the OTP request to proceed.

Example:

null

​
ruleId
integer

The ID of a redemption rule configured within Gameball's system that the customer wants to use. Clients can create custom redemption rules through the Gameball dashboard to specify different redemption options. For example, a redemption rule may allow points to be redeemed for a free product, free shipping, percentage-based discounts, or fixed-amount discounts. You can retrieve your configured redemption rules and their associated IDs by using the Redemption Configuration API. Note: Only one of ruleId, points, or amount must be provided for the OTP request to proceed.

Example:

null