Sign in
Fee Sponsorship

List fee sponsorship policies.

Changed on

Returns a list of fee sponsorship policies.

Fee sponsorship policies define gas sponsorship rules by linking to a policy with rich criteria (evmAddress, ethValue, evmNetwork, evmData).

get/v2/fee-sponsorship

Request

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

Query parameters

limitinteger

Specifies the maximum number of records to return.

skipinteger

Specifies the offset for the first records to return.

order'asc' | 'desc'

Specifies the order in which to sort the results.

namestring

Filter by policy name (partial match).

chainIdinteger

Filter by chain ID.

enabledboolean

Filter by enabled status.

deletedboolean

Include deleted policies.

Response

Successful response.

object'list' required
urlstring required
startinteger required
endinteger required
totalinteger required

Example response

{
  "data": [
    {
      "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 data/items/strategy/tokenContract deprecated

    • info

      response property data/items/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