Create and Grant FRB

Create and Grant FRB

Creates a new FRB template and immediately grants it to a player in a single atomic operation.

Request endpoint: /frb/create/{version}/template-and-grant

Request Method: POST

Usage information

This unified endpoint combines template creation and player granting, eliminating the need for separate API calls and reducing the complexity of the FRB workflow. The template is created and immediately assigned to the specified player in a single transaction.

Request parameters:

Request Body

{
  "providerName": "Quickfire",
  "operatorId": 123,
  "playerId": "PLAYER_456",
  "playerCurrency": "USD",
  "playerCountry": "US",
  "offerName": "WELCOME_BONUS_001",
  "numberOfRounds": 5,
  "availableDuration": 30,
  "useDefaultAmount": false,
  "templateId": "TMP_9876543210fedcba",
  "transactionId": "TXN_1234567890abcdef",
  "games": [
    {
      "gameId": "GAME_123",
      "betAmount": [100]
    }
  ]
}

Request Body Fields

Response Parameters:

The response body includes comprehensive information about both the created template and the grant operation.

Example Response:

Success response:

{
  "id": "507f1f77bcf86cd799439011",
  "status": "Success",
  "template": {
    "templateId": "TMP_1234567890",
    "providerName": "Quickfire",
    "providerId": 27,
    "operatorId": 123,
    "transactionId": "550e8400-e29b-41d4-11e8-b566-0800200c9a66",
    "numberOfRounds": 5,
    "availableFromDate": "2024-01-01 10:00:00",
    "availableDuration": 30,
    "expirationDate": "2024-01-31 10:00:00",
    "offerName": "WELCOME_BONUS_001",
    "gameInfoList": [
      {
        "gameId": "GAME_123",
        "betAmount": [100]
      }
    ],
    "players": [
      {
        "playerId": "PLAYER_456",
        "playerCurrency": "USD",
        "playerCountry": "US"
      }
    ]
  },
  "grant": {
    "templateId": "TMP_1234567890",
    "transactionId": "550e8400-e29b-41d4-11e8-b566-0800200c9a66",
    "status": "Success",
    "message": "Template awarded successfully",
    "playerId": "PLAYER_456",
    "playerCurrency": "USD",
    "playerCountry": "US",
    "exceptionResponses": []
  }
}

Response Body Fields

Error Response:

{
  "error": "invalid request"
}

Or for validation errors:

[
  "Game validation error: invalid game id",
  "Number of rounds must be greater than 0"
]

Response codes:

Key Features

Atomic Operation

The template creation and player granting happen in a single transaction, ensuring data consistency. If either operation fails, the entire request is rolled back.

Idempotency

Duplicate requests are prevented using a combination of templateId and transactionId. If the same request is sent within a 120-second window, the cached response is returned instead of processing the request again.

Template Reuse

The system automatically checks if an identical template already exists (based on provider, operator, games, and offer details). If found, it reuses the existing template instead of creating a duplicate.

Simplified Workflow

Instead of making two separate API calls:

1. Create Template ✗
2. Grant to Player ✗

You now make one call:

1. Create and Grant ✓

This reduces network overhead, processing time, and potential for errors between operations.

Use Cases

This endpoint is ideal for:

• Welcome bonuses - Creating and immediately granting a bonus when a new player registers
• Promotional campaigns - Instantly rewarding players with free spins during special events
• Player incentives - Immediate bonus grants as part of VIP programs or loyalty rewards
• One-time offers - Single-player, single-game bonuses that don’t require template reuse

Comparison with Standard Flow

Example Workflow

Best Practices

1. Idempotency Keys - Always provide templateId and transactionId for important operations to ensure idempotency
2. Error Handling - Check both status field and grant.exceptionResponses array for any issues
3. Single Game Limit - Remember this endpoint only supports one game per request
4. Bet Amounts - Specify bet amounts in cents (e.g., 100 for 1.00 EUR)
5. Player Currency - Ensure the player’s currency matches their actual account currency
6. Template ID Storage - Store the returned grant.templateId for future status checks and cancellations