Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-alpha.pepay.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Addresses are saved shipping destinations tied to a merchant customer (by customer_id or wallet identity).

​
Authentication

Requires x-commerce-api-key.

​
Request

​
List addresses (by customer_id)

const addresses = await pepay.commerce.addresses.list({ customer_id: 'cust_123' });

​
List addresses (by wallet)

const addresses = await pepay.commerce.addresses.list({
  wallet_address: '0x1111111111111111111111111111111111111111',
  wallet_network: 'ethereum'
});

​
Delete an address

await pepay.commerce.addresses.remove('addr_123');

​
Response

Example list response (truncated): 
{
  "success": true,
  "data": {
    "addresses": [
      {
        "addressId": "550e8400-e29b-41d4-a716-446655440000",
        "customerId": "cust_123",
        "walletAddress": "0x1111111111111111111111111111111111111111",
        "walletNetwork": "ethereum",
        "firstName": "Ada",
        "lastName": "Lovelace",
        "addressLine1": "123 Market St",
        "addressLine2": "",
        "city": "San Francisco",
        "state": "CA",
        "zipCode": "94105",
        "country": "US",
        "isValidated": true,
        "createdAt": 1766320496
      }
    ]
  }
}

​
Errors

  • 400 missing/invalid customer identification
  • 401 missing/invalid commerce API key
  • 404 address not found (delete)

​
Examples

  • Use customer_id for CRM-driven integrations and wallet_address + wallet_network for wallet-first flows.
Next: Commerce WebSockets