Refund

Overview

The Refund endpoint allows the Game Provider to initiate a refund for a bet. This method is used when a bet needs to be reversed — whether due to an error in bet processing, game logic, or any other reason that requires returning the wagered amount back to the user. By calling this endpoint, the Aggregator updates the user's balance by re-crediting the refunded amount.

The main objectives of the Refund method are:

Reversal of a Bet Transaction: It is used to reverse the wagered amount when a bet cannot be completed as intended. This ensures that the funds, which have been previously deducted, are correctly returned to the user.

Error Handling and Transaction Correction: In scenarios where there is a processing error, or the game outcome fails to be determined correctly, a Refund call is made to correct the transaction, thus safeguarding the integrity of the user's account balance.

Maintaining Consistency: The use of a unique bet identifier (betId) ties the refund back to its corresponding bet, ensuring consistency and traceability across all cash flow transactions related to a specific bet.

Security and Authentication

The Refund endpoint, like other API requests within this integration, requires strict authentication to ensure that only authorized parties can interact with it. This is achieved through the use of mandatory HTTP headers. Please see the required headers below in the Header Params section.

📌

Signature of the request shall be calculated using HMAC-SHA256 algorithm and sent in "X-Sign" header of the request.
Please see How to calculate the X-Sign value.

Path Parameters

Parameter	Type	Required	Description
sessionId	string	Yes	Game Session id.

curl --location -g --request POST '/v1/sessions/{{sessionId}}/bets/refund' \ --header 'X-Counterparty-Id: 933a215f-a9e6-4f88-9d91-52a87cd50499' \ --header 'X-Timestamp: 1719766120806' \ --header 'X-Request-Id: 5a0679b6e5fa48f6892c777b0fa92392' \ --header 'X-Sign: c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1' \ --header 'Content-Type: application/json' \ --data-raw '{ "betId": "4178696881" }'

Overview#

Security and Authentication#

Path Parameters#

Request

Responses

Overview

Security and Authentication

Path Parameters