↘️Assign Deposit Address

In this section, you’ll learn how to assign a static deposit address to a user for a given blockchain family.

---

URL Details

Parameter	Description	Example
BASE_URL	Your PayRam Site URL — find it under Settings → Site URL in your dashboard. Include the port if you installed on one.	https://pay.example.com
API Endpoint	Endpoint to assign a deposit address to a customer.	/api/v1/deposit-address/reference/{reference_id}

Headers

Header	Description	Example
API-Key	Your unique PayRam API key generated from your dashboard.	811b12035f0dfa8ffd62296df3c98b27
Content-Type	Format of the request data.	application/json

Note : You can generate a unique API key for each project directly from the PayRam dashboard. This helps you manage and track payouts separately for every project.

Request Body

Field	Description	Example
blockchain_code	Blockchain code to assign address for (BTC, ETH, TRX, BASE, POLYGON)	ETH

curl request

Before running the command, replace the placeholders with your actual details:

• ${BASE_URL} → Your PayRam server URL

• <your_api_key> → Your PayRam API key

• reference_id → Use the value returned from the Create Payment API

curl --location '${BASE_URL}/api/v1/deposit-address/reference/{reference_id}' \
--header 'API-Key: <your_api_key>' \
--header 'Content-Type: application/json' \
--data '{
  "blockchain_code": "ETH"
}'

curl response

• Address – The user’s assigned deposit address for this blockchain family. This address will be reused for all future payments in the same family.

• Family – The blockchain family (e.g., ETH_Family, BTC_Family, TRX_Family). Each family can include multiple chains — for example, Base, Polygon, and Ethereum share the same ETH_Family.

• Status – Indicates the current state of the assigned address (e.g., active, inactive).

{
  "id": 324,
  "createdAt": "2025-11-05T06:53:42.419556Z",
  "Address": "0xCb12499d865271D1FfFf16308E523e0BB624a779",
  "Family": "ETH_Family",
  "Status": "active",
  "MemberID": 271,
  "xpub_id": 18,
  "BlockchainFamilyID": 1,
  "Member": { ... },
  "BlockchainFamily": { ... },
  "wallet": { ... }
}

Note : Once a deposit address is assigned, it becomes permanent for that user within the same blockchain family. PayRam automatically reuses this address for subsequent transactions.