Skip to main content

​
Overview

Wallets represent settlement destinations for a merchant. The SDK supports retrieval only; wallet creation, activation, and removal are managed in the dashboard.

​
Authentication

Listing wallets supports either a merchant API key or a dashboard bearer token. 
const pepay = new Pepay({ apiKey: process.env.PEPAY_API_KEY }); // list only

​
Request

​
List wallets

const wallets = await pepay.wallets.list();

​
Use wallets

Activate a non-custodial wallet in the dashboard to make it the settlement destination for new payments. Use wallets.list() to confirm which wallet is active for each network.

​
Response

Example list response (truncated): 
[
  {
    "network": "base",
    "wallets": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "address": "0x1111111111111111111111111111111111111111",
        "type": "custodial",
        "is_active": true,
        "created_at": 1704067200
      }
    ]
  }
]

​
Errors

  • 401 missing/invalid credentials

​
Examples

  • Use wallets.list() to display the active settlement wallet in your admin UI.
  • For adding or activating wallets, use the dashboard and see Manage wallets.
Next: Settlement