Rewards API

Rewards API Reference: Supplier API

Get a list of prepaids


POST /reward/prepaids/list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "operator_id": 1,
  "game_code": "clt_softwareid"
}

Returns the list of available prepaids. A prepaid is a reward template which specifies obtainable rounds or spins (reward_count), value of each round or spin (reward_value), and the currency of the reward per game. For bonus_buy prepaids, the reward_count does not matter. reward_value specifies the worth of the bonus.

Header parameters

  • uX-Niropa-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body

  • operator_id - integer · required

    • The unique identifier of Niropa configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

    • Example: 1

  • game_code - string | null · optional

    • The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

    • Example: clt_softwareid

Responses
[
  {
    "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
    "game_code": "clt_softwareid",
    "currency": "EUR",
    "reward_value": 0,
    "reward_count": 5,
    "bonus_buy": true,
    "meta": {}
  }
]

Create a reward


POST /reward/rewards/create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "currency": "EUR",
  "user": "john12345",
  "sub_partner_id": "my-platform-id",
  "start_time": "2017-11-05T13:15:30",
  "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
  "operator_id": 1,
  "game_code": "clt_softwareid",
  "end_time": "2017-11-05T13:15:30",
  "reward_value": 0,
  "reward_count": 5
}

Endpoint for creating rewards. Should support creating rewards.

Creating a Single-use reward:

  1. Get a list of available prepaids via /prepaids/list and select a prepaid.

  2. Add the prepaid_uuid to request.

  3. If reward_value and/or reward_count in the prepaid is NULL, you can enter any values. Otherwise, the values from the prepaid will be used to create the reward.

Header parameters

  • uX-Niropa-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body

  • reward_uuid - string · required

    • The unique identifier for an reward on Niropa side in standard 16-byte UUID format.

    • Example: a28f93f2-98c5-41f7-8fbb-967985acf8fe

  • currency - string · enum · optional

    • The ISO 4217 currency code. The following list contains all currencies supported by the Niropa system. Note that native game play support with these currencies may vary per Provider.

    • Example: EUR

    • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

  • user - string · required

    • The unique user ID in the Niropa's system. In case of DEMO gameplay, this parameter may be omitted.

    • Example: john12345

  • sub_partner_id - string · optional

    • ID of an Niropa's sub-partner (brand, whitelabel, site, etc.) which uses the same integration and credentials as the Niropa. Used for detailed reporting and integration type switching.

    • Example: my-platform-id

  • start_time - string · ISO-8601 · optional

    • The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

    • Example: 2017-11-05T13:15:30

  • prepaid_uuid - string · optional

    • Standard 16-byte unique user ID (UUID) on Niropa side referencing a prepaid reward.

    • Example: 0e6bde62-4713-4b85-b510-59f0d729d8f7

  • operator_id - integer · required

    • The unique identifier of Niropa configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

    • Example: 1

  • game_code - string | null · optional

    • The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

    • Example: clt_softwareid

  • end_time - string · ISO-8601 · optional

    • The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

    • Example: 2017-11-05T13:15:30

  • reward_value - integer · optional

    • The amount of money displayed in integer (Int64) format. To convert real float value to integer, it is multiplied by 100000. Example: $3.56 is represented as 356000

    • Example: 100500

  • reward_count - integer · optional

    • The amount of spins / game rounds to be granted.

    • Example: 5

Responses
{
  "user": "john12345",
  "start_time": "2017-11-05T13:15:30",
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
  "game_code": "clt_softwareid",
  "end_time": "2017-11-05T13:15:30",
  "currency": "EUR",
  "reward_value": 0,
  "reward_count": 5
}

Cancel a reward


POST /reward/rewards/cancel HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "operator_id": 1
}

Endpoint for canceling an reward. Please note that reward already claimed by user cannot be canceled.

Header parameters

  • uX-Niropa-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body

  • reward_uuid - string · optional

    • The unique identifier for a reward on Niropa side in standard 16-byte UUID format.

    • Example: a28f93f2-98c5-41f7-8fbb-967985acf8fe

  • operator_id - integer · required

    • The unique identifier of Niropa configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

    • Example: 1

Responses
{
  "user": "john12345",
  "start_time": "2017-11-05T13:15:30",
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
  "game_code": "clt_softwareid",
  "end_time": "2017-11-05T13:15:30",
  "currency": "EUR",
  "reward_value": 0,
  "reward_count": 5
}