Skip to main content
GET
/
wallets
Get all wallets
curl --request GET \
  --url https://api-m.paypal.com/v1/commerce/billing/wallets \
  --header 'Authorization: Bearer <token>'
{
  "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": "2025-01-01T00:00:00Z",
      "expiration_at": "2025-01-01T00:00:00Z",
      "terminated_at": "2025-01-01T00: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": "2025-01-01T00:00:00Z",
          "expiration_at": "2025-01-01T00:00:00Z",
          "threshold_credits": "5.0",
          "target_ongoing_balance": "200.0"
        }
      ],
      "id": "sub_01H3YT8P7Q5R3S1T2U0V4W9X8"
    }
  ],
  "metadata": {
    "total_count": 123,
    "total_pages": 123,
    "current_page": 123
  }
}

Authorizations

Authorization
string
header
required

Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.

Query Parameters

page
integer

Page number

per_page
integer

Number of records per page

external_customer_id
string
required

Filter by external customer ID

Example:

"ext_cus_1234567890abcdef"

Response

A list of wallets

wallets
object[]
metadata
object
I