Skip to main content
GET
/
tenant
/
{tenantId}
/
admin
/
gas_station
/
{walletTenantId}
/
get_gas_station_wallets
GetGasStationWallets
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/admin/gas_station/{walletTenantId}/get_gas_station_wallets
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

This endpoint retrieves all gas station wallets that provide automatic funding for a specific tenant wallet, including their balances and names.

​
Input

  • tenantId (path, required): Identifier of the tenant that owns the wallet
  • walletTenantId (path, required): Identifier of the tenant wallet to query
  • ct (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<GasStationWalletsClientModel> containing a collection of gas station wallets with their identifiers, balances, and display names.

​
Examples

Request: 
GET /api/tenant/1024/gas-station/wallet/2048/gas-stations
Response (200 OK): 
{
  "data": {
    "gasStationWallets": [
      {
        "walletTenantId": 3001,
        "balance": 25.75,
        "name": "Primary Gas Station"
      },
      {
        "walletTenantId": 3002,
        "balance": 18.50,
        "name": "Backup Gas Station"
      }
    ]
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid wallet or tenant identifier format
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to view gas station wallets
  • 404 Not Found: Tenant or wallet does not exist
  • 500 Internal Server Error: Unexpected server error occurred during retrieval

​
Notes

  • Returns wallets configured as gas stations that support the queried wallet
  • Balance information is current at time of request
  • Empty collection returned if no gas station wallets are configured

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

​
walletTenantId
integer<int64>
required

Identifier of the tenant wallet.

Query Parameters

​
api-version
string | null

Response

Gas station wallets retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "gasStationWallets": [
    {
      "walletTenantId": 1001,
      "balance": 12.34,
      "name": "Operations Wallet"
    }
  ]
}