Sign in
Funding

Create a funding session.

Changed on

Creates a funding session for a destination.

A session is one cross-chain deposit attempt: pick a destination chain, token, and wallet, then set a payment method to mint a deposit address. The response includes a clientSecret used to advance and read the session.

post/v2/funding/sessions

Request

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

Headers

cf-ipcountrystring

Request body

amountUnitsstring

Lock the deposit to a fixed amount (destination base units). Omit to let the sender choose any amount above the route minimum.

metadataFundingMetadata

Arbitrary string metadata stored with a funding session.

externalIdstring

Idempotency/correlation key. Reusing the same value returns the existing session instead of creating a new one.

strictboolean

Deposit-address mode. true mints a single-use address bound to one deposit; false (default) mints an open address reusable for the route.

Example request

{
  "target": {
    "chain": "eip155:8453",
    "currency": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    "address": "0x0000000000000000000000000000000000000000"
  },
  "amountUnits": "10000000",
  "paymentMethod": {
    "type": "evm",
    "source": {
      "chain": "eip155:137",
      "amount": "10000000"
    }
  }
}

Response

Created.

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