PayOut

Overview

The PayOut endpoint is used to process the payout transaction once the outcome of a bet is determined. This endpoint communicates the result of a game round by registering the winnings (or confirming a loss) for a placed bet. By doing so, it finalizes the bet lifecycle and updates the user’s balance accordingly.

The PayOut method allows to:

Process Bet Outcomes: Once the game round is completed, and the outcome (win/loss) is determined, this endpoint is used to process the payout.

Update User Balance: The response from the endpoint includes the updated account balance after the win is credited or a confirmed loss is acknowledged.

Link Transactions: The method uses a unique bet identifier (betId) that ties together the cash flow transactions (starting from bet placement via PayIn/PayInOut through to the eventual payout), ensuring traceability and consistency within one betting event.

Security and Authentication

The PayOut 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/pay-out' \ --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", "winAmount": 55.25, "winOdd": 11.05 }'

Overview#

Security and Authentication#

Path Parameters#

Request

Responses

Overview

Security and Authentication

Path Parameters