Wallet API

The endpoints need to be implemented by the Operator and made available for Hub88 to call.

Wallet API is an API to integrate Seamless wallet logic to Hub88. The API works in a manner where Hub88 is the consumer and the Operator needs to provide corresponding endpoints based on the following API structures. Wallet API also has its own response status codes available here.

---

Wallet API Reference

---

Get user's info

---

post

Provides a player's data. The Operator is expected to return all available details.

Header parameters

X-Hub88-SignaturestringRequired

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

application/json

userstringRequired

The unique User ID in the Operator’s system. When generating the value, avoid using any real user data, that could be used to identify the person (e.g. full name, phone, email). Minimum value 4 characters.

Example: john12345

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

Responses

200

OK

application/json

Wallet API response

userstringRequired

Unique user ID in the Operator’s system. When generating the value, avoid using any real user data, that could be used to identify the person (e.g. full name, phone, email). Minimum value 4 characters.

Example: john12345

statusstring · enumRequired

Response status

Example: RS_OKPossible values:

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

countrystring · enumRequired

The ISO 3166-1 country code, applicable to the User in the current session.

Example: EEPossible values:

jurisdictionstring · enumOptional

Jurisdiction the player should play in

Example: MGAPossible values:

sub_partner_idstringOptional

ID of Operator's sub-partner (brand, whitelabel, site, etc.) which uses same integration and credentials as an Operator. Used for detailed reporting and integration type switching. Sites under the same Operator can use different integration types: TransferWallet or SeamlessWallet. A single site (sub_partner_id) can NOT have both kinds of integration at the same time.

Example: my-casino-id

birth_datestringOptional

Birth date of the player

Example: 1980-10-20

registration_datestringOptional

Registration date of the player

Example: 2010-10-20

tagsstring[]Optional

List of tags applied to the player

sexstring · enumOptional

Sex of the player

Example: MALEPossible values:

affiliate_idstringOptional

ID of the affliate that brought the player to the platform

Example: 123_af

post

/user/info

HTTPcURLJavaScriptPython

POST /user/info HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "user": "john12345",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af"
}

200

OK

{
  "user": "john12345",
  "status": "RS_OK",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "country": "FR",
  "jurisdiction:": "MGA",
  "sub_partner_id": "123_sub",
  "birth_date": "1980-10-20",
  "registration_date": "2010-10-20",
  "tags": [
    "VIP",
    "affiliate"
  ],
  "sex": "MALE",
  "affiliate_id": "124_af"
}

---

Get user's balance

---

post

Called when the player's balance is needed. The Operator is expected to return player's current balance. The Game code is provided to help the Operator with player's activity statistics.

Header parameters

X-Hub88-SignaturestringRequired

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

application/json

userstring · min: 3Required

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

Example: john12345

tokenstringRequired

The game session token that was passed within /game/url endpoint response.

Example: 55b7518e-b89e-11e7-81be-58404eea6d16

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

game_codestringRequired

The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.

Example: clt_dragonrising

Responses

200

OK

application/json

Wallet API response

userstring · min: 3Required

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

Example: john12345

statusstring · enumRequired

Response status

Example: RS_OKPossible values:

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.

Example: EURPossible values:

balanceintegerOptional

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

post

/user/balance

HTTPcURLJavaScriptPython

POST /user/balance HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "user": "john12345",
  "token": "55b7518e-b89e-11e7-81be-58404eea6d16",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "game_code": "clt_dragonrising"
}

200

OK

{
  "user": "Jimm123",
  "status": "RS_OK",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "currency": "USD",
  "balance": 100500
}

---

Update user's balance based on transaction win

---

post

Called when the User wins (credit). The Operator is expected to increase player's balance by amount and return a new balance. The reference_transaction_uuid is used to show to which bet the win is related to. Each win has transaction_uuid which is unique identifier of this transaction. Before any altering of User's balance, Operator has to check that win wasn't processed before. Retry Policy: In case of network fail (HTTP 502, timeout, nxdomain, etc.) we will retry 3 times with 1 sec of timeout. The rest of retry logic is left to provider's RGS: the retries may continue indefinitely or the bet may be rolled back, and the money returned back to user.

Header parameters

X-Hub88-SignaturestringRequired

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

application/json

userstring · min: 3Required

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

Example: john12345

transaction_uuidstringRequired

The unique transaction identifier. An ID of business logic action (transaction) that needs to be stored on both sides for at least 4 months (for reconciliation purposes). Operator has to respond on each transaction_uuid. An action with same transaction_uuid shouldn't be processed more than once.

Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

supplier_transaction_idstringRequired

The transaction identifier received from the game Supplier. This identifier will be used to investigate any issues via customer support tickets.

Example: 41ecc3ad-b181-4235-bf9d-acf0a7ad9730

tokenstringRequired

The game session token that was passed within /game/url endpoint request.

Example: 55b7518e-b89e-11e7-81be-58404eea6d16

supplier_userstringRequired

The name of the user in the Provider’s system. In case Operator needs to find a user in Provder’s back office or report a problem with the user. If the value is NULL, the Operator can search for their own user_id.

Example: cg_45141

round_closedbooleanRequired

Denotes when the round is closed. Can be null.

Example: true

roundstringRequired

The game round ID used to relate all bets and wins made in one round. All transactions related to the same round have the same value in this field. The ID is not unique through whole system. The value depends on provider’s RGS logic, as it is created from game + user + round combination, resulting in uniqueness. The value can be null or omitted.

Example: JB007

reward_uuidstringOptional

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

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

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

reference_transaction_uuidstringRequired

Unique identifier of the transaction that this transaction is referencing. In case of a rollback, this field will contain transaction_uuid of the transaction which needs to be rolled back. In case of a win, there will be transaction_uuid of the bet to which this win is related to.

Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

is_freebooleanRequired

The flag which indicates that the transaction is tied to a reward issued via Hub88’s Freebets API. Set to true only when the transaction is the result of a previously created reward. When false or omitted, the transaction is not connected to a Hub88 Freebets API (e.g. the transaction is a regular gameplay or supplier-managed promotions). Can be null.

Example: true

is_supplier_promobooleanOptional

Indicates that the promotion was created and granted by the game Supplier. When set to true, the system treats the transaction as a supplier-issued free promotion. Default value false. With this parameter, it's necessary for an Operator to NOT validate the expiration of the token as bet and win transactions could belong to inactive/staled session on operator side. token should be verified to be valid.

is_aggregatedbooleanOptional

The flag which shows that related freebet transactions identified in the field reward_uuid have been aggregated into one single transaction. For example, a player was rewarded ten (10) freespins, but Hub88 sends one single transaction request with field is_aggregated set to true. The value can be null or omitted.

game_codestringRequired

The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.

Example: clt_dragonrising

currencystring · enumRequired

The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.

Example: EURPossible values:

betstringRequired

The field for metadata related to transaction, such as type of bet, value, time, etc. Differs from game to game. Not relevant for transaction processing procedure but could be useful for statistics or activity backtracking. The value can be null or omitted.

Example: zero

amountintegerRequired

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

Responses

200

OK

application/json

Wallet API response

userstring · min: 3Required

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

Example: john12345

statusstring · enumRequired

Response status

Example: RS_OKPossible values:

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.

Example: EURPossible values:

balanceintegerOptional

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

post

/transaction/win

HTTPcURLJavaScriptPython

POST /transaction/win HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 666

{
  "user": "john12345",
  "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "supplier_transaction_id": "41ecc3ad-b181-4235-bf9d-acf0a7ad9730",
  "token": "55b7518e-b89e-11e7-81be-58404eea6d16",
  "supplier_user": "cg_45141",
  "round_closed": true,
  "round": "JB007",
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "reference_transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "is_free": true,
  "is_supplier_promo": false,
  "is_aggregated": false,
  "game_code": "clt_dragonrising",
  "currency": "EUR",
  "bet": "zero",
  "amount": 100500,
  "meta": {
    "operator_reference": "reward_001",
    "campaign_uuid": "7b5c8a93-4d3a-4bfb-8554-f923d46aa485"
  }
}

200

OK

{
  "user": "Jimm123",
  "status": "RS_OK",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "currency": "USD",
  "balance": 100500
}

---

Update user balance based on transaction bet

---

post

The endpoint called when a User places a bet (debit). The Operator is expected to decrease the player's balance by the amount value and return a new balance. Each bet has a unique identifier ( transaction_uuid) for this transaction. Before altering the user's balance, the Operator has to check that the bet wasn't processed before. There might be Retry Policy: In case of network fail (HTTP 502, timeout, nxdomain, etc.), we will retry 3 times with 1 sec of timeout. If we do not receive 200 HTTP status, this transaction will be counted as failed and rollback will be generated (to ensure that failed bet hadn’t affected User’s balance). This rollback will be retried 500 times (or less if we get logical response) with exponential back off.

Header parameters

X-Hub88-SignaturestringRequired

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

application/json

userstring · min: 3Required

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

Example: john12345

transaction_uuidstringRequired

The unique transaction identifier. An ID of business logic action (transaction) that needs to be stored on both sides for at least 4 months (for reconciliation purposes). Operator has to respond on each transaction_uuid. An action with same transaction_uuid shouldn't be processed more than once.

Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

supplier_transaction_idstringRequired

The transaction identifier received from the game Supplier. This identifier will be used to investigate any issues via customer support tickets.

Example: 41ecc3ad-b181-4235-bf9d-acf0a7ad9730

tokenstringRequired

The game session token that was passed within /game/url endpoint response.

Example: 55b7518e-b89e-11e7-81be-58404eea6d16

supplier_userstringRequired

The name of the user in the Provider’s system. In case Operator needs to find a user in Provder’s back office or report a problem with the user. If the value is NULL, the Operator can search for their own user_id.

Example: cg_45141

round_closedbooleanRequired

Denotes when the round is closed. Can be null.

Example: true

roundstringRequired

The game round ID used to relate all bets and wins made in one round. All transactions related to the same round have the same value in this field. The ID is not unique through whole system. The value depends on provider’s RGS logic, as it is created from game + user + round combination, resulting in uniqueness. The value can be null or omitted.

Example: JB007

reward_uuidstringOptional

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

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

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

is_freebooleanRequired

The flag which indicates that the transaction is tied to a reward issued via Hub88’s Freebets API. Set to true only when the transaction is the result of a previously created reward. When false or omitted, the transaction is not connected to a Hub88 Freebets API (e.g. the transaction is a regular gameplay or supplier-managed promotions). Can be null.

Example: true

is_supplier_promobooleanOptional

Indicates that the promotion was created and granted by the game Supplier. When set to true, the system treats the transaction as a supplier-issued free promotion. Default value false. With this parameter, it's necessary for an Operator to NOT validate the expiration of the token as bet and win transactions could belong to inactive/staled session on operator side. token should be verified to be valid.

is_aggregatedbooleanOptional

The flag which shows that related freebet transactions identified in the field reward_uuid have been aggregated into one single transaction. For example, a player was rewarded ten (10) freespins, but Hub88 sends one single transaction request with field is_aggregated set to true. The value can be null or omitted.

game_codestringRequired

The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.

Example: clt_dragonrising

currencystring · enumRequired

The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.

Example: EURPossible values:

betstringRequired

The field for metadata related to transaction, such as type of bet, value, time, etc. Differs from game to game. Not relevant for transaction processing procedure but could be useful for statistics or activity backtracking. The value can be null or omitted.

Example: zero

amountintegerRequired

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

Responses

200

OK

application/json

Wallet API response

userstring · min: 3Required

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

Example: john12345

statusstring · enumRequired

Response status

Example: RS_OKPossible values:

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.

Example: EURPossible values:

balanceintegerOptional

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

post

/transaction/bet

HTTPcURLJavaScriptPython

POST /transaction/bet HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 598

{
  "user": "john12345",
  "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "supplier_transaction_id": "41ecc3ad-b181-4235-bf9d-acf0a7ad9730",
  "token": "55b7518e-b89e-11e7-81be-58404eea6d16",
  "supplier_user": "cg_45141",
  "round_closed": true,
  "round": "JB007",
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "is_free": true,
  "is_supplier_promo": false,
  "is_aggregated": false,
  "game_code": "clt_dragonrising",
  "currency": "EUR",
  "bet": "zero",
  "amount": 100500,
  "meta": {
    "operator_reference": "reward_001",
    "campaign_uuid": "7b5c8a93-4d3a-4bfb-8554-f923d46aa485"
  }
}

200

OK

{
  "user": "Jimm123",
  "status": "RS_OK",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "currency": "USD",
  "balance": 100500
}

---

Rollback transaction

---

post

Called when there is need to roll back the effect of the referenced transaction. The Operator is expected to find the referenced transaction, roll back its effects and return the player's new balance.

Header parameters

X-Hub88-SignaturestringRequired

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

application/json

userstring · min: 3Required

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

Example: john12345

transaction_uuidstringRequired

The unique transaction identifier. An ID of business logic action (transaction) that needs to be stored on both sides for at least 4 months (for reconciliation purposes). Operator has to respond on each transaction_uuid. An action with same transaction_uuid shouldn't be processed more than once.

Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

supplier_transaction_idstringRequired

The transaction identifier received from the game Supplier. This identifier will be used to investigate any issues via customer support tickets.

Example: 41ecc3ad-b181-4235-bf9d-acf0a7ad9730

tokenstringRequired

The game session token that was passed within /game/url endpoint response.

Example: 55b7518e-b89e-11e7-81be-58404eea6d16

round_closedbooleanOptional

Denotes when the round is closed. Can be null.

Example: true

roundstringRequired

The game round ID used to relate all bets and wins made in one round. All transactions related to the same round have the same value in this field. The ID is not unique through whole system. The value depends on provider’s RGS logic, as it is created from game + user + round combination, resulting in uniqueness. The value can be null or omitted.

Example: JB007

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

reference_transaction_uuidstringRequired

Unique identifier of the transaction that this transaction is referencing. In case of a rollback, this field will contain transaction_uuid of the transaction which needs to be rolled back. In case of a win, there will be transaction_uuid of the bet to which this win is related to.

Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

game_codestringRequired

The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.

Example: clt_dragonrising

metaobjectOptional

The transaction metadata, enriches the transaction payload for processing. The value can be null or omitted.

Responses

200

OK

application/json

Wallet API response

userstring · min: 3Required

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

Example: john12345

statusstring · enumRequired

Response status

Example: RS_OKPossible values:

request_uuidstringRequired

An ID of an action that is generated for each of our calls to the Operator, used to sync Hub88 and Operator sides for debugging purposes, displayed in standard 16-byte UUID format. The Operator has to respond with the same request_uuid as the one received in request.

Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.

Example: EURPossible values:

balanceintegerOptional

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

post

/transaction/rollback

HTTPcURLJavaScriptPython

POST /transaction/rollback HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "user": "john12345",
  "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "supplier_transaction_id": "41ecc3ad-b181-4235-bf9d-acf0a7ad9730",
  "token": "55b7518e-b89e-11e7-81be-58404eea6d16",
  "round_closed": true,
  "round": "JB007",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "reference_transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "game_code": "clt_dragonrising",
  "meta": {}
}

200

OK

{
  "user": "Jimm123",
  "status": "RS_OK",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "currency": "USD",
  "balance": 100500
}