Sign in
Funding

Get a funding session.

Changed on

Retrieves a funding session, refreshing its status from the rail.

Requires the session clientSecret (query parameter).

get/v2/funding/sessions/{sessionId}

Request

  • Base URL: https://api.openfort.io
  • URL: https://api.openfort.io/v2/funding/sessions/{sessionId}
  • Auth: HTTP bearer

Path parameters

sessionIdstring required

The funding session ID (starts with fnd_).

Query parameters

clientSecretstring

The session client secret returned at creation.

Response

Successful response.

idstring required
object'fundingSession' required
createdAtinteger required
statusstring required

Session lifecycle state.

clientSecretstring required

Per-session secret clients present to read or advance the session.

amountUnitsstring nullable required

Locked amount (destination base units), or null when the sender chooses.

metadataFundingMetadata required

Arbitrary string metadata stored with a funding session.

externalIdstring nullable required
strictboolean required
expiresAtinteger required

Unix seconds when the session expires (24h after creation).

Example response

{
  "status": "waiting_payment"
}

Changes