0Bit public documentation
The GateSession object
The server-bound session used by Gate embeds and reconciliation.
A GateSession belongs to one partner and one credential mode. The partner server fixes commercial inputs before handing the returned client_secret to the browser.
| Field | Type | Meaning |
|---|---|---|
id |
string | Gate session identifier |
object |
gate_session |
Object discriminator |
partner_id |
string | Owning Gate partner |
mode |
test or live |
Inherited from the creating key |
amount |
decimal string | Server-bound amount |
currency |
string | ISO 4217 currency code |
status |
open, completed, expired, or cancelled |
Session lifecycle |
flow |
on_ramp, off_ramp, or null |
Optional locked widget flow |
target_token |
string or null | Optional asset constraint |
target_network |
string or null | Optional network constraint |
return_url |
URL | Allowed destination after completion |
cancel_url |
URL or null | Allowed destination after cancellation |
wallet_address |
string or null | Optional pre-filled destination |
user_reference |
string or null | Partner correlation value |
kyc_pre_verified |
boolean | Whether an authorized partner KYC package was accepted |
metadata |
object | Partner metadata |
expires_at |
date-time | Session expiry |
created_at |
date-time | Creation time |
client_secret is returned only by session creation. It is browser-safe only when paired with the partner's publishable key; it is not a substitute for sk_* and cannot authorize server API calls.
Retrieve the object with GET /gate_sessions/{id}. Use webhooks as the settlement signal rather than treating a browser callback as authoritative.