{"templateId":"markdown","versions":[{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/accounts-and-assets/gas-station/manage-gas-station-api","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/accounts-and-assets/gas-station/manage-gas-station-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/accounts-and-assets/gas-station/manage-gas-station-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/accounts-and-assets/gas-station/manage-gas-station-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/accounts-and-assets/gas-station/manage-gas-station-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/accounts-and-assets/gas-station/manage-gas-station-api","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Manage a gas station with the API","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-a-gas-station-with-the-api","__idx":0},"children":["Manage a gas station with the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this page for gas station operations with the API. For console procedures, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/gas-station/manage-gas-station-ui"},"children":["Manage a gas station in the UI"]},". For the sponsorship model, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/gas-station/overview"},"children":["Gas Station"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All examples use the base URL ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["${CUSTODY_API_URL}/v1"]},", where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTODY_API_URL"]}," is your ","Ripple Custody"," API gateway URL."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Terminology"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Term"},"children":["Term"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account configured to sponsor transaction fees."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sponsor account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same as gas station; the account that provides native tokens for fees."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sponsored account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account that can receive fee funding from a sponsor account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/account/{accountId}/sponsor"]},", the sponsor account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/account/{entityId}/sponsorable-*"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/sponsored-*"]},", the sponsor account."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"gas-station-actions","__idx":1},"children":["Gas station actions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Action"},"children":["Action"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API procedure"},"children":["API procedure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a gas station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-gas-station"},"children":["Create a gas station"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check balances"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#check-gas-station-balances"},"children":["Check gas station balances"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fund the gas station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#fund-the-gas-station"},"children":["Fund the gas station"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Release quarantined funding"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#release-quarantined-transfers"},"children":["Release quarantined transfers"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create sponsorship"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-sponsorship"},"children":["Create sponsorship"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View, update, or delete sponsorship"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#view-sponsorship"},"children":["View sponsorship"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-sponsorship"},"children":["Update sponsorship"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#delete-sponsorship"},"children":["Delete sponsorship"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set low-balance alerts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#configure-alert-thresholds"},"children":["Configure alert thresholds"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View sponsorship audit events"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#view-audit-events"},"children":["View audit events"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage sponsored accounts and domains"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#manage-sponsored-accounts"},"children":["Manage sponsored accounts"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#manage-sponsored-domains"},"children":["Manage sponsored domains"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List sponsors and sponsored entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#list-sponsor-accounts-and-sponsored-entities"},"children":["List sponsor accounts and sponsored entities"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-gas-station","__idx":2},"children":["Create a gas station"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A gas station is a regular custody account that holds native tokens and has a sponsor configuration:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create the account with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateAccount"]}," intent, selecting the ledgers the gas station sponsors. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/accounts/manage-accounts-api"},"children":["Create an account with the API"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After the intent executes, create the account's sponsor configuration. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-sponsorship"},"children":["Create sponsorship"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-gas-station-balances","__idx":3},"children":["Check gas station balances"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Gas station balances are regular account balances. Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/reference/api/openapi/accounts/getaccountbalances"},"children":["Get account balances"]}," and read the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["availableAmount"]}," field per ledger."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"fund-the-gas-station","__idx":4},"children":["Fund the gas station"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fund the gas station with a standard transfer to its account on the target ledger. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/transactions/send-and-receive/send-assets-api"},"children":["Send assets with the API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"release-quarantined-transfers","__idx":5},"children":["Release quarantined transfers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If transaction screening quarantines incoming funding, the gas station can't spend it. Release the held transfers with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_ReleaseQuarantinedTransfers"]}," intent, or configure an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/compliance/transaction-screening/automatic-quarantine-release-policy"},"children":["automatic quarantine release policy"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/transactions/send-and-receive/receive-assets-api"},"children":["Receive assets with the API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":6},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before configuring sponsorship, confirm that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your environment has Gas Station deployed or available."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["System-signed intents are activated, the Gas Station service caller is registered in Keycloak, and a Gas Station system-signed policy is in place. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/gas-station/overview#system-signed-intents-and-policies"},"children":["System-signed intents and policies"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The sponsor account has the native tokens required by the target ledger."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have a valid API token. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/identity-and-access/authentication/authenticate-api-requests"},"children":["Authenticate API requests"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference","__idx":7},"children":["API reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the complete schema, parameters, and response details, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/reference/api/openapi/gas-station"},"children":["Gas station"]}," in the API reference."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-sponsorship","__idx":8},"children":["Create sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a sponsorship configuration for a sponsor account with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/domains/{domainId}/account/{accountId}/sponsor"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"account-level-sponsorship","__idx":9},"children":["Account-level sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"account\""]}," to sponsor specific accounts."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{accountId}/sponsor\" \\\n  -H \"Authorization: Bearer {token}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"type\": \"account\",\n    \"accountIds\": [\"account-uuid-1\", \"account-uuid-2\"],\n    \"includeSubDomains\": false,\n    \"alertLimit\": [\n      {\n        \"tickerId\": \"native-token-ticker-uuid\",\n        \"amount\": \"1.0\"\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"domain-level-sponsorship","__idx":10},"children":["Domain-level sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"domain\""]}," to sponsor accounts in the domain. Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeSubDomains"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if sponsorship should include child domains."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{accountId}/sponsor\" \\\n  -H \"Authorization: Bearer {token}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"type\": \"domain\",\n    \"includeSubDomains\": true,\n    \"alertLimit\": [\n      {\n        \"tickerId\": \"native-token-ticker-uuid\",\n        \"amount\": \"5.0\"\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-fields","__idx":11},"children":["Request fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sponsorship type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domain"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account UUIDs to sponsor when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeSubDomains"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether domain sponsorship includes subdomains."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alertLimit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Low-balance thresholds per ticker."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User to record on the audit trail. Eligible automated callers can set this value; otherwise the API uses the authenticated user from the JWT."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":12},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Successful create requests return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201 Created"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"sponsor-config-uuid\",\n  \"status\": \"created\",\n  \"createdAt\": \"2026-01-15T10:30:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-sponsorship","__idx":13},"children":["View sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/account/{accountId}/sponsor"]}," to retrieve the sponsor account's configuration."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{accountId}/sponsor\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If no sponsorship configuration exists for the sponsor account, this endpoint"," ","returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},". This result can mean the account does not have a configuration yet. Use"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsors"]}," to list sponsor-capable accounts in the"," ","domain."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsors/account/{accountId}/sponsor"]}," to check sponsorship status for an account."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/sponsors/account/{accountId}/sponsor\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsors/account/{accountId}/valid-sponsors"]}," to list the gas stations that could sponsor a specific account: every sponsor in the account's domain or one of its ancestor domains, excluding the account itself."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/sponsors/account/{accountId}/valid-sponsors\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An account is only sponsored once. If the account is already effectively sponsored, the response returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isSponsored: true"]}," with the existing sponsor and an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," list. Set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeAll"]}," query parameter to list the lineage's valid sponsor candidates anyway; the current sponsor can appear among them."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-sponsorship","__idx":14},"children":["Update sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/domains/{domainId}/account/{accountId}/sponsor"]}," to replace the sponsor account's sponsorship configuration."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{accountId}/sponsor\" \\\n  -H \"Authorization: Bearer {token}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"type\": \"account\",\n    \"accountIds\": [\"account-uuid-1\"],\n    \"includeSubDomains\": false,\n    \"alertLimit\": [\n      {\n        \"tickerId\": \"native-token-ticker-uuid\",\n        \"amount\": \"2.0\"\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To disable sponsorship without deleting the sponsor configuration, update the configuration with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"none\""]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Successful update requests return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]},". A configuration with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"none\""]}," ","disables sponsorship and does not make the account an active sponsor for Omnibus."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-sponsorship","__idx":15},"children":["Delete sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /v1/domains/{domainId}/account/{accountId}/sponsor"]}," to delete a sponsor configuration. Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," query parameter."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X DELETE \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{accountId}/sponsor?userId={userId}\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Successful delete requests return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you delete or disable sponsorship, affected accounts need enough native token balance to pay their own transaction fees."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configure-alert-thresholds","__idx":16},"children":["Configure alert thresholds"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alertLimit"]}," entries when creating or updating sponsorship to define native-token balance thresholds for the sponsor account."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"alertLimit\": [\n    {\n      \"tickerId\": \"native-token-ticker-uuid\",\n      \"amount\": \"1.0\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Monitor alert output through the telemetry and logging pipeline configured for your Gas Station deployment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-audit-events","__idx":17},"children":["View audit events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsor/events"]}," to retrieve sponsorship audit events."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/sponsor/events?limit=100\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Query parameter"},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter events for a specific account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include events from this date."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include events until this date."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CREATE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UPDATE"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum number of events to return."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startingAfter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pagination cursor."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-sponsored-accounts","__idx":18},"children":["Manage sponsored accounts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/account/{entityId}/sponsorable-accounts"]}," to view accounts eligible for a sponsor account's sponsorship."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{entityId}/sponsorable-accounts?page=0&limit=20\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Query parameter"},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sponsored"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not_sponsored"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sponsored_by_other"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search accounts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results per page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number, starting at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"items\": [\n    {\n      \"accountId\": \"account-uuid\",\n      \"name\": \"Trading Account\",\n      \"lineage\": {\n        \"domainId\": \"parent-domain-uuid\",\n        \"domain\": \"Parent Domain\",\n        \"subdomainId\": \"subdomain-uuid\",\n        \"subdomain\": \"Sub Domain\"\n      },\n      \"ledgers\": [\n        {\n          \"id\": \"ledger-uuid\",\n          \"alias\": \"Ethereum\"\n        }\n      ],\n      \"sponsorshipStatus\": \"not_sponsored\"\n    }\n  ],\n  \"total\": 1,\n  \"page\": 0,\n  \"pageSize\": 20,\n  \"availableLedgers\": [\n    {\n      \"id\": \"ledger-uuid\",\n      \"alias\": \"Ethereum\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/domains/{domainId}/account/{entityId}/sponsored-accounts"]}," to add accounts to a sponsor account's sponsorship."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{entityId}/sponsored-accounts\" \\\n  -H \"Authorization: Bearer {token}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"accounts\": [\n      {\n        \"accountId\": \"account-uuid-1\",\n        \"domainId\": \"domain-uuid-1\"\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each add-sponsored-accounts request accepts up to 100 accounts. Successful requests return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201 Created"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["count"]},", and, when applicable, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conflicts"]},"."," ","Use the optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," request field when you need to record a specific user"," ","on the audit trail."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To add or remove one sponsored account, use the single-account endpoints instead of the bulk operation:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v1/domains/{domainId}/account/{entityId}/sponsored-accounts/domains/{sponsoredAccountDomainId}/accounts/{sponsoredAccountId}"]}," adds a single sponsored account. The operation is idempotent: it returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201 Created"]}," when it adds the account and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," when the sponsor already sponsors the account. It returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]}," when another sponsor already sponsors the account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /v1/domains/{domainId}/account/{entityId}/sponsored-accounts/domains/{sponsoredAccountDomainId}/accounts/{sponsoredAccountId}"]}," removes a single sponsored account and returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]},"."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{entityId}/sponsored-accounts/domains/{sponsoredAccountDomainId}/accounts/{sponsoredAccountId}\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-sponsored-domains","__idx":19},"children":["Manage sponsored domains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/account/{entityId}/sponsorable-domains"]}," to view domains eligible for a sponsor account's sponsorship."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{entityId}/sponsorable-domains?page=0&limit=20\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Query parameter"},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sponsored"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not_sponsored"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sponsored_by_other"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search domains."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results per page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number, starting at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/domains/{domainId}/account/{entityId}/sponsored-domains"]}," to add domains to a sponsor account's sponsorship."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"${CUSTODY_API_URL}/v1/domains/{domainId}/account/{entityId}/sponsored-domains\" \\\n  -H \"Authorization: Bearer {token}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"domains\": [\n      {\n        \"domainId\": \"domain-uuid-1\"\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each add-sponsored-domains request accepts up to 100 domains. Successful requests return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201 Created"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["count"]},", and, when applicable, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conflicts"]},"."," ","Use the optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," request field when you need to record a specific user"," ","on the audit trail."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-sponsor-accounts-and-sponsored-entities","__idx":20},"children":["List sponsor accounts and sponsored entities"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsors"]}," to list sponsor accounts in a domain."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/sponsors\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," array of sponsor account IDs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsors/sponsored-accounts"]}," to list accounts with sponsorship status."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/sponsors/sponsored-accounts?limit=50&sortBy=alias&sortOrder=asc\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/domains/{domainId}/sponsors/sponsored-domains"]}," to list subdomains with sponsorship status."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"${CUSTODY_API_URL}/v1/domains/{domainId}/sponsors/sponsored-domains?limit=50&sortBy=alias&sortOrder=asc\" \\\n  -H \"Authorization: Bearer {token}\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These list endpoints support ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startingAfter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sortBy"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sortOrder"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sponsorAccountId"]}," query parameters."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":21},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Possible cause"},"children":["Possible cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction waits for funding"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No sponsorship applies to the account or its domain."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction waits for funding"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sponsor account has insufficient native token balance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funding intent waits for approval"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The policy matching Gas Station's system-signed funding intents requires approvals."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funding intents are rejected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System-signed intents are not activated, or no policy with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["intentOrigin: \"SystemSigned\""]}," allows the Gas Station service caller."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funding activity is not visible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check Gas Station service health, logs, and telemetry."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":22},"children":["Related topics"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Topic"},"children":["Topic"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Documentation"},"children":["Documentation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas Station concepts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/gas-station/overview"},"children":["Gas Station"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UI procedures"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/accounts-and-assets/gas-station/manage-gas-station-ui"},"children":["Manage a gas station in the UI"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deployment reference"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/gas-station"},"children":["Gas Station reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System-signed intents"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/system-signed-intents"},"children":["System-signed intent configuration"]}]}]}]}]}]}]},"headings":[{"value":"Manage a gas station with the API","id":"manage-a-gas-station-with-the-api","depth":1},{"value":"Gas station actions","id":"gas-station-actions","depth":2},{"value":"Create a gas station","id":"create-a-gas-station","depth":2},{"value":"Check gas station balances","id":"check-gas-station-balances","depth":2},{"value":"Fund the gas station","id":"fund-the-gas-station","depth":2},{"value":"Release quarantined transfers","id":"release-quarantined-transfers","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"API reference","id":"api-reference","depth":2},{"value":"Create sponsorship","id":"create-sponsorship","depth":2},{"value":"Account-level sponsorship","id":"account-level-sponsorship","depth":3},{"value":"Domain-level sponsorship","id":"domain-level-sponsorship","depth":3},{"value":"Request fields","id":"request-fields","depth":3},{"value":"Response","id":"response","depth":3},{"value":"View sponsorship","id":"view-sponsorship","depth":2},{"value":"Update sponsorship","id":"update-sponsorship","depth":2},{"value":"Delete sponsorship","id":"delete-sponsorship","depth":2},{"value":"Configure alert thresholds","id":"configure-alert-thresholds","depth":2},{"value":"View audit events","id":"view-audit-events","depth":2},{"value":"Manage sponsored accounts","id":"manage-sponsored-accounts","depth":2},{"value":"Manage sponsored domains","id":"manage-sponsored-domains","depth":2},{"value":"List sponsor accounts and sponsored entities","id":"list-sponsor-accounts-and-sponsored-entities","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"seo":{"title":"Manage a gas station with the API"}},"lastModified":"2026-08-04T20:25:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/accounts-and-assets/gas-station/manage-gas-station-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}