Funding

Set a session's payment method.

Changed on

Sets the (single) payment method on a session.

Commits the source route the user will send from and mints the Relay deposit address. Requires the session clientSecret.

post/v2/funding/sessions/{sessionId}/payment_methods

Request

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

Path parameters

sessionIdstring required

The funding session ID (starts with fnd_).

Headers

cf-ipcountrystring
originstring
cf-connecting-ipstring
x-forwarded-forstring

Request body

clientSecretstring required

The session's client secret, returned at creation.

Example request

{
  "paymentMethod": {
    "type": "evm",
    "source": {
      "chain": "eip155:137",
      "amount": "10000000"
    }
  }
}

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