OTP

This Endpoint is specific for accounts which requires OTP to proceed with some specific operations (i.e. Redeem Transaction Endpoint)

To use this endpoint, you need to make sure that your account has OTP configuration enabled. In addition to the OTP configuration, you need to make sure that your SMS configurations are set and enabled.

Upon enabling this endpoint, some endpoints may require additional parameter (otp) in order to validate the payload sent.

mobile or email should be sent along with the playerUniqueId in case (only if) your account supports channel merging.

POST - OTP

https://api.gameball.co/api/v3.0/integrations/otp

Request

Header

Attribute	Type	Required	Description
APIKey	string	Yes	Client API key
secretKey	string	Yes	Client Secret key

Body

Attribute	Type	Required	Description
playerUniqueId	string	Yes	Unique identifier for the customer in your database.
mobile	string	No	Customer's unique mobile number. (Sent in case your account supports channel merging)
email	string	No	Customer's unique email. (Sent in case your account supports channel merging)
amount	number	No	Monetary value in your system currency to be redeemed. Note: - Amount must be positive. - If this field is set, then the the other fields value should be null. Also, all fields couldn't be null.
points	number	No	Points to be held from the customer points balance on Gameball. Note: - Points must be positive. - If this field is set, then the the other fields value should be null. Also, all fields couldn't be null.
ruleId	number	No	Redemption rule to be held from the customer points balance on Gameball. Note: - If this field is set, then the the other fields value should be null. Also, all fields couldn't be null.

Sample Request Body (With amount)

{
   "playerUniqueId":"player456",
   "amount": 20,
}

Sample Request Body (With points)

{
   "playerUniqueId":"player456",
   "points": 20,
}

Sample Request Body (With ruleId)

{
   "playerUniqueId":"player456",
   "ruleId": 123,
}

Sample Response

{
    "code": 1,
    "message": "Process Completed Successfully"
}

Usage Example

The example shown is a request sent to Gameball to generate an OTP to your customer as per your SMS configurations.

cURL (Amount)

curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703' -d 
 '{
   "playerUniqueId":"player456",
   "amount": 20
  }' -v -i 
'https://api.gameball.co/api/v3.0/integrations/otp'

cURL (Points)

curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703' -d 
 '{
   "playerUniqueId":"player456",
   "points": 20
  }' -v -i 
'https://api.gameball.co/api/v3.0/integrations/otp'

cURL (RuleId)

curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703' -d 
 '{
   "playerUniqueId":"player456",
   "ruleId": 123
  }' -v -i 
'https://api.gameball.co/api/v3.0/integrations/otp'