Skip to main content
GET
/
api
/
v1
/
commerce
/
merchant
/
addresses
List merchant addresses
curl --request GET \
  --url https://api-beta.pepay.io/api/v1/commerce/merchant/addresses \
  --header 'x-commerce-api-key: <api-key>'
{
  "success": true,
  "data": {
    "addresses": [
      {
        "addressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customerId": "<string>",
        "walletAddress": "<string>",
        "walletNetwork": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "isValidated": true,
        "validatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

x-commerce-api-key
string
header
required

Legacy alias for commerce-scoped API keys. Prefer x-api-key with scope=commerce.

Query Parameters

customer_id
string

Merchant-specific customer identifier (alternative to wallet)

Maximum string length: 255
wallet_address
string

Customer wallet address (required with wallet_network)

wallet_network
enum<string>

Wallet network (required with wallet_address)

Available options:
ethereum,
base,
solana,
avalanche,
ton,
bsc,
arbitrum,
optimism,
cardano,
sui
limit
integer

Maximum addresses to return

Required range: 1 <= x <= 100
offset
integer

Offset for pagination

Required range: x >= 0

Response

Addresses retrieved successfully

success
boolean
Example:

true

data
object