v1

latestOpenAPI 3.0.2raw.githubusercontent.com2025-10-15392455.7 KB
Session

Create Bid Session

Create a session with a provider using a bid ID and associate it with the API key.

This endpoint creates a session and automatically associates it with the API key used for authentication. Each API key can have at most one active session at a time.

post/api/v1/session/bidsession

Query parameters

bid_idstring required

The blockchain ID (hex) of the bid to create a session for

The blockchain ID (hex) of the bid to create a session for

Request body

sessionDurationinteger
directPaymentboolean
failoverboolean

Response

Successful Response

{"stackTrail":"paths:/api/v1/session/bidsession:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}