Wallets

Get all wallets

get/wallets

Request

Query parameters

pageinteger

Page number

per_pageinteger

Number of records per page

external_customer_idstring required
Example:ext_cus_1234567890abcdef

Filter by external customer ID

Response

A list of wallets

Example response

{
  "wallets": [
    {
      "external_customer_id": "client-12345",
      "status": "ACTIVE",
      "available_balance": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "ongoing_usage": {
        "value": 100,
        "currency_code": "USD"
      },
      "net_balance": {
        "value": 50,
        "currency_code": "USD"
      },
      "name": "Prepaid Wallet",
      "rate_amount": "1.5",
      "available_credits": "28.0",
      "ongoing_usage_credits": "10.0",
      "net_balance_credits": "18.0",
      "consumed_credits": "2.0",
      "created_at": "2023-10-01T12:00:00Z",
      "expiration_at": "2023-10-01T12:00:00Z",
      "terminated_at": "2023-10-01T12:00:00Z",
      "applies_to": {
        "fee_types": [
          "SUBSCRIPTION"
        ]
      },
      "recurring_transaction_rules": [
        {
          "trigger": "THRESHOLD",
          "paid_credits": "20.0",
          "granted_credits": "10.0",
          "method": "FIXED",
          "interval": "MONTHLY",
          "started_at": "2023-10-01T12:00:00Z",
          "expiration_at": "2023-10-01T12:00:00Z",
          "threshold_credits": "5.0",
          "target_ongoing_balance": "200.0"
        }
      ],
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.