List a customer's wallets

List the credit wallets that belong to a customer, including each wallet’s current balance and topup link.

GET /api/v1/credit_systems/v2/wallets

Python SDK

Python

from metrifox_sdk import MetrifoxClient

client = MetrifoxClient(api_key="your_api_key")

# List all wallets for a customer
wallets = client.wallets.list("cust-mljp3ra6ffjm")
for wallet in wallets['data']:
    print(f"{wallet['name']}: {wallet['balance']} {wallet['credit_unit_plural']}")

200

{
  "statusCode": 200,
  "message": "Wallets fetched successfully",
  "meta": {},
  "data": [
    {
      "id": "b7bf0d46-9f7d-4d58-9bb4-6bfb2d3e6a5c",
      "name": "Image Credits",
      "credit_key": "image_credits",
      "credit_system_id": "c17f9a7b-1e49-4f80-9b6e-8d85b4a11f8a",
      "credit_unit_singular": "credit",
      "credit_unit_plural": "credits",
      "balance": 120,
      "low_balance_threshold": 20,
      "credit_attachment_id": "fb4e18f0-8b9c-4977-9fdd-7a4b76b2e8d3",
      "customer_key": "cust-mljp3ra6ffjm",
      "allocations": [],
      "topup_link": "https://app.metrifox.com/metrifox-inc/wallets/b7bf0d46-9f7d-4d58-9bb4-6bfb2d3e6a5c?customer=cust-mljp3ra6ffjm"
    }
  ],
  "errors": {}
}

Authorizations

x-api-key · string · header · required

Query Parameters

customer_key · string · required

The unique identifier of the customer on your platform, saved as customer_key on Metrifox

Response

200

application/json

Wallets fetched successfully

statusCode · integer

Example:

200

message · string

Example:

"Wallets fetched successfully"

meta · object

data · object[]

Show child attributes

errors · object