Comment on page

OTP (Beta)

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.

POST - OTP

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

Request

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 player in your database.
redeemedAmount
number
Yes
Monetary value in your system currency to be redeemed.
Note: - Amount must be positive.

Sample Request Body

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

Usage Example

The example shown is a request sent to Gameball to generate an OTP to your player as per your SMS configurations.
cURL
curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703' -d
'{
"playerUniqueId":"player456",
"redeemedPoints": 20
}' -v -i
'https://api.gameball.co/api/v3.0/integrations/otp'