Sign in
Fee Sponsorship

Get a fee sponsorship.

Changed on

Retrieves the details of a fee sponsorship.

get/v2/fee-sponsorship/{feeSponsorshipId}

Request

  • Base URL: https://api.openfort.io
  • URL: https://api.openfort.io/v2/fee-sponsorship/{feeSponsorshipId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

feeSponsorshipIdstring required

Specifies the unique fee sponsorship ID (starts with pol_).

Response

Successful response.

idstring required
object'feeSponsorship' required
createdAtinteger required
namestring nullable required

Name of the fee sponsorship policy.

descriptionstring nullable required

Description or comment for the fee sponsorship.

chainIdinteger nullable required

Chain ID for single-chain sponsorship.

enabledboolean required

Whether the policy is enabled.

paymasterIdstring nullable required

Paymaster ID (optional).

forwarderContractIdstring nullable required

Forwarder contract ID (optional, for meta-transactions).

policyIdstring nullable required

Linked policy ID for criteria-based transaction filtering.

Example response

{
  "name": "My DeFi Gas Sponsorship",
  "description": "Sponsors gas for free-tier users",
  "chainId": 8453,
  "enabled": true,
  "strategy": {
    "sponsorSchema": "pay_for_user",
    "tokenContract": "con_48eeba57-2cd5-4159-a2cb-057a23a35e65",
    "tokenContractAmount": "1000000000000000000",
    "dynamicExchangeRate": true,
    "splTokens": [
      "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
    ],
    "tokenContracts": [
      {
        "contract": "con_48eeba57-2cd5-4159-a2cb-057a23a35e65",
        "amount": "1000000000000000000"
      }
    ]
  },
  "paymasterId": "pay_48eeba57-2cd5-4159-a2cb-057a23a35e65",
  "forwarderContractId": "cfo_48eeba57-2cd5-4159-a2cb-057a23a35e65",
  "policyId": "ply_48eeba57-2cd5-4159-a2cb-057a23a35e65"
}

Changes

  • 5019a5edea73Revision changes
    • info

      added the optional property / to the response with the status

    • info

      response property strategy/tokenContract deprecated

    • info

      response property strategy/tokenContractAmount deprecated

  • 88be7ccfca19Revision changes
    • info

      the security scope fee_sponsorship:read was added to the endpoint's security scheme sk

    • info

      added the optional property / to the response with the status

    • info

      added the required property to the response with the status