Create Wallet

POST

wallets

curl -X POST https://api.alguna.io/wallets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_abc123",
    "name": "Prepaid Credits",
    "currency": "USD",
    "productIds": ["prod_xyz789"]
  }'

const wallet = await alguna.wallets.create({
  accountId: 'acc_abc123',
  name: 'Prepaid Credits',
  currency: 'USD',
  productIds: ['prod_xyz789']
});

{
  "id": "wal_def456",
  "accountId": "acc_abc123",
  "name": "Prepaid Credits",
  "currency": "USD",
  "currentBalance": "0.00",
  "active": true,
  "productIds": ["prod_xyz789"],
  "createdAt": "2024-01-20T10:00:00Z",
  "updatedAt": "2024-01-20T10:00:00Z"
}

Create a new wallet for a customer account. Wallets store prepaid credits that can be applied to invoices.

string

required

The account ID to create the wallet for.

string

required

Display name for the wallet.

string

required

ISO 4217 currency code (e.g., “USD”, “EUR”).

array

Optional array of product IDs. If specified, wallet credits can only be applied to these products.

curl -X POST https://api.alguna.io/wallets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_abc123",
    "name": "Prepaid Credits",
    "currency": "USD",
    "productIds": ["prod_xyz789"]
  }'

const wallet = await alguna.wallets.create({
  accountId: 'acc_abc123',
  name: 'Prepaid Credits',
  currency: 'USD',
  productIds: ['prod_xyz789']
});

{
  "id": "wal_def456",
  "accountId": "acc_abc123",
  "name": "Prepaid Credits",
  "currency": "USD",
  "currentBalance": "0.00",
  "active": true,
  "productIds": ["prod_xyz789"],
  "createdAt": "2024-01-20T10:00:00Z",
  "updatedAt": "2024-01-20T10:00:00Z"
}

string

Unique identifier for the wallet.

string

The account this wallet belongs to.

string

Display name of the wallet.

string

Currency code for the wallet balance.

string

Current balance as a decimal string.

boolean

Whether the wallet is active and can be used.

array

Product IDs the wallet is restricted to, if any.

string

ISO 8601 timestamp of creation.

string

ISO 8601 timestamp of last update.

Get Wallet

⌘I

curl -X POST https://api.alguna.io/wallets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_abc123",
    "name": "Prepaid Credits",
    "currency": "USD",
    "productIds": ["prod_xyz789"]
  }'

const wallet = await alguna.wallets.create({
  accountId: 'acc_abc123',
  name: 'Prepaid Credits',
  currency: 'USD',
  productIds: ['prod_xyz789']
});

{
  "id": "wal_def456",
  "accountId": "acc_abc123",
  "name": "Prepaid Credits",
  "currency": "USD",
  "currentBalance": "0.00",
  "active": true,
  "productIds": ["prod_xyz789"],
  "createdAt": "2024-01-20T10:00:00Z",
  "updatedAt": "2024-01-20T10:00:00Z"
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets