curl --request GET \
--url https://hpay-api.host-sl.com/api/v1/wallets/?is_active=true \
--header 'api-key: YOUR_API_KEY' \
--header 'secret-key: YOUR_SECRET_KEY'
from hostpay import HostPay
client = HostPay(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
wallets = client.wallets.list(is_active=True)
for wallet in wallets:
print(wallet["id"], wallet["balance"], wallet["currency"])
import { HostPay } from "@hostpay/sdk";
const client = new HostPay({ apiKey: "YOUR_API_KEY", secretKey: "YOUR_SECRET_KEY" });
const wallets = await client.wallets.list({ isActive: true });
for (const wallet of wallets) console.log(wallet.id, wallet.balance, wallet.currency);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hpay-api.host-sl.com/api/v1/wallets/?is_active=true",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"api-key: YOUR_API_KEY",
"secret-key: YOUR_SECRET_KEY"
]
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
[
{
"id": "wall_123",
"user_id": "user_123",
"balance": 150.50,
"currency": "SLE",
"is_active": true
},
{
"id": "wall_456",
"user_id": "user_456",
"balance": 0.0,
"currency": "SLE",
"is_active": true
}
]
{
"detail": "Invalid application credentials"
}
Wallets
List Wallets
Retrieve all wallets for your application
GET
/
api
/
v1
/
wallets
/
curl --request GET \
--url https://hpay-api.host-sl.com/api/v1/wallets/?is_active=true \
--header 'api-key: YOUR_API_KEY' \
--header 'secret-key: YOUR_SECRET_KEY'
from hostpay import HostPay
client = HostPay(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
wallets = client.wallets.list(is_active=True)
for wallet in wallets:
print(wallet["id"], wallet["balance"], wallet["currency"])
import { HostPay } from "@hostpay/sdk";
const client = new HostPay({ apiKey: "YOUR_API_KEY", secretKey: "YOUR_SECRET_KEY" });
const wallets = await client.wallets.list({ isActive: true });
for (const wallet of wallets) console.log(wallet.id, wallet.balance, wallet.currency);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hpay-api.host-sl.com/api/v1/wallets/?is_active=true",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"api-key: YOUR_API_KEY",
"secret-key: YOUR_SECRET_KEY"
]
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
[
{
"id": "wall_123",
"user_id": "user_123",
"balance": 150.50,
"currency": "SLE",
"is_active": true
},
{
"id": "wall_456",
"user_id": "user_456",
"balance": 0.0,
"currency": "SLE",
"is_active": true
}
]
{
"detail": "Invalid application credentials"
}
Endpoint
GET /api/v1/wallets/
Headers
string
required
Your application API key
string
required
Your application secret key
Query Parameters
boolean
Filter wallets by active status.
number
Opt into pagination: return at most 1–1000 wallets. Omit this parameter to keep
the existing full-list behavior.
number
default:"0"
Number of matching wallets to skip; must be zero or greater.
string
Case-insensitive literal substring search across wallet ID, user ID, balance
text and currency. Maximum 200 characters; surrounding whitespace is ignored.
Search the full matching list, not just the returned page.
string
default:"created_at"
Sort by
created_at or balance before slicing the page.string
default:"desc"
Sort
asc or desc. ID ascending breaks ties.boolean
default:"false"
Return X-Total-Count and X-Active-Count headers, plus X-Balance-By-Currency:
a JSON object containing decimal strings, such as
{"USD":"150.50","SLE":"25.00"}.
Summaries cover all matching wallets after status/search filters, before pagination.
Different currencies are never added together.Pagination compatibility
The body remains an array. Use?limit=50&offset=0&include_summary=true, then
increment offset by 50. An empty or out-of-range page returns []. Records can
change between requests; offset pages are not a snapshot or a bulk export.
Invalid limits, negative offsets, invalid sort values or searches longer than
200 characters return HTTP 422. Existing requests without the new options keep
returning the full list. Deploy the wallet API update before the dashboard update.
Response
An array of wallet objects.array
curl --request GET \
--url https://hpay-api.host-sl.com/api/v1/wallets/?is_active=true \
--header 'api-key: YOUR_API_KEY' \
--header 'secret-key: YOUR_SECRET_KEY'
from hostpay import HostPay
client = HostPay(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
wallets = client.wallets.list(is_active=True)
for wallet in wallets:
print(wallet["id"], wallet["balance"], wallet["currency"])
import { HostPay } from "@hostpay/sdk";
const client = new HostPay({ apiKey: "YOUR_API_KEY", secretKey: "YOUR_SECRET_KEY" });
const wallets = await client.wallets.list({ isActive: true });
for (const wallet of wallets) console.log(wallet.id, wallet.balance, wallet.currency);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hpay-api.host-sl.com/api/v1/wallets/?is_active=true",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"api-key: YOUR_API_KEY",
"secret-key: YOUR_SECRET_KEY"
]
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
[
{
"id": "wall_123",
"user_id": "user_123",
"balance": 150.50,
"currency": "SLE",
"is_active": true
},
{
"id": "wall_456",
"user_id": "user_456",
"balance": 0.0,
"currency": "SLE",
"is_active": true
}
]
{
"detail": "Invalid application credentials"
}